diff --git a/docgen/export.php b/docgen/export.php deleted file mode 100644 index a2ab03bab..000000000 --- a/docgen/export.php +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Phaser Documentation Generator - - - - - 
-start();
-
-    echo "Extending ...\n";
-
-    $gen->extend();
-
-    echo "Exporting ...\n";
-
-    $gen->export('output/');
-
-    // $obj = $gen->get('Phaser.Animation');
-    // print_r($obj->getArray());
-    // echo $obj;
-
-    // ksort($gen->uniqueTypes);
-    // echo "There are " . count($gen->uniqueTypes) . " unique data types \n\n";
-    // print_r($gen->uniqueTypes);
-
-    // $gen->extend('Phaser.Sprite');
-    // $sprite = $gen->get('Phaser.Sprite');
-    // $sprite->export('output/');
-
-    // echo $sprite;
-
-
-
-
-?>
-
- - - \ No newline at end of file diff --git a/docgen/index.php b/docgen/index.php deleted file mode 100644 index e309f04d6..000000000 --- a/docgen/index.php +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Phaser Documentation Viewer - - - - - Export - - $value) - { - $path = realpath($dir . DIRECTORY_SEPARATOR . $value); - - if (is_dir($path)) - { - $result[$value] = dirToArray($path); - } - else - { - if (substr($value, -3) == '.js') - { - if (!in_array($value, $fileIgnore)) - { - $index = str_replace($src, "", $path); - $index = substr($index, 1); - - $result[substr($value, 0, -3)] = $index; - } - } - } - } - - return $result; - } - - function displaySection($title, $files) { - - if ($title === "") - { - echo "

Phaser v2.1.1

"; - } - else - { - echo "

$title

"; - } - - echo ""; - - } - - $src = realpath('../src'); - - $files = dirToArray($src); - - displaySection("", $files); - - // echo "
";
-    // var_dump($src);
-    // print_r($files);
-    // echo "
"; - -?> - - - \ No newline at end of file diff --git a/docgen/json.php b/docgen/json.php deleted file mode 100644 index 8cca6c121..000000000 --- a/docgen/json.php +++ /dev/null @@ -1,26 +0,0 @@ -start(); - - $obj = $gen->get($src); - $obj->extend(); - - echo $obj->getJSON(); -?> \ No newline at end of file diff --git a/docgen/output/PIXI.AbstractFilter.json b/docgen/output/PIXI.AbstractFilter.json deleted file mode 100644 index 6342e0e58..000000000 --- a/docgen/output/PIXI.AbstractFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AbstractFilter","extends":"","static":false,"constructor":true,"parameters":[{"name":"fragmentSrc","type":["array"],"help":"The fragment source in an array of strings.","optional":false,"default":null},{"name":"uniforms","type":["object"],"help":"An object containing the uniforms for this filter.","optional":false,"default":null}],"help":"This is the base class for creating a PIXI filter. Currently only webGL supports filters.\\nIf you want to make a custom filter this should be your base class."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"fragmentSrc","type":["array"],"help":"","inlineHelp":"","line":55,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"passes","type":["array"],"help":"An array of passes - some filters contain a few steps this array simply stores the steps in a liniear fashion.\\nFor example the blur filter has two passes blurX and blurY.","inlineHelp":"","line":22,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"shaders","type":["array"],"help":"","inlineHelp":"","line":29,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"uniforms","type":["object"],"help":"","inlineHelp":"","line":48,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.AjaxRequest.json b/docgen/output/PIXI.AjaxRequest.json deleted file mode 100644 index 9e8419c68..000000000 --- a/docgen/output/PIXI.AjaxRequest.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AjaxRequest","extends":"","static":false,"constructor":true,"parameters":[],"help":"A wrapper for ajax requests to be handled cross browser"},"consts":[],"methods":{"public":[{"name":"bind","static":false,"returns":null,"help":"A polyfill for Function.prototype.bind","line":79,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"canUseNewCanvasBlendModes","static":false,"returns":{"types":["boolean"],"help":"whether they are supported"},"help":"Checks whether the Canvas BlendModes are supported by the current browser","line":174,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"cancelAnimationFrame","static":false,"returns":null,"help":"A polyfill for cancelAnimationFrame","line":25,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getNextPowerOfTwo","static":false,"returns":{"types":["number"],"help":"the closest number that is a power of two"},"help":"Given a number, this function returns the closest number that is a power of two\\nthis function is taken from Starling Framework as its pretty neat ;)","line":197,"public":true,"protected":false,"private":false,"parameters":[{"name":"number","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hex2rgb","static":false,"returns":null,"help":"Converts a hex color number to an [R, G, B] array","line":60,"public":true,"protected":false,"private":false,"parameters":[{"name":"hex","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"requestAnimationFrame","static":false,"returns":null,"help":"A polyfill for requestAnimationFrame\\nYou can actually use both requestAnimationFrame and requestAnimFrame,\\nyou will still benefit from the polyfill","line":19,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"rgb2hex","static":false,"returns":null,"help":"Converts a color as an [R, G, B] array to a hex number","line":70,"public":true,"protected":false,"private":false,"parameters":[{"name":"rgb","type":["array"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.AlphaMaskFilter.json b/docgen/output/PIXI.AlphaMaskFilter.json deleted file mode 100644 index 72cf9d3a3..000000000 --- a/docgen/output/PIXI.AlphaMaskFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AlphaMaskFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture used for the displacement map * must be power of 2 texture at the moment","optional":false,"default":null}],"help":"The AlphaMaskFilter class uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object.\\nYou can use this filter to apply all manor of crazy warping effects\\nCurrently the r property of the texture is used to offset the x and the g property of the texture is used to offset the y."},"consts":[],"methods":{"public":[{"name":"onTextureLoaded","static":false,"returns":null,"help":"Sets the map dimensions uniforms when the texture becomes available.","line":76,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"map","type":["PIXI.Texture"],"help":"The texture used for the displacement map. Must be power of 2 sized texture.","inlineHelp":"","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.AsciiFilter.json b/docgen/output/PIXI.AsciiFilter.json deleted file mode 100644 index 2437fcf97..000000000 --- a/docgen/output/PIXI.AsciiFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AsciiFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"An ASCII filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"size","type":["number"],"help":"The pixel size used by the filter.","inlineHelp":"","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.AssetLoader.json b/docgen/output/PIXI.AssetLoader.json deleted file mode 100644 index d8444c03b..000000000 --- a/docgen/output/PIXI.AssetLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AssetLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"assetURLs","type":["array string"],"help":"An array of image\/sprite sheet urls that you would like loaded","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"A Class that loads a bunch of images \/ sprite sheet \/ bitmap font files. Once the\\nassets have been loaded they are added to the PIXI Texture cache and can be accessed\\neasily through PIXI.Texture.fromImage() and PIXI.Sprite.fromImage()\\nWhen all items have been loaded this class will dispatch a 'onLoaded' event\\nAs each individual item is loaded this class will dispatch a 'onProgress' event\\n\\nsupported. Supported image formats include 'jpeg', 'jpg', 'png', 'gif'. Supported\\nsprite sheet data formats only include 'JSON' at this time. Supported bitmap font\\ndata formats include 'xml' and 'fnt'."},"consts":[],"methods":{"public":[{"name":"_getDataType","static":false,"returns":null,"help":"Given a filename, returns its extension.","line":80,"public":true,"protected":false,"private":false,"parameters":[{"name":"str","type":["string"],"help":"the name of the asset","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"load","static":false,"returns":null,"help":"Starts loading the assets sequentially","line":112,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onAssetLoaded","static":false,"returns":null,"help":"Invoked after each file is loaded","line":149,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"assetURLs","type":["array string"],"help":"The array of asset URLs that are going to be loaded","inlineHelp":"","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loadersByType","type":["object"],"help":"Maps file extension to loader types","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.AtlasLoader.json b/docgen/output/PIXI.AtlasLoader.json deleted file mode 100644 index 89a7b0dca..000000000 --- a/docgen/output/PIXI.AtlasLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.AtlasLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The atlas file loader is used to load in Texture Atlas data and parse it. When loaded this class will dispatch a 'loaded' event. If loading fails this class will dispatch an 'error' event.\\n\\nTo generate the data you can use http:\/\/www.codeandweb.com\/texturepacker and publish in the 'JSON' format.\\n\\nIt is highly recommended to use texture atlases (also know as 'sprite sheets') as it allowed sprites to be batched and drawn together for highly increased rendering speed.\\nOnce the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId()"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Starts loading the JSON file","line":37,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onAtlasLoaded","static":false,"returns":null,"help":"Invoked when the Atlas has fully loaded. Parses the JSON and builds the texture frames.","line":52,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onError","static":false,"returns":null,"help":"Invoked when an error occurs.","line":188,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when json file has loaded.","line":172,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BaseTexture.json b/docgen/output/PIXI.BaseTexture.json deleted file mode 100644 index 6303380e9..000000000 --- a/docgen/output/PIXI.BaseTexture.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BaseTexture","extends":"","static":false,"constructor":true,"parameters":[{"name":"source","type":["string"],"help":"the source object (image or canvas)","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"help":"A texture stores the information that represents an image. All textures have a base texture."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this base texture","line":156,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"dirty","static":false,"returns":null,"help":"Sets all glTextures to be dirty.","line":204,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given canvas element.","line":263,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given image url.\\nIf the image is not in the base texture cache it will be created and loaded.","line":223,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateSourceImage","static":false,"returns":null,"help":"Changes the source image of the texture","line":192,"public":true,"protected":false,"private":false,"parameters":[{"name":"newSrc","type":["string"],"help":"the path of the image","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"hasLoaded","type":["boolean"],"help":"[read-only] Set to true once the base texture has loaded","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"height","type":["number"],"help":"[read-only] The height of the base texture set when the image has loaded","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"imageUrl","type":["string"],"help":"","inlineHelp":"","line":136,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"premultipliedAlpha","type":["boolean"],"help":"Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)","inlineHelp":"","line":81,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleMode","type":["PIXI.scaleModes"],"help":"The scale mode to apply when scaling this texture","inlineHelp":"","line":53,"default":"PIXI.scaleModes.LINEAR","public":true,"protected":false,"private":false,"readOnly":false},{"name":"source","type":["Image"],"help":"The image source that is used to create the texture.","inlineHelp":"","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"[read-only] The width of the base texture set when the image has loaded","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_dirty","type":["array"],"help":"","inlineHelp":"","line":100,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_glTextures","type":["array"],"help":"","inlineHelp":"","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_powerOf2","type":["boolean"],"help":"","inlineHelp":"","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BitmapFontLoader.json b/docgen/output/PIXI.BitmapFontLoader.json deleted file mode 100644 index 5b7a35c6c..000000000 --- a/docgen/output/PIXI.BitmapFontLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BitmapFontLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the sprite sheet JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The xml loader is used to load in XML bitmap font data ('xml' or 'fnt')\\nTo generate the data you can use http:\/\/www.angelcode.com\/products\/bmfont\/\\nThis loader will also load the image file as the data.\\nWhen loaded this class will dispatch a 'loaded' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Loads the XML font data","line":62,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when all files are loaded (xml\/fnt and texture)","line":158,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onXMLLoaded","static":false,"returns":null,"help":"Invoked when the XML file is loaded, parses the data.","line":78,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseUrl","type":["string"],"help":"[read-only] The base url of the bitmap font data","inlineHelp":"","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"[read-only] The texture of the bitmap font","inlineHelp":"","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"url","type":["string"],"help":"The url of the bitmap font data","inlineHelp":"","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BitmapText.json b/docgen/output/PIXI.BitmapText.json deleted file mode 100644 index 98ffa8a1d..000000000 --- a/docgen/output/PIXI.BitmapText.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BitmapText","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"text","type":["string"],"help":"The copy that you would like the text to display","optional":false,"default":null},{"name":"style","type":["object"],"help":"The style parameters","optional":false,"default":null},{"name":"style.font","type":["string"],"help":"The size (optional) and bitmap font id (required) eq 'Arial' or '20px Arial' (must have loaded previously)","optional":false,"default":null},{"name":"[style.align='left']","type":["string"],"help":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text","optional":false,"default":null}],"help":"A BitmapText object will create a line or multiple lines of text using bitmap font. To split a line you can use '\\n', '\\r' or '\\r\\n' in your string.\\nYou can generate the fnt files using\\nhttp:\/\/www.angelcode.com\/products\/bmfont\/ for windows or\\nhttp:\/\/www.bmglyph.com\/ for mac."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStyle","static":false,"returns":null,"help":"Set the style of the text\\nstyle.font {String} The size (optional) and bitmap font id (required) eq 'Arial' or '20px Arial' (must have loaded previously)\\n[style.align='left'] {String} Alignment for multiline text ('left', 'center' or 'right'), does not affect single lines of text","line":86,"public":true,"protected":false,"private":false,"parameters":[{"name":"style","type":["object"],"help":"The style parameters, contained as properties of an object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.BitmapText"},{"name":"setText","static":false,"returns":null,"help":"Set the text string to be rendered.","line":72,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The text that you would like displayed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.BitmapText"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"updateText","static":false,"returns":null,"help":"Renders text and updates it when needed","line":106,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateTransform","static":false,"returns":null,"help":"Updates the transform of this object","line":204,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"The dirty state of this object.","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"textHeight","type":["number"],"help":"[read-only] The height of the overall text, different from fontSize,\\nwhich is defined in the style object","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"textWidth","type":["number"],"help":"[read-only] The width of the overall text, different from fontSize,\\nwhich is defined in the style object","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_pool","type":["array"],"help":"","inlineHelp":"","line":48,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BlurFilter.json b/docgen/output/PIXI.BlurFilter.json deleted file mode 100644 index 71510ada2..000000000 --- a/docgen/output/PIXI.BlurFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BlurFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"The BlurFilter applies a Gaussian blur to an object.\\nThe strength of the blur can be set for x- and y-axis separately (always relative to the stage)."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"Sets the strength of both the blurX and blurY properties simultaneously","inlineHelp":"","line":31,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blurX","type":["number"],"help":"Sets the strength of the blurX property","inlineHelp":"","line":47,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blurY","type":["number"],"help":"Sets the strength of the blurY property","inlineHelp":"","line":63,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BlurXFilter.json b/docgen/output/PIXI.BlurXFilter.json deleted file mode 100644 index b42ec6496..000000000 --- a/docgen/output/PIXI.BlurXFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BlurXFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"The BlurXFilter applies a horizontal Gaussian blur to an object."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"Sets the strength of both the blur.","inlineHelp":"","line":58,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.BlurYFilter.json b/docgen/output/PIXI.BlurYFilter.json deleted file mode 100644 index 0d96bb612..000000000 --- a/docgen/output/PIXI.BlurYFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.BlurYFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"The BlurYFilter applies a vertical Gaussian blur to an object."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"Sets the strength of both the blur.","inlineHelp":"","line":58,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CanvasBuffer.json b/docgen/output/PIXI.CanvasBuffer.json deleted file mode 100644 index d77393a7f..000000000 --- a/docgen/output/PIXI.CanvasBuffer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CanvasBuffer","extends":"","static":false,"constructor":true,"parameters":[{"name":"width","type":["number"],"help":"the width for the newly created canvas","optional":false,"default":null},{"name":"height","type":["number"],"help":"the height for the newly created canvas","optional":false,"default":null}],"help":"Creates a Canvas element of the given size."},"consts":[],"methods":{"public":[{"name":"resize","static":false,"returns":null,"help":"Resizes the canvas to the specified width and height.","line":71,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the canvas","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"clear","static":false,"returns":null,"help":"Clears the canvas that was created by the CanvasBuffer class.","line":59,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The Canvas object that belongs to this CanvasBuffer.","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"A CanvasRenderingContext2D object representing a two-dimensional rendering context.","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the Canvas in pixels.","inlineHelp":"","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the Canvas in pixels.","inlineHelp":"","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CanvasGraphics.json b/docgen/output/PIXI.CanvasGraphics.json deleted file mode 100644 index 8fa189542..000000000 --- a/docgen/output/PIXI.CanvasGraphics.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CanvasGraphics","extends":"","static":true,"constructor":false,"parameters":[],"help":"A set of functions used by the canvas renderer to draw the primitive graphics data."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CanvasMaskManager.json b/docgen/output/PIXI.CanvasMaskManager.json deleted file mode 100644 index 0d0c9fee4..000000000 --- a/docgen/output/PIXI.CanvasMaskManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CanvasMaskManager","extends":"","static":false,"constructor":true,"parameters":[],"help":"A set of functions used to handle masking."},"consts":[],"methods":{"public":[{"name":"popMask","static":false,"returns":null,"help":"Restores the current drawing context to the state it was before the mask was applied.","line":55,"public":true,"protected":false,"private":false,"parameters":[{"name":"renderSession","type":["object"],"help":"The renderSession whose context will be used for this mask manager.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pushMask","static":false,"returns":null,"help":"This method adds it to the current stack of masks.","line":24,"public":true,"protected":false,"private":false,"parameters":[{"name":"maskData","type":["object"],"help":"the maskData that will be pushed","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"The renderSession whose context will be used for this mask manager.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CanvasRenderer.json b/docgen/output/PIXI.CanvasRenderer.json deleted file mode 100644 index 760ff6887..000000000 --- a/docgen/output/PIXI.CanvasRenderer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CanvasRenderer","extends":"","static":false,"constructor":true,"parameters":[{"name":"[width=800]","type":["number"],"help":"the width of the canvas view","optional":false,"default":null},{"name":"[height=600]","type":["number"],"help":"the height of the canvas view","optional":false,"default":null},{"name":"[options]","type":["object"],"help":"The optional renderer parameters","optional":false,"default":null},{"name":"[options.view]","type":["HTMLCanvasElement"],"help":"the canvas to use as a view, optional","optional":false,"default":null},{"name":"[options.transparent=false]","type":["boolean"],"help":"If the render view is transparent, default false","optional":false,"default":null},{"name":"[options.resolution=1]","type":["number"],"help":"the resolution of the renderer retina would be 2","optional":false,"default":null},{"name":"[options.clearBeforeRender=true]","type":["boolean"],"help":"This sets if the CanvasRenderer will clear the canvas or not before the new render pass.","optional":false,"default":null}],"help":"The CanvasRenderer draws the Stage and all its content onto a 2d canvas. This renderer should be used for browsers that do not support webGL.\\nDon't forget to add the CanvasRenderer.view to your DOM or you will not see anything :)"},"consts":[],"methods":{"public":[{"name":"render","static":false,"returns":null,"help":"Renders the Stage to this canvas view","line":180,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the Stage element to be rendered","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"Resizes the canvas view to the specified width and height","line":230,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the canvas view","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the canvas view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"mapBlendModes","static":false,"returns":null,"help":"Maps Pixi blend modes to canvas blend modes.","line":263,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"renderDisplayObject","static":false,"returns":null,"help":"Renders a display object","line":250,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The displayObject to render","optional":false,"default":null},{"name":"context","type":["CanvasRenderingContext2D"],"help":"the context 2d method of the canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"CanvasMaskManager","type":["PIXI.CanvasMaskManager"],"help":"Instance of a PIXI.CanvasMaskManager, handles masking when using the canvas renderer","inlineHelp":"","line":135,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clearBeforeRender","type":["boolean"],"help":"This sets if the CanvasRenderer will clear the canvas or not before the new render pass.\\nIf the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color.\\nIf the Stage is transparent Pixi will use clearRect to clear the canvas every frame.\\nDisable this by setting this to false. For example if your game has a canvas filling background image you often don't need this set.","inlineHelp":"","line":65,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"The canvas 2d context that everything is drawn with","inlineHelp":"","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"count","type":["number"],"help":"Internal var.","inlineHelp":"","line":128,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the canvas view","inlineHelp":"","line":91,"default":"600","public":true,"protected":false,"private":false,"readOnly":false},{"name":"refresh","type":["boolean"],"help":"Boolean flag controlling canvas refresh.","inlineHelp":"","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderSession","type":["object"],"help":"The render session is just a bunch of parameter used for rendering","inlineHelp":"","line":142,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the canvas.","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"transparent","type":["boolean"],"help":"Whether the render view is transparent","inlineHelp":"","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"The renderer type.","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"view","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to.","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the canvas view","inlineHelp":"","line":82,"default":"800","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CanvasTinter.json b/docgen/output/PIXI.CanvasTinter.json deleted file mode 100644 index 3c39d3c33..000000000 --- a/docgen/output/PIXI.CanvasTinter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CanvasTinter","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"getTintedTexture","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"The tinted canvas"},"help":"Basically this method just needs a sprite and a color and tints the sprite with the given color.","line":22,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["PIXI.Sprite"],"help":"the sprite to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"roundColor","static":false,"returns":null,"help":"Rounds the specified color according to the PIXI.CanvasTinter.cacheStepsPerColorChannel.","line":190,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"the color to round, should be a hex color","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintMethod","static":false,"returns":null,"help":"The tinting method that will be used.","line":232,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"tintPerPixel","static":false,"returns":null,"help":"Tint a texture pixel per pixel.","line":147,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintWithMultiply","static":false,"returns":null,"help":"Tint a texture using the \"multiply\" operation.","line":66,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintWithOverlay","static":false,"returns":null,"help":"Tint a texture using the \"overlay\" operation.","line":112,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"cacheStepsPerColorChannel","type":["number"],"help":"Number of steps which will be used as a cap when rounding colors.","inlineHelp":"","line":209,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canUseMultiply","type":["boolean"],"help":"Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method.","inlineHelp":"","line":225,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"convertTintToImage","type":["boolean"],"help":"Tint cache boolean flag.","inlineHelp":"","line":217,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Circle.json b/docgen/output/PIXI.Circle.json deleted file mode 100644 index ba29fc73e..000000000 --- a/docgen/output/PIXI.Circle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Circle","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of this circle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of this circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null}],"help":"The Circle object can be used to specify a hit area for displayObjects"},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Circle"],"help":"a copy of the Circle"},"help":"Creates a clone of this Circle instance","line":44,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"Whether the x\/y coordinates are within this Circle"},"help":"Checks whether the x and y coordinates given are contained within this circle","line":57,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the point to test","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the point to test","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the framing rectangle of the circle as a PIXI.Rectangle object","line":78,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"radius","type":["number"],"help":"","inlineHelp":"","line":35,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"","line":21,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"","line":28,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.ColorMatrixFilter.json b/docgen/output/PIXI.ColorMatrixFilter.json deleted file mode 100644 index 72a02b665..000000000 --- a/docgen/output/PIXI.ColorMatrixFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.ColorMatrixFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"The ColorMatrixFilter class lets you apply a 4x4 matrix transformation on the RGBA\\ncolor and alpha values of every pixel on your displayObject to produce a result\\nwith a new set of RGBA color and alpha values. It's pretty powerful!"},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"matrix","type":["array"],"help":"Sets the matrix of the color matrix filter","inlineHelp":"","line":53,"default":"[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]","public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.ColorStepFilter.json b/docgen/output/PIXI.ColorStepFilter.json deleted file mode 100644 index ffcd33591..000000000 --- a/docgen/output/PIXI.ColorStepFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.ColorStepFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This lowers the color depth of your image by the given amount, producing an image with a smaller palette."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"step","type":["number"],"help":"The number of steps to reduce the palette by.","inlineHelp":"","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.ComplexPrimitiveShader.json b/docgen/output/PIXI.ComplexPrimitiveShader.json deleted file mode 100644 index 7cabe83b7..000000000 --- a/docgen/output/PIXI.ComplexPrimitiveShader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.ComplexPrimitiveShader","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the shader.","line":114,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Initialises the shader.","line":84,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"fragmentSrc","type":["array"],"help":"The fragment shader.","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"program","type":["any"],"help":"The WebGL program.","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertexSrc","type":["array"],"help":"The vertex shader.","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_UID","type":["number"],"help":"","inlineHelp":"","line":17,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.ConvolutionFilter.json b/docgen/output/PIXI.ConvolutionFilter.json deleted file mode 100644 index 63f3aa56f..000000000 --- a/docgen/output/PIXI.ConvolutionFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.ConvolutionFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[{"name":"matrix","type":["array"],"help":"An array of values used for matrix transformation. Specified as a 9 point Array.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the object you are transforming","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the object you are transforming","optional":false,"default":null}],"help":"The ConvolutionFilter class applies a matrix convolution filter effect.\\nA convolution combines pixels in the input image with neighboring pixels to produce a new image.\\nA wide variety of image effects can be achieved through convolutions, including blurring, edge detection, sharpening, embossing, and beveling.\\nThe matrix should be specified as a 9 point Array. See http:\/\/docs.gimp.org\/en\/plug-in-convmatrix.html for more info."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"Height of the object you are transforming","inlineHelp":"","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"matrix","type":["array"],"help":"An array of values used for matrix transformation. Specified as a 9 point Array.","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"Width of the object you are transforming","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.CrossHatchFilter.json b/docgen/output/PIXI.CrossHatchFilter.json deleted file mode 100644 index 7d95dd97f..000000000 --- a/docgen/output/PIXI.CrossHatchFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.CrossHatchFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"A Cross Hatch effect filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"Sets the strength of both the blur.","inlineHelp":"","line":72,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.DisplacementFilter.json b/docgen/output/PIXI.DisplacementFilter.json deleted file mode 100644 index f9073ea9a..000000000 --- a/docgen/output/PIXI.DisplacementFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.DisplacementFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture used for the displacement map * must be power of 2 texture at the moment","optional":false,"default":null}],"help":"The DisplacementFilter class uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object.\\nYou can use this filter to apply all manor of crazy warping effects\\nCurrently the r property of the texture is used offset the x and the g property of the texture is used to offset the y."},"consts":[],"methods":{"public":[{"name":"onTextureLoaded","static":false,"returns":null,"help":"Sets the map dimensions uniforms when the texture becomes available.","line":83,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"map","type":["PIXI.Texture"],"help":"The texture used for the displacement map. Must be power of 2 texture.","inlineHelp":"","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"The offset used to move the displacement map.","inlineHelp":"","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The multiplier used to scale the displacement result from the map calculation.","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.DisplayObject.json b/docgen/output/PIXI.DisplayObject.json deleted file mode 100644 index 86c8ea0de..000000000 --- a/docgen/output/PIXI.DisplayObject.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.DisplayObject","extends":"","static":false,"constructor":true,"parameters":[],"help":"The base class for all objects that are rendered on the screen.\\nThis is an abstract class and should not be used on its own rather it should be extended."},"consts":[],"methods":{"public":[{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the rectangular bounding area"},"help":"Retrieves the bounds of the displayObject as a rectangle object","line":526,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the rectangular bounding area"},"help":"Retrieves the local bounds of the displayObject as a rectangle object","line":538,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the object's stage reference, the stage this object is connected to","line":549,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the object will have as its current stage reference","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_destroyCachedSprite","static":false,"returns":null,"help":"Destroys the cached sprite.","line":687,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_generateCachedSprite","static":false,"returns":null,"help":"Internal method.","line":645,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_renderCachedSprite","static":false,"returns":null,"help":"Internal method.","line":625,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["object"],"help":"The render session","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":718,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":704,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_bounds","type":["Phaser.Rectangle"],"help":"The original, cached bounds of the object","inlineHelp":"","line":177,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cacheAsBitmap","type":["boolean"],"help":"Cached internal flag.","inlineHelp":"","line":204,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cacheIsDirty","type":["boolean"],"help":"Cached internal flag.","inlineHelp":"","line":213,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cr","type":["number"],"help":"cached sin rotation and cos rotation","inlineHelp":"","line":159,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_currentBounds","type":["Phaser.Rectangle"],"help":"The original, cached mask of the object","inlineHelp":"","line":195,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_interactive","type":["boolean"],"help":"[read-only] Whether or not the object is interactive, do not toggle directly! use the `interactive` property","inlineHelp":"","line":122,"default":null,"public":false,"protected":false,"private":true,"readOnly":true},{"name":"_sr","type":["number"],"help":"cached sin rotation and cos rotation","inlineHelp":"","line":150,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"worldTransform","type":["PIXI.Matrix"],"help":"[read-only] Current transform of the object based on world (parent) factors","inlineHelp":"","line":141,"default":null,"public":false,"protected":false,"private":true,"readOnly":true}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.DisplayObjectContainer.json b/docgen/output/PIXI.DisplayObjectContainer.json deleted file mode 100644 index ac0b24dac..000000000 --- a/docgen/output/PIXI.DisplayObjectContainer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.DisplayObjectContainer","extends":"PIXI.DisplayObject","static":false,"constructor":true,"parameters":[],"help":"A DisplayObjectContainer represents a collection of display objects.\\nIt is the base class of all display objects that act as a container for other objects."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":480,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":421,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.DotScreenFilter.json b/docgen/output/PIXI.DotScreenFilter.json deleted file mode 100644 index 7a7f6dbfd..000000000 --- a/docgen/output/PIXI.DotScreenFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.DotScreenFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"angle","type":["number"],"help":"The radius of the effect.","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["number"],"help":"The scale of the effect.","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Ellipse.json b/docgen/output/PIXI.Ellipse.json deleted file mode 100644 index d15d7b9a5..000000000 --- a/docgen/output/PIXI.Ellipse.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Ellipse","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the ellipse","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the ellipse","optional":false,"default":null},{"name":"width","type":["number"],"help":"The half width of this ellipse","optional":false,"default":null},{"name":"height","type":["number"],"help":"The half height of this ellipse","optional":false,"default":null}],"help":"The Ellipse object can be used to specify a hit area for displayObjects"},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"a copy of the ellipse"},"help":"Creates a clone of this Ellipse instance","line":52,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"Whether the x\/y coords are within this ellipse"},"help":"Checks whether the x and y coordinates given are contained within this ellipse","line":65,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the point to test","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the point to test","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the framing rectangle of the ellipse as a PIXI.Rectangle object","line":86,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"height","type":["number"],"help":"","inlineHelp":"","line":43,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"","line":36,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"","line":22,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"","line":29,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.EventTarget.json b/docgen/output/PIXI.EventTarget.json deleted file mode 100644 index b9f7a92e9..000000000 --- a/docgen/output/PIXI.EventTarget.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.EventTarget","extends":"","static":true,"constructor":false,"parameters":[],"help":"Mixins event emitter functionality to a class\\n\\nfunction MyEmitter() {}\\n\\nPIXI.EventTarget.mixin(MyEmitter.prototype);\\n\\nvar em = new MyEmitter();\\nem.emit('eventName', 'some data', 'some more data', {}, null, ...);"},"consts":[],"methods":{"public":[{"name":"emit","static":false,"returns":null,"help":"Emit an event to all registered event listeners.","line":62,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The name of the event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"listeners","static":false,"returns":null,"help":"Return a list of assigned event listeners.","line":48,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The events that should be listed.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mixin","static":false,"returns":null,"help":"Mixes in the properties of the EventTarget prototype onto another object","line":40,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The obj to mix into","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"off","static":false,"returns":null,"help":"Remove event listeners.","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The event we want to remove.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The listener that we need to find.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"on","static":false,"returns":null,"help":"Register a new EventListener for the given event.","line":115,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"Name of the event.","optional":false,"default":null},{"name":"callback","type":["PIXI.Functon"],"help":"fn Callback function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"once","static":false,"returns":null,"help":"Add an EventListener that's only called once.","line":131,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"Name of the event.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Callback function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAllListeners","static":false,"returns":null,"help":"Remove all listeners or only the listeners for the specified event.","line":179,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The event you want to remove all listeners for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stopImmediatePropagation","static":false,"returns":null,"help":"Stops the propagation of events to sibling listeners (no longer calls any listeners).","line":282,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stopPropagation","static":false,"returns":null,"help":"Stops the propagation of events up the scene graph (prevents bubbling).","line":273,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"data","type":["object"],"help":"The data that was passed in with this event.","inlineHelp":"","line":253,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"target","type":["object"],"help":"The original target the event triggered on.","inlineHelp":"","line":235,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"timeStamp","type":["number"],"help":"The timestamp when the event occurred.","inlineHelp":"","line":265,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"type","type":["string"],"help":"The string name of the event that this represents.","inlineHelp":"","line":244,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"stopped","type":["boolean"],"help":"Tracks the state of bubbling propagation. Do not\\nset this directly, instead use `event.stopPropagation()`","inlineHelp":"","line":215,"default":null,"public":false,"protected":false,"private":true,"readOnly":true},{"name":"stoppedImmediate","type":["boolean"],"help":"Tracks the state of sibling listener propagation. Do not\\nset this directly, instead use `event.stopImmediatePropagation()`","inlineHelp":"","line":226,"default":null,"public":false,"protected":false,"private":true,"readOnly":true}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.FilterBlock.json b/docgen/output/PIXI.FilterBlock.json deleted file mode 100644 index a8de04332..000000000 --- a/docgen/output/PIXI.FilterBlock.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.FilterBlock","extends":"","static":false,"constructor":true,"parameters":[],"help":"A target and pass info object for filters."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"renderable","type":["boolean"],"help":"The renderable state of this FilterBlock.","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visible state of this FilterBlock.","inlineHelp":"","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.FilterTexture.json b/docgen/output/PIXI.FilterTexture.json deleted file mode 100644 index 1618cf506..000000000 --- a/docgen/output/PIXI.FilterTexture.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.FilterTexture","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null},{"name":"width","type":["number"],"help":"the horizontal range of the filter","optional":false,"default":null},{"name":"height","type":["number"],"help":"the vertical range of the filter","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"clear","static":false,"returns":null,"help":"Clears the filter texture.","line":66,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys the filter texture.","line":102,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"Resizes the texture to the specified width and height","line":81,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the texture","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the texture","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"frameBuffer","type":["any"],"help":"","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleMode","type":["number"],"help":"","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["any"],"help":"","inlineHelp":"","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Graphics.json b/docgen/output/PIXI.Graphics.json deleted file mode 100644 index 929194926..000000000 --- a/docgen/output/PIXI.Graphics.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Graphics","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[],"help":"The Graphics class contains methods used to draw primitive shapes such as lines, circles and rectangles to the display, and color and fill them."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"arc","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"The arc method creates an arc\/curve (used to create circles, or parts of circles).","line":419,"public":true,"protected":false,"private":false,"parameters":[{"name":"cx","type":["number"],"help":"The x-coordinate of the center of the circle","optional":false,"default":null},{"name":"cy","type":["number"],"help":"The y-coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null},{"name":"startAngle","type":["number"],"help":"The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)","optional":false,"default":null},{"name":"endAngle","type":["number"],"help":"The ending angle, in radians","optional":false,"default":null},{"name":"anticlockwise","type":["boolean"],"help":"Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"beginFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies a simple one-color fill that subsequent calls to other Graphics methods\\n(such as lineTo() or drawCircle()) use when drawing.","line":486,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"the color of the fill","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"the alpha of the fill","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"bezierCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a bezier curve and then draws it.","line":297,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"cpX2","type":["number"],"help":"Second Control point x","optional":false,"default":null},{"name":"cpY2","type":["number"],"help":"Second Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"clear","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.","line":604,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroyCachedSprite","static":false,"returns":null,"help":"Destroys a previous cached sprite.","line":1039,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawCircle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a circle.","line":560,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the circle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawEllipse","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws an ellipse.","line":577,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the ellipse","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the ellipse","optional":false,"default":null},{"name":"width","type":["number"],"help":"The half width of the ellipse","optional":false,"default":null},{"name":"height","type":["number"],"help":"The half height of the ellipse","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawPolygon","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a polygon using the given path.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"path","type":["array"],"help":"The path data used to construct the polygon.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRect","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRoundedRect","static":false,"returns":null,"help":"","line":544,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"Radius of the rectangle corners","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawShape","static":false,"returns":{"types":["PIXI.GraphicsData"],"help":"The generated GraphicsData object."},"help":"Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.","line":1055,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["Phaser.Circle","Phaser.Rectangle","Phaser.Ellipse","Phaser.Line","Phaser.Polygon"],"help":" The Shape object to draw.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"endFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.","line":510,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the graphics object that can then be used to create sprites\\nThis can be quite useful if your geometry is complicated and needs to be reused multiple times.","line":625,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the rectangular bounding area"},"help":"Retrieves the bounds of the graphic shape as a rectangle object","line":800,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"lineStyle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"lineWidth","type":["number"],"help":"width of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"color","type":["number"],"help":"color of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"alpha of the line to draw, will update the objects stored style","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"lineTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a line using the current line style from the current drawing position to (x, y);\\nThe current drawing position is then set to (x, y).","line":227,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to draw to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to draw to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Moves the current drawing position to x, y.","line":211,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to move to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to move to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"quadraticCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a quadratic bezier curve and then draws it.\\nBased on: https:\/\/stackoverflow.com\/questions\/785097\/how-do-i-implement-a-bezier-curve-in-c","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateBounds","static":false,"returns":null,"help":"Update the bounds of the object","line":875,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_generateCachedSprite","static":false,"returns":null,"help":"Generates the cached sprite when the sprite has cacheAsBitmap = true","line":976,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":732,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":652,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateCachedSpriteTexture","static":false,"returns":null,"help":"Updates texture size based on canvas size","line":1016,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.","inlineHelp":"","line":68,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsPadding","type":["number"],"help":"The bounds' padding used for bounds calculation.","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fillAlpha","type":["number"],"help":"The alpha value used when filling the Graphics object.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isMask","type":["boolean"],"help":"Whether this shape is being used as a mask.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineColor","type":["string"],"help":"The color of any lines drawn.","inlineHelp":"","line":41,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineWidth","type":["number"],"help":"The width (thickness) of any lines drawn.","inlineHelp":"","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"tint","type":["number"],"help":"The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.","inlineHelp":"","line":59,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_webGL","type":["array"],"help":"Array containing some WebGL-related properties used by the WebGL renderer.","inlineHelp":"","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.\\nThis is useful if your graphics element does not change often, as it will speed up the rendering of the object in exchange for taking up texture memory.\\nIt is also useful if you need the graphics object to be anti-aliased, because it will be rendered using canvas.\\nThis is not recommended if you are constantly redrawing the graphics element.","inlineHelp":"","line":148,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"cachedSpriteDirty","type":["boolean"],"help":"Used to detect if the cached sprite object needs to be updated.","inlineHelp":"","line":129,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"currentPath","type":["object"],"help":"Current path","inlineHelp":"","line":77,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"Used to detect if the graphics object has changed. If this is set to true then the graphics object will be recalculated.","inlineHelp":"","line":111,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"graphicsData","type":["array"],"help":"Graphics data","inlineHelp":"","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"webGLDirty","type":["boolean"],"help":"Used to detect if the webgl graphics object has changed. If this is set to true then the graphics object will be recalculated.","inlineHelp":"","line":120,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.GrayFilter.json b/docgen/output/PIXI.GrayFilter.json deleted file mode 100644 index ec812ffd2..000000000 --- a/docgen/output/PIXI.GrayFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.GrayFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This greyscales the palette of your Display Objects."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gray","type":["number"],"help":"The strength of the gray. 1 will make the object black and white, 0 will make the object its normal color.","inlineHelp":"","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.ImageLoader.json b/docgen/output/PIXI.ImageLoader.json deleted file mode 100644 index f3522de61..000000000 --- a/docgen/output/PIXI.ImageLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.ImageLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the image","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The image loader class is responsible for loading images file formats ('jpeg', 'jpg', 'png' and 'gif')\\nOnce the image has been loaded it is stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrame() and PIXI.Sprite.fromFrame()\\nWhen loaded this class will dispatch a 'loaded' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Loads image or takes it from cache","line":47,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadFramedSpriteSheet","static":false,"returns":null,"help":"Loads image and split it to uniform sized frames","line":78,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameWidth","type":["number"],"help":"width of each frame","optional":false,"default":null},{"name":"frameHeight","type":["number"],"help":"height of each frame","optional":false,"default":null},{"name":"textureName","type":["string"],"help":"if given, the frames will be cached in - format","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when image file is loaded or it is already cached and ready to use","line":65,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"frames","type":["array"],"help":"if the image is loaded with loadFramedSpriteSheet\\nframes will contain the sprite sheet frames","inlineHelp":"","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture being loaded","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.InteractionData.json b/docgen/output/PIXI.InteractionData.json deleted file mode 100644 index 6651fb48d..000000000 --- a/docgen/output/PIXI.InteractionData.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.InteractionData","extends":"","static":false,"constructor":true,"parameters":[],"help":"Holds all information related to an Interaction event"},"consts":[],"methods":{"public":[{"name":"getLocalPosition","static":false,"returns":{"types":["Phaser.Point"],"help":"A point containing the coordinates of the InteractionData position relative to the DisplayObject"},"help":"This will return the local coordinates of the specified displayObject for this InteractionData","line":46,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The DisplayObject that you would like the local coords off","optional":false,"default":null},{"name":"[point]","type":["Phaser.Point"],"help":"A Point object in which to store the value, optional (otherwise will create a new point)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"global","type":["Phaser.Point"],"help":"This point stores the global coords of where the touch\/mouse event happened","inlineHelp":"","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"originalEvent","type":["Event"],"help":"When passed to an event handler, this will be the original DOM Event that was captured","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"target","type":["PIXI.Sprite"],"help":"The target Sprite that was interacted with","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.InteractionManager.json b/docgen/output/PIXI.InteractionManager.json deleted file mode 100644 index 68ac7aae2..000000000 --- a/docgen/output/PIXI.InteractionManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.InteractionManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"The stage to handle interactions","optional":false,"default":null}],"help":"The interaction manager deals with mouse and touch events. Any DisplayObject can be interactive\\nif its interactive parameter is set to true\\nThis manager also supports multitouch."},"consts":[],"methods":{"public":[],"protected":[],"private":[{"name":"collectInteractiveSprite","static":false,"returns":null,"help":"Collects an interactive sprite recursively to have their interactions managed","line":160,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"the displayObject to collect","optional":false,"default":null},{"name":"iParent","type":["PIXI.DisplayObject"],"help":"the display object's parent","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hitTest","static":false,"returns":null,"help":"Tests if the current mouse coordinates hit a sprite","line":594,"public":false,"protected":false,"private":true,"parameters":[{"name":"item","type":["PIXI.DisplayObject"],"help":"The displayObject to test for a hit","optional":false,"default":null},{"name":"interactionData","type":["PIXI.InteractionData"],"help":"The interactionData object to update in the case there is a hit","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseDown","static":false,"returns":null,"help":"Is called when the mouse button is pressed down on the renderer element","line":423,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse button being pressed down","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseMove","static":false,"returns":null,"help":"Is called when the mouse moves across the renderer element","line":387,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of the mouse moving","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOut","static":false,"returns":null,"help":"Is called when the mouse is moved out of the renderer element","line":484,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse being moved out","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUp","static":false,"returns":null,"help":"Is called when the mouse button is released on the renderer element","line":525,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a mouse button being released","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnd","static":false,"returns":null,"help":"Is called when a touch is ended on the renderer element","line":805,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch ending on the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchMove","static":false,"returns":null,"help":"Is called when a touch is moved across the renderer element","line":690,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch moving across the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchStart","static":false,"returns":null,"help":"Is called when a touch is started on the renderer element","line":736,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"The DOM event of a touch starting on the renderer view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rebuildInteractiveGraph","static":false,"returns":null,"help":"","line":359,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeEvents","static":false,"returns":null,"help":"","line":249,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setTarget","static":false,"returns":null,"help":"Sets the target for event delegation","line":200,"public":false,"protected":false,"private":true,"parameters":[{"name":"target","type":["PIXI.WebGLRenderer","PIXI.CanvasRenderer"],"help":"the renderer to bind events to","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTargetDomElement","static":false,"returns":null,"help":"Sets the DOM element which will receive mouse\/touch events. This is useful for when you have other DOM\\nelements on top of the renderers Canvas element. With this you'll be able to delegate another DOM element\\nto receive those events","line":220,"public":false,"protected":false,"private":true,"parameters":[{"name":"domElement","type":["DOMElement"],"help":"the DOM element which will receive mouse and touch events","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"updates the state of interactive objects","line":276,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"currentCursorStyle","type":["string"],"help":"The css style of the cursor that is being used","inlineHelp":"","line":133,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"last","type":["number"],"help":"","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouse","type":["PIXI.InteractionData"],"help":"The mouse data","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOut","type":["boolean"],"help":"Is set to true when the mouse is moved out of the canvas","inlineHelp":"","line":140,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseoverEnabled","type":["boolean"],"help":"","inlineHelp":"","line":52,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseDown","type":["function"],"help":"","inlineHelp":"","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseMove","type":["function"],"help":"","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseOut","type":["function"],"help":"","inlineHelp":"","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMouseUp","type":["function"],"help":"","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchEnd","type":["function"],"help":"","inlineHelp":"","line":114,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchMove","type":["function"],"help":"","inlineHelp":"","line":120,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTouchStart","type":["function"],"help":"","inlineHelp":"","line":108,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pool","type":["array"],"help":"Tiny little interactiveData pool !","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"","inlineHelp":"","line":146,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"A reference to the stage","inlineHelp":"","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touches","type":["object"],"help":"An object that stores current touches (InteractionData) by id reference","inlineHelp":"","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"interactionDOMElement","type":["HTMLCanvasElement"],"help":"Our canvas","inlineHelp":"","line":76,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"interactiveItems","type":["array"],"help":"An array containing all the iterative items from the our interactive tree","inlineHelp":"","line":68,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"tempPoint","type":["Phaser.Point"],"help":"","inlineHelp":"","line":45,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.InvertFilter.json b/docgen/output/PIXI.InvertFilter.json deleted file mode 100644 index e6c6b66fb..000000000 --- a/docgen/output/PIXI.InvertFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.InvertFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This inverts your Display Objects colors."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"invert","type":["number"],"help":"The strength of the invert. 1 will fully invert the colors, 0 will make the object its normal color","inlineHelp":"","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.JsonLoader.json b/docgen/output/PIXI.JsonLoader.json deleted file mode 100644 index 23f7a5cea..000000000 --- a/docgen/output/PIXI.JsonLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.JsonLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The json file loader is used to load in JSON data and parse it\\nWhen loaded this class will dispatch a 'loaded' event\\nIf loading fails this class will dispatch an 'error' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Loads the JSON data","line":64,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onError","static":false,"returns":null,"help":"Invoked if an error occurs.","line":182,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onJSONLoaded","static":false,"returns":null,"help":"Invoked when the JSON file is loaded.","line":104,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when the json file has loaded.","line":168,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseUrl","type":["string"],"help":"[read-only] The base url of the bitmap font data","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loaded","type":["boolean"],"help":"[read-only] Whether the data has loaded yet","inlineHelp":"","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"url","type":["string"],"help":"The url of the bitmap font data","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Matrix.json b/docgen/output/PIXI.Matrix.json deleted file mode 100644 index b946b9647..000000000 --- a/docgen/output/PIXI.Matrix.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Matrix","extends":"","static":false,"constructor":true,"parameters":[],"help":"The Matrix class is now an object, which makes it a lot faster,\\nhere is a representation of it :\\n| a | b | tx|\\n| c | d | ty|\\n| 0 | 0 | 1 |"},"consts":[],"methods":{"public":[{"name":"apply","static":false,"returns":{"types":["Phaser.Point"],"help":"The new point, transformed through this matrix"},"help":"Get a new position with the current transformation applied.\\nCan be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)","line":132,"public":true,"protected":false,"private":false,"parameters":[{"name":"pos","type":["Phaser.Point"],"help":"The origin","optional":false,"default":null},{"name":"[newPos]","type":["Phaser.Point"],"help":"The point that the new position is assigned to (allowed to be same as input)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"applyInverse","static":false,"returns":{"types":["Phaser.Point"],"help":"The new point, inverse-transformed through this matrix"},"help":"Get a new position with the inverse of the current transformation applied.\\nCan be used to go from the world coordinate space to a child's coordinate space. (e.g. input)","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"pos","type":["Phaser.Point"],"help":"The origin","optional":false,"default":null},{"name":"[newPos]","type":["Phaser.Point"],"help":"The point that the new position is assigned to (allowed to be same as input)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromArray","static":false,"returns":null,"help":"Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:\\n\\na = array[0]\\nb = array[1]\\nc = array[3]\\nd = array[4]\\ntx = array[2]\\nty = array[5]","line":73,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array that the matrix will be populated from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"identity","static":false,"returns":{"types":["PIXI.Matrix"],"help":"This matrix. Good for chaining method calls."},"help":"Resets this Matix to an identity (default) matrix.","line":256,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"toArray","static":false,"returns":{"types":["array"],"help":"the newly created array which contains the matrix"},"help":"Creates an array from the current Matrix object.","line":90,"public":true,"protected":false,"private":false,"parameters":[{"name":"transpose","type":["boolean"],"help":"Whether we need to transpose the matrix or not","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"translate","static":false,"returns":{"types":["PIXI.Matrix"],"help":"This matrix. Good for chaining method calls."},"help":"Translates the matrix on the x and y.\\n\\n*\/\\nPIXI.Matrix.prototype.translate = function(x, y)\\n{\\nthis.tx += x;\\nthis.ty += y;\\n\\nreturn this;\\n};\\n\\n\/**\\nApplies a scale transformation to the matrix.\\n\\n*\/\\nPIXI.Matrix.prototype.scale = function(x, y)\\n{\\nthis.a *= x;\\nthis.d *= y;\\nthis.c *= x;\\nthis.b *= y;\\nthis.tx *= x;\\nthis.ty *= y;\\n\\nreturn this;\\n};\\n\\n\\n\/**\\nApplies a rotation transformation to the matrix.\\n*\/\\nPIXI.Matrix.prototype.rotate = function(angle)\\n{\\nvar cos = Math.cos( angle );\\nvar sin = Math.sin( angle );\\n\\nvar a1 = this.a;\\nvar c1 = this.c;\\nvar tx1 = this.tx;\\n\\nthis.a = a1 * cos-this.b * sin;\\nthis.b = a1 * sin+this.b * cos;\\nthis.c = c1 * cos-this.d * sin;\\nthis.d = c1 * sin+this.d * cos;\\nthis.tx = tx1 * cos - this.ty * sin;\\nthis.ty = tx1 * sin + this.ty * cos;\\n\\nreturn this;\\n};\\n\\n\/**\\nAppends the given Matrix to this Matrix.","line":232,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null},{"name":"y","type":["number"],"help":"","optional":false,"default":null},{"name":"x","type":["number"],"help":" The amount to scale horizontally","optional":false,"default":null},{"name":"y","type":["number"],"help":" The amount to scale vertically","optional":false,"default":null},{"name":"angle","type":["number"],"help":" The angle in radians.","optional":false,"default":null},{"name":"matrix","type":["PIXI.Matrix"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"a","type":["number"],"help":"","inlineHelp":"","line":22,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"b","type":["number"],"help":"","inlineHelp":"","line":29,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"c","type":["number"],"help":"","inlineHelp":"","line":36,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"d","type":["number"],"help":"","inlineHelp":"","line":43,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"tx","type":["number"],"help":"","inlineHelp":"","line":50,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ty","type":["number"],"help":"","inlineHelp":"","line":57,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.MovieClip.json b/docgen/output/PIXI.MovieClip.json deleted file mode 100644 index f33d9b133..000000000 --- a/docgen/output/PIXI.MovieClip.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.MovieClip","extends":"PIXI.Sprite","static":false,"constructor":true,"parameters":[{"name":"textures","type":["array PIXI.Texture"],"help":"an array of {Texture} objects that make up the animation","optional":false,"default":null}],"help":"A MovieClip is a simple way to display an animation depicted by a list of textures."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromFrames","static":true,"returns":null,"help":"A short hand way of creating a movieclip from an array of frame ids","line":176,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"the array of frames ids the movieclip will use as its texture frames","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImages","static":true,"returns":null,"help":"A short hand way of creating a movieclip from an array of image ids","line":195,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"the array of image ids the movieclip will use as its texture frames","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"gotoAndPlay","static":false,"returns":null,"help":"Goes to a specific frame and begins playing the MovieClip","line":131,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameNumber","type":["number"],"help":"frame index to start at","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"gotoAndStop","static":false,"returns":null,"help":"Stops the MovieClip and goes to a specific frame","line":117,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameNumber","type":["number"],"help":"frame index to stop at","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"play","static":false,"returns":null,"help":"Plays the MovieClip","line":106,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"stop","static":false,"returns":null,"help":"Stops the MovieClip","line":96,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animationSpeed","type":["number"],"help":"The speed that the MovieClip will play at. Higher is faster, lower is slower","inlineHelp":"","line":32,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"currentFrame","type":["number"],"help":"[read-only] The MovieClips current frame index (this may not have to be a whole number)","inlineHelp":"","line":59,"default":"0","public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"loop","type":["boolean"],"help":"Whether or not the movie clip repeats after playing.","inlineHelp":"","line":41,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onComplete","type":["function"],"help":"Function to call when a MovieClip finishes playing","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"playing","type":["boolean"],"help":"[read-only] Indicates if the MovieClip is currently playing","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textures","type":["array"],"help":"The array of textures that make up the animation","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"totalFrames","type":["number"],"help":"[read-only] totalFrames is the total number of frames in the MovieClip. This is the same as number of textures\\nassigned to the MovieClip.","inlineHelp":"","line":84,"default":"0","public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.NoiseFilter.json b/docgen/output/PIXI.NoiseFilter.json deleted file mode 100644 index 5012dc385..000000000 --- a/docgen/output/PIXI.NoiseFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.NoiseFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"A Noise effect filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"noise","type":["number"],"help":"The amount of noise to apply.","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.NormalMapFilter.json b/docgen/output/PIXI.NormalMapFilter.json deleted file mode 100644 index b9c5fe733..000000000 --- a/docgen/output/PIXI.NormalMapFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.NormalMapFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture used for the displacement map * must be power of 2 texture at the moment","optional":false,"default":null}],"help":"The NormalMapFilter class uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object.\\nYou can use this filter to apply all manor of crazy warping effects\\nCurrently the r property of the texture is used offset the x and the g property of the texture is used to offset the y."},"consts":[],"methods":{"public":[{"name":"onTextureLoaded","static":false,"returns":null,"help":"Sets the map dimensions uniforms when the texture becomes available.","line":145,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"map","type":["PIXI.Texture"],"help":"The texture used for the displacement map. Must be power of 2 texture.","inlineHelp":"","line":159,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"The offset used to move the displacement map.","inlineHelp":"","line":189,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The multiplier used to scale the displacement result from the map calculation.","inlineHelp":"","line":174,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.PixelateFilter.json b/docgen/output/PIXI.PixelateFilter.json deleted file mode 100644 index 65fcb582a..000000000 --- a/docgen/output/PIXI.PixelateFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.PixelateFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This filter applies a pixelate effect making display objects appear 'blocky'."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"size","type":["Phaser.Point"],"help":"This a point that describes the size of the blocks. x is the width of the block and y is the height.","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.PixiFastShader.json b/docgen/output/PIXI.PixiFastShader.json deleted file mode 100644 index 41e088c4c..000000000 --- a/docgen/output/PIXI.PixiFastShader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.PixiFastShader","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the shader.","line":148,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Initialises the shader.","line":99,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"fragmentSrc","type":["array"],"help":"The fragment shader.","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"program","type":["any"],"help":"The WebGL program.","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textureCount","type":["number"],"help":"A local texture counter for multi-texture shaders.","inlineHelp":"","line":87,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertexSrc","type":["array"],"help":"The vertex shader.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_UID","type":["number"],"help":"","inlineHelp":"","line":17,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.PixiShader.json b/docgen/output/PIXI.PixiShader.json deleted file mode 100644 index 8b1776e12..000000000 --- a/docgen/output/PIXI.PixiShader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.PixiShader","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the shader.","line":356,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Initialises the shader.","line":88,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"initSampler2D","static":false,"returns":null,"help":"Initialises a Sampler2D uniform (which may only be available later on after initUniforms once the texture has loaded)","line":213,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"initUniforms","static":false,"returns":null,"help":"Initialises the shader uniform values.\\n\\nUniforms are specified in the GLSL_ES Specification: http:\/\/www.khronos.org\/registry\/webgl\/specs\/latest\/1.0\/\\nhttp:\/\/www.khronos.org\/registry\/gles\/specs\/2.0\/GLSL_ES_Specification_1.0.17.pdf","line":142,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"syncUniforms","static":false,"returns":null,"help":"Updates the shader uniform values.","line":288,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"defaultVertexSrc","type":["string"],"help":"The Default Vertex shader source.","inlineHelp":"","line":371,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"A dirty flag","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fragmentSrc","type":["array"],"help":"The fragment shader.","inlineHelp":"","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"program","type":["any"],"help":"The WebGL program.","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textureCount","type":["number"],"help":"A local texture counter for multi-texture shaders.","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_UID","type":["number"],"help":"","inlineHelp":"","line":18,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"attributes","type":["array"],"help":"Uniform attributes cache.","inlineHelp":"","line":76,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"firstRun","type":["boolean"],"help":"A local flag","inlineHelp":"","line":61,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Point.json b/docgen/output/PIXI.Point.json deleted file mode 100644 index ff40ca623..000000000 --- a/docgen/output/PIXI.Point.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Point","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"position of the point on the x axis","optional":false,"default":null},{"name":"y","type":["number"],"help":"position of the point on the y axis","optional":false,"default":null}],"help":"The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Point"],"help":"a copy of the point"},"help":"Creates a clone of this point","line":36,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"set","static":false,"returns":null,"help":"Sets the point to a new x and y position.\\nIf y is omitted, both x and y will be set to x.","line":49,"public":true,"protected":false,"private":false,"parameters":[{"name":"[x=0]","type":["number"],"help":"position of the point on the x axis","optional":false,"default":null},{"name":"[y=0]","type":["number"],"help":"position of the point on the y axis","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"x","type":["number"],"help":"","inlineHelp":"","line":20,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"","line":27,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.PolyK.json b/docgen/output/PIXI.PolyK.json deleted file mode 100644 index 0998e81f6..000000000 --- a/docgen/output/PIXI.PolyK.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.PolyK","extends":"","static":true,"constructor":false,"parameters":[],"help":"Based on the Polyk library http:\/\/polyk.ivank.net released under MIT licence.\\nThis is an amazing lib!\\nSlightly modified by Mat Groves (matgroves.com);"},"consts":[],"methods":{"public":[{"name":"Triangulate","static":false,"returns":null,"help":"Triangulates shapes for webGL graphic fills.","line":47,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_PointInTriangle","static":false,"returns":{"types":["boolean"],"help":""},"help":"Checks whether a point is within a triangle","line":135,"public":false,"protected":false,"private":true,"parameters":[{"name":"px","type":["number"],"help":"x coordinate of the point to test","optional":false,"default":null},{"name":"py","type":["number"],"help":"y coordinate of the point to test","optional":false,"default":null},{"name":"ax","type":["number"],"help":"x coordinate of the a point of the triangle","optional":false,"default":null},{"name":"ay","type":["number"],"help":"y coordinate of the a point of the triangle","optional":false,"default":null},{"name":"bx","type":["number"],"help":"x coordinate of the b point of the triangle","optional":false,"default":null},{"name":"by","type":["number"],"help":"y coordinate of the b point of the triangle","optional":false,"default":null},{"name":"cx","type":["number"],"help":"x coordinate of the c point of the triangle","optional":false,"default":null},{"name":"cy","type":["number"],"help":"y coordinate of the c point of the triangle","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_convex","static":false,"returns":{"types":["boolean"],"help":""},"help":"Checks whether a shape is convex","line":165,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Polygon.json b/docgen/output/PIXI.Polygon.json deleted file mode 100644 index 7e8f46a7f..000000000 --- a/docgen/output/PIXI.Polygon.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Polygon","extends":"","static":false,"constructor":true,"parameters":[{"name":"points*","type":["array Phaser.Point","array number","Phaser.Point","number"],"help":"This can be an array of Points that form the polygon,","optional":false,"default":null}],"help":"a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be\\nall the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the\\narguments passed can be flat x,y values e.g. `new PIXI.Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are\\nNumbers."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Polygon"],"help":"a copy of the polygon"},"help":"Creates a clone of this polygon","line":41,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"Whether the x\/y coordinates are within this polygon"},"help":"Checks whether the x and y coordinates passed to this function are contained within this polygon","line":55,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the point to test","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the point to test","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.PrimitiveShader.json b/docgen/output/PIXI.PrimitiveShader.json deleted file mode 100644 index 17c1d9a98..000000000 --- a/docgen/output/PIXI.PrimitiveShader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.PrimitiveShader","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the shader.","line":108,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Initialises the shader.","line":79,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"fragmentSrc","type":["array"],"help":"The fragment shader.","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"program","type":["any"],"help":"The WebGL program.","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertexSrc","type":["array"],"help":"The vertex shader.","inlineHelp":"","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_UID","type":["number"],"help":"","inlineHelp":"","line":17,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.RGBSplitFilter.json b/docgen/output/PIXI.RGBSplitFilter.json deleted file mode 100644 index 25a4736c5..000000000 --- a/docgen/output/PIXI.RGBSplitFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.RGBSplitFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"An RGB Split Filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"angle","type":["number"],"help":"The angle of the split.","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Rectangle.json b/docgen/output/PIXI.Rectangle.json deleted file mode 100644 index c81ef8980..000000000 --- a/docgen/output/PIXI.Rectangle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Rectangle","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the upper-left corner of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the upper-left corner of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The overall width of this rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The overall height of this rectangle","optional":false,"default":null}],"help":"the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"a copy of the rectangle"},"help":"Creates a clone of this Rectangle","line":52,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"Whether the x\/y coordinates are within this Rectangle"},"help":"Checks whether the x and y coordinates given are contained within this Rectangle","line":65,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the point to test","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the point to test","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"height","type":["number"],"help":"","inlineHelp":"","line":43,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"","line":36,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"","line":22,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"","line":29,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.RenderTexture.json b/docgen/output/PIXI.RenderTexture.json deleted file mode 100644 index 4ad6b5c17..000000000 --- a/docgen/output/PIXI.RenderTexture.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.RenderTexture","extends":"PIXI.Texture","static":false,"constructor":true,"parameters":[{"name":"width","type":["number"],"help":"The width of the render texture","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the render texture","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used for this RenderTexture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null}],"help":"A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.\\n\\n__Hint__: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded otherwise black rectangles will be drawn instead.\\n\\nA RenderTexture takes a snapshot of any Display Object given to its render method. The position and rotation of the given Display Objects is ignored. For example:\\n\\nvar renderTexture = new PIXI.RenderTexture(800, 600);\\nvar sprite = PIXI.Sprite.fromImage(\"spinObj_01.png\");\\nsprite.position.x = 800\/2;\\nsprite.position.y = 600\/2;\\nsprite.anchor.x = 0.5;\\nsprite.anchor.y = 0.5;\\nrenderTexture.render(sprite);\\n\\nThe Sprite in this case will be rendered to a position of 0,0. To render this sprite at its actual position a DisplayObjectContainer should be used:\\n\\nvar doc = new PIXI.DisplayObjectContainer();\\ndoc.addChild(sprite);\\nrenderTexture.render(doc); \/\/ Renders to center of renderTexture"},"consts":[],"methods":{"public":[{"name":"addTextureToCache","static":true,"returns":null,"help":"Adds a texture to the global PIXI.TextureCache. This cache is shared across the whole PIXI object.","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The Texture to add to the cache.","optional":false,"default":null},{"name":"id","type":["string"],"help":"The id that the texture will be stored against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"clear","static":false,"returns":null,"help":"Clears the RenderTexture.","line":176,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this texture","line":155,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyBase","type":["boolean"],"help":"Whether to destroy the base texture as well","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a new a Texture based on the given canvas element.","line":276,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromFrame","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that returns a Texture objected based on the given frame id.\\nIf the frame id is not in the texture cache an error will be thrown.","line":260,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame id of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a Texture object from the given image url.\\nIf the image is not in the texture cache it will be created and loaded.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"getBase64","static":false,"returns":{"types":["string"],"help":"A base64 encoded string of the texture."},"help":"Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.","line":294,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getCanvas","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"A Canvas element with the texture rendered on."},"help":"Creates a Canvas element, renders this RenderTexture to it and then returns it.","line":305,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getImage","static":false,"returns":{"types":["Image"],"help":""},"help":"Will return a HTML Image of the texture","line":281,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"removeTextureFromCache","static":true,"returns":{"types":["PIXI.Texture"],"help":"The texture that was removed"},"help":"Remove a texture from the global PIXI.TextureCache.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"id","type":["string"],"help":"The id of the texture to be removed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"resize","static":false,"returns":null,"help":"Resizes the RenderTexture.","line":145,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width to resize to.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height to resize to.","optional":false,"default":null},{"name":"updateBase","type":["boolean"],"help":"Should the baseTexture.width and height values be resized as well?","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"setFrame","static":false,"returns":null,"help":"Specifies the region of the baseTexture that this texture will use.","line":168,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Rectangle"],"help":"The frame of the texture to set it to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"}],"protected":[],"private":[{"name":"renderCanvas","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":246,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The display object to render this texture on","optional":false,"default":null},{"name":"[matrix]","type":["PIXI.Matrix"],"help":"Optional matrix to apply to the display object before rendering.","optional":false,"default":null},{"name":"[clear]","type":["boolean"],"help":"If true the texture will be cleared before the displayObject is drawn","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderWebGL","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":197,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The display object to render this texture on","optional":false,"default":null},{"name":"[matrix]","type":["PIXI.Matrix"],"help":"Optional matrix to apply to the display object before rendering.","optional":false,"default":null},{"name":"[clear]","type":["boolean"],"help":"If true the texture will be cleared before the displayObject is drawn","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"The base texture object that this texture uses","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crop","type":["Phaser.Rectangle"],"help":"This is the area of the BaseTexture image to actually copy to the Canvas \/ WebGL when rendering,\\nirrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)","inlineHelp":"","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["Phaser.Rectangle"],"help":"The framing rectangle of the render texture","inlineHelp":"","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the render texture","inlineHelp":"","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"noFrame","type":["boolean"],"help":"Does this Texture have any frame data assigned to it?","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.","inlineHelp":"","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"requiresUpdate","type":["boolean"],"help":"This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)","inlineHelp":"","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"trim","type":["Phaser.Rectangle"],"help":"The texture trim data.","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"valid","type":["boolean"],"help":"","inlineHelp":"","line":129,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The with of the render texture","inlineHelp":"","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Rope.json b/docgen/output/PIXI.Rope.json deleted file mode 100644 index 87a33f3a9..000000000 --- a/docgen/output/PIXI.Rope.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Rope","extends":"PIXI.Strip","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture to use on the rope.","optional":false,"default":null},{"name":"points","type":["array"],"help":"An array of {PIXI.Point}.","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"Whether the strip is dirty or not","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"if you need a padding, not yet implemented","inlineHelp":"","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture of the strip","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.SepiaFilter.json b/docgen/output/PIXI.SepiaFilter.json deleted file mode 100644 index 4817775d8..000000000 --- a/docgen/output/PIXI.SepiaFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.SepiaFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This applies a sepia effect to your Display Objects."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sepia","type":["number"],"help":"The strength of the sepia. 1 will apply the full sepia effect, 0 will make the object its normal color.","inlineHelp":"","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.SmartBlurFilter.json b/docgen/output/PIXI.SmartBlurFilter.json deleted file mode 100644 index 2861b3097..000000000 --- a/docgen/output/PIXI.SmartBlurFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.SmartBlurFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"A Smart Blur Filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"The strength of the blur.","inlineHelp":"","line":68,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.SpineLoader.json b/docgen/output/PIXI.SpineLoader.json deleted file mode 100644 index 86940e601..000000000 --- a/docgen/output/PIXI.SpineLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.SpineLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The Spine loader is used to load in JSON spine data\\nTo generate the data you need to use http:\/\/esotericsoftware.com\/ and export in the \"JSON\" format\\nDue to a clash of names You will need to change the extension of the spine file from *.json to *.anim for it to load\\nSee example 12 (http:\/\/www.goodboydigital.com\/pixijs\/examples\/12\/) to see a working example and check out the source\\nYou will need to generate a sprite sheet to accompany the spine data\\nWhen loaded this class will dispatch a \"loaded\" event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Loads the JSON data","line":61,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when JSON file is loaded.","line":78,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loaded","type":["boolean"],"help":"[read-only] Whether the data has loaded yet","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"url","type":["string"],"help":"The url of the bitmap font data","inlineHelp":"","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Sprite.json b/docgen/output/PIXI.Sprite.json deleted file mode 100644 index 9f7274c76..000000000 --- a/docgen/output/PIXI.Sprite.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Sprite","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture for this sprite","optional":false,"default":null}],"help":"The Sprite object is the base for all textured objects that are rendered to the screen\\n\\n\\nA sprite can be created directly from an image like this :\\nvar sprite = new PIXI.Sprite.fromImage('assets\/image.png');\\nyourStage.addChild(sprite);\\nthen obviously don't forget to add it to the stage you have already created"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":313,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":250,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTextureUpdate","static":false,"returns":null,"help":"When the texture is updated, this event will fire to update the scale and frame","line":155,"public":false,"protected":false,"private":true,"parameters":[{"name":null,"type":[],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_height","type":["number"],"help":"The height of the sprite (this is initially set by the texture)","inlineHelp":"","line":57,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_width","type":["number"],"help":"The width of the sprite (this is initially set by the texture)","inlineHelp":"","line":48,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.SpriteBatch.json b/docgen/output/PIXI.SpriteBatch.json deleted file mode 100644 index d751f30ef..000000000 --- a/docgen/output/PIXI.SpriteBatch.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.SpriteBatch","extends":"","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"","optional":false,"default":null}],"help":"The SpriteBatch class is a really fast version of the DisplayObjectContainer\\nbuilt solely for speed, so use when you need a lot of sprites or particles.\\nAnd it's extremely easy to use :\\n\\nvar container = new PIXI.SpriteBatch();\\n\\nstage.addChild(container);\\n\\nfor(var i = 0; i < 100; i++)\\n{\\nvar sprite = new PIXI.Sprite.fromImage(\"myImage.png\");\\ncontainer.addChild(sprite);\\n}\\nAnd here you have a hundred sprites that will be renderer at the speed of light"},"consts":[],"methods":{"public":[],"protected":[],"private":[{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":97,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":73,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.SpriteSheetLoader.json b/docgen/output/PIXI.SpriteSheetLoader.json deleted file mode 100644 index 00f425502..000000000 --- a/docgen/output/PIXI.SpriteSheetLoader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.SpriteSheetLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the sprite sheet JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The sprite sheet loader is used to load in JSON sprite sheet data\\nTo generate the data you can use http:\/\/www.codeandweb.com\/texturepacker and publish in the 'JSON' format\\nThere is a free version so thats nice, although the paid version is great value for money.\\nIt is highly recommended to use Sprite sheets (also know as a 'texture atlas') as it means sprites can be batched and drawn together for highly increased rendering speed.\\nOnce the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId()\\nThis loader will load the image file that the Spritesheet points to as well as the data.\\nWhen loaded this class will dispatch a 'loaded' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"This will begin loading the JSON file","line":74,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoke when all files are loaded (json and texture)","line":90,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseUrl","type":["string"],"help":"[read-only] The base url of the bitmap font data","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frames","type":["object"],"help":"The frames of the sprite sheet","inlineHelp":"","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"The texture being loaded","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"url","type":["string"],"help":"The url of the atlas data","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Stage.json b/docgen/output/PIXI.Stage.json deleted file mode 100644 index 7139849cd..000000000 --- a/docgen/output/PIXI.Stage.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Stage","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"backgroundColor","type":["number"],"help":"the background color of the stage, you have to pass this in is in hex format","optional":false,"default":null}],"help":"A Stage represents the root of the display tree. Everything connected to the stage is rendered\\n\\nlike: 0xFFFFFF for white\\n\\nCreating a stage is a mandatory process when you use Pixi, which is as simple as this :\\nvar stage = new PIXI.Stage(0xFFFFFF);\\nwhere the parameter given is the background colour of the stage, in hex\\nyou will use this stage instance to add your sprites to it and therefore to the renderer\\nHere is how to add a sprite to the stage :\\nstage.addChild(sprite);"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getMousePosition","static":false,"returns":{"types":["Phaser.Point"],"help":"A point containing the coordinates of the global InteractionData position."},"help":"This will return the point containing global coordinates of the mouse.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setBackgroundColor","static":false,"returns":null,"help":"Sets the background color for the stage\\n\\nlike: 0xFFFFFF for white","line":117,"public":true,"protected":false,"private":false,"parameters":[{"name":"backgroundColor","type":["number"],"help":"the color of the background, easiest way to pass this in is in hex format","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setInteractionDelegate","static":false,"returns":null,"help":"Sets another DOM element which can receive mouse\/touch interactions instead of the default Canvas element.\\nThis is useful for when you have other DOM elements on top of the Canvas element.","line":80,"public":true,"protected":false,"private":false,"parameters":[{"name":"domElement","type":["DOMElement"],"help":"This new domElement which will receive mouse\/touch events","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactionManager","type":["PIXI.InteractionManager"],"help":"The interaction manage for this stage, manages all interactive activity on the stage","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Whether or not the stage is interactive","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"dirty","type":["boolean"],"help":"Whether the stage is dirty and needs to have interactions updated","inlineHelp":"","line":58,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"worldTransform","type":["PIXI.Matrix"],"help":"[read-only] Current transform of the object based on world (parent) factors","inlineHelp":"","line":33,"default":null,"public":false,"protected":false,"private":true,"readOnly":true}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Strip.json b/docgen/output/PIXI.Strip.json deleted file mode 100644 index ee1111560..000000000 --- a/docgen/output/PIXI.Strip.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Strip","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture to use","optional":false,"default":null},{"name":"width","type":["number"],"help":"the width","optional":false,"default":null},{"name":"height","type":["number"],"help":"the height","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"onTextureUpdate","static":false,"returns":null,"help":"When the texture is updated, this event will fire to update the scale and frame","line":348,"public":false,"protected":false,"private":true,"parameters":[{"name":null,"type":[],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderStripFlat","static":false,"returns":null,"help":"Renders a flat strip","line":300,"public":false,"protected":false,"private":true,"parameters":[{"name":"strip","type":["PIXI.Strip"],"help":"The Strip to render","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"Whether the strip is dirty or not","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"if you need a padding, not yet implemented","inlineHelp":"","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture of the strip","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.StripShader.json b/docgen/output/PIXI.StripShader.json deleted file mode 100644 index 783532afa..000000000 --- a/docgen/output/PIXI.StripShader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.StripShader","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the shader.","line":116,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Initialises the shader.","line":85,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"fragmentSrc","type":["array"],"help":"The fragment shader.","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gl","type":["PIXI.WebGLContext"],"help":"","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"program","type":["any"],"help":"The WebGL program.","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertexSrc","type":["array"],"help":"The vertex shader.","inlineHelp":"","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_UID","type":["number"],"help":"","inlineHelp":"","line":17,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Text.json b/docgen/output/PIXI.Text.json deleted file mode 100644 index bdf260d6c..000000000 --- a/docgen/output/PIXI.Text.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Text","extends":"PIXI.Sprite","static":false,"constructor":true,"parameters":[{"name":"text","type":["string"],"help":"The copy that you would like the text to display","optional":false,"default":null},{"name":"[style]","type":["object"],"help":"The style parameters","optional":false,"default":null},{"name":"[style.font]","type":["string"],"help":"default 'bold 20px Arial' The style and size of the font","optional":false,"default":null},{"name":"[style.fill='black']","type":["string","number"],"help":"A canvas fillstyle that will be used on the text e.g 'red', '#00FF00'","optional":false,"default":null},{"name":"[style.align='left']","type":["string"],"help":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text","optional":false,"default":null},{"name":"[style.stroke]","type":["string","number"],"help":"A canvas fillstyle that will be used on the text stroke e.g 'blue', '#FCFF00'","optional":false,"default":null},{"name":"[style.strokeThickness=0]","type":["number"],"help":"A number that represents the thickness of the stroke. Default is 0 (no stroke)","optional":false,"default":null},{"name":"[style.wordWrap=false]","type":["boolean"],"help":"Indicates if word wrap should be used","optional":false,"default":null},{"name":"[style.wordWrapWidth=100]","type":["number"],"help":"The width at which text will wrap, it needs wordWrap to be set to true","optional":false,"default":null},{"name":"[style.dropShadow=false]","type":["boolean"],"help":"Set a drop shadow for the text","optional":false,"default":null},{"name":"[style.dropShadowColor='#000000']","type":["string"],"help":"A fill style to be used on the dropshadow e.g 'red', '#00FF00'","optional":false,"default":null},{"name":"[style.dropShadowAngle=Math.PI\/4]","type":["number"],"help":"Set a angle of the drop shadow","optional":false,"default":null},{"name":"[style.dropShadowDistance=5]","type":["number"],"help":"Set a distance of the drop shadow","optional":false,"default":null}],"help":"A Text Object will create a line or multiple lines of text. To split a line you can use '\\n' in your text string,\\nor add a wordWrap property set to true and and wordWrapWidth property with a value in the style object."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this text object.","line":497,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyBaseTexture","type":["boolean"],"help":"whether to destroy the base texture as well","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStyle","static":false,"returns":null,"help":"Set the style of the text","line":127,"public":true,"protected":false,"private":false,"parameters":[{"name":"[style]","type":["object"],"help":"The style parameters","optional":false,"default":null},{"name":null,"type":[],"help":"","optional":false,"default":null},{"name":"[style.fill='black']","type":["object"],"help":"A canvas fillstyle that will be used on the text eg 'red', '#00FF00'","optional":false,"default":null},{"name":"[style.align='left']","type":["string"],"help":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text","optional":false,"default":null},{"name":"[style.stroke='black']","type":["string"],"help":"A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'","optional":false,"default":null},{"name":"[style.strokeThickness=0]","type":["number"],"help":"A number that represents the thickness of the stroke. Default is 0 (no stroke)","optional":false,"default":null},{"name":"[style.wordWrap=false]","type":["boolean"],"help":"Indicates if word wrap should be used","optional":false,"default":null},{"name":"[style.wordWrapWidth=100]","type":["number"],"help":"The width at which text will wrap","optional":false,"default":null},{"name":"[style.dropShadow=false]","type":["boolean"],"help":"Set a drop shadow for the text","optional":false,"default":null},{"name":"[style.dropShadowColor='#000000']","type":["string"],"help":"A fill style to be used on the dropshadow e.g 'red', '#00FF00'","optional":false,"default":null},{"name":"[style.dropShadowAngle=Math.PI\/4]","type":["number"],"help":"Set a angle of the drop shadow","optional":false,"default":null},{"name":"[style.dropShadowDistance=5]","type":["number"],"help":"Set a distance of the drop shadow","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setText","static":false,"returns":null,"help":"Set the copy for the text object. To split a line you can use '\\n'.","line":153,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The copy that you would like the text to display","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Text"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":327,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":307,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"determineFontProperties","static":false,"returns":null,"help":"Calculates the ascent, descent and fontSize of a given fontStyle","line":347,"public":false,"protected":false,"private":true,"parameters":[{"name":"fontStyle","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateText","static":false,"returns":null,"help":"Renders text and updates it when needed","line":165,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateTexture","static":false,"returns":null,"help":"Updates texture size based on canvas size","line":286,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"wordWrap","static":false,"returns":null,"help":"Applies newlines to a string to have it optimally fit into the horizontal\\nbounds set by the Text object's wordWrapWidth property.","line":451,"public":false,"protected":false,"private":true,"parameters":[{"name":"text","type":["string"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"context","type":["HTMLCanvasElement"],"help":"The canvas 2d context that everything is drawn with","inlineHelp":"","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the canvas.","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.Texture.json b/docgen/output/PIXI.Texture.json deleted file mode 100644 index 9adb199a4..000000000 --- a/docgen/output/PIXI.Texture.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.Texture","extends":"","static":false,"constructor":true,"parameters":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"The base texture source to create the texture from","optional":false,"default":null},{"name":"frame","type":["Phaser.Rectangle"],"help":"The rectangle frame of the texture to show","optional":false,"default":null},{"name":"[crop]","type":["Phaser.Rectangle"],"help":"The area of original texture","optional":false,"default":null},{"name":"[trim]","type":["Phaser.Rectangle"],"help":"Trimmed texture rectangle","optional":false,"default":null}],"help":"A texture stores the information that represents an image or part of an image. It cannot be added\\nto the display list directly. Instead use it as the texture for a PIXI.Sprite. If no frame is provided then the whole image is used."},"consts":[],"methods":{"public":[{"name":"addTextureToCache","static":true,"returns":null,"help":"Adds a texture to the global PIXI.TextureCache. This cache is shared across the whole PIXI object.","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The Texture to add to the cache.","optional":false,"default":null},{"name":"id","type":["string"],"help":"The id that the texture will be stored against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this texture","line":155,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyBase","type":["boolean"],"help":"Whether to destroy the base texture as well","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a new a Texture based on the given canvas element.","line":276,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromFrame","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that returns a Texture objected based on the given frame id.\\nIf the frame id is not in the texture cache an error will be thrown.","line":260,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame id of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a Texture object from the given image url.\\nIf the image is not in the texture cache it will be created and loaded.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"removeTextureFromCache","static":true,"returns":{"types":["PIXI.Texture"],"help":"The texture that was removed"},"help":"Remove a texture from the global PIXI.TextureCache.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"id","type":["string"],"help":"The id of the texture to be removed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"setFrame","static":false,"returns":null,"help":"Specifies the region of the baseTexture that this texture will use.","line":168,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Rectangle"],"help":"The frame of the texture to set it to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"}],"protected":[],"private":[{"name":"_updateUvs","static":false,"returns":null,"help":"Updates the internal WebGL UV cache.","line":206,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onBaseTextureLoaded","static":false,"returns":null,"help":"Called when the base texture is loaded","line":137,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"The base texture that this texture uses.","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crop","type":["Phaser.Rectangle"],"help":"This is the area of the BaseTexture image to actually copy to the Canvas \/ WebGL when rendering,\\nirrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)","inlineHelp":"","line":115,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["Phaser.Rectangle"],"help":"The frame specifies the region of the base texture that this texture uses","inlineHelp":"","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the Texture in pixels.","inlineHelp":"","line":106,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"noFrame","type":["boolean"],"help":"Does this Texture have any frame data assigned to it?","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"requiresUpdate","type":["boolean"],"help":"This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)","inlineHelp":"","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"trim","type":["Phaser.Rectangle"],"help":"The texture trim data.","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"valid","type":["boolean"],"help":"This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.","inlineHelp":"","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the Texture in pixels.","inlineHelp":"","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_uvs","type":["object"],"help":"The WebGL UV data cache.","inlineHelp":"","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.TilingSprite.json b/docgen/output/PIXI.TilingSprite.json deleted file mode 100644 index b0be9af61..000000000 --- a/docgen/output/PIXI.TilingSprite.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.TilingSprite","extends":"PIXI.Sprite","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture of the tiling sprite","optional":false,"default":null},{"name":"width","type":["number"],"help":" the width of the tiling sprite","optional":false,"default":null},{"name":"height","type":["number"],"help":"the height of the tiling sprite","optional":false,"default":null}],"help":"A tiling sprite is a fast way of rendering a tiling image"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTilingTexture","static":false,"returns":null,"help":"","line":379,"public":true,"protected":false,"private":false,"parameters":[{"name":"forcePowerOfTwo","type":["boolean"],"help":"Whether we want to force the texture to be a power of two","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.TilingSprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the framing rectangle of the sprite as a PIXI.Rectangle object","line":286,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.TilingSprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":201,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":144,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTextureUpdate","static":false,"returns":null,"help":"When the texture is updated, this event will fire to update the scale and frame","line":367,"public":false,"protected":false,"private":true,"parameters":[{"name":null,"type":[],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite","inlineHelp":"","line":84,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the TilingSprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Whether this sprite is renderable or not","inlineHelp":"","line":66,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tilePosition","type":["Phaser.Point"],"help":"The offset position of the image that is being tiled","inlineHelp":"","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileScale","type":["Phaser.Point"],"help":"The scaling of the image that is being tiled","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileScaleOffset","type":["Phaser.Point"],"help":"A point that represents the scale of the texture object","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value","inlineHelp":"","line":75,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":101,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.TiltShiftFilter.json b/docgen/output/PIXI.TiltShiftFilter.json deleted file mode 100644 index 84307448b..000000000 --- a/docgen/output/PIXI.TiltShiftFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.TiltShiftFilter","extends":"","static":false,"constructor":true,"parameters":[],"help":"A TiltShift Filter. Manages the pass of both a TiltShiftXFilter and TiltShiftYFilter."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"The strength of the blur.","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"end","type":["number"],"help":"The Y value to end the effect at.","inlineHelp":"","line":75,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gradientBlur","type":["number"],"help":"The strength of the gradient blur.","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"start","type":["number"],"help":"The Y value to start the effect at.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.TiltShiftXFilter.json b/docgen/output/PIXI.TiltShiftXFilter.json deleted file mode 100644 index 366935931..000000000 --- a/docgen/output/PIXI.TiltShiftXFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.TiltShiftXFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"A TiltShiftXFilter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"},{"name":"updateDelta","static":false,"returns":null,"help":"Updates the filter delta values.","line":143,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"The strength of the blur.","inlineHelp":"","line":78,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"end","type":["number"],"help":"The X value to end the effect at.","inlineHelp":"","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gradientBlur","type":["number"],"help":"The strength of the gradient blur.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"start","type":["number"],"help":"The X value to start the effect at.","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.TiltShiftYFilter.json b/docgen/output/PIXI.TiltShiftYFilter.json deleted file mode 100644 index b0ebb2560..000000000 --- a/docgen/output/PIXI.TiltShiftYFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.TiltShiftYFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"A TiltShiftYFilter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"},{"name":"updateDelta","static":false,"returns":null,"help":"Updates the filter delta values.","line":143,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"The strength of the blur.","inlineHelp":"","line":78,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"end","type":["number"],"help":"The Y value to end the effect at.","inlineHelp":"","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gradientBlur","type":["number"],"help":"The strength of the gradient blur.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"start","type":["number"],"help":"The Y value to start the effect at.","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.TwistFilter.json b/docgen/output/PIXI.TwistFilter.json deleted file mode 100644 index 35fb0a513..000000000 --- a/docgen/output/PIXI.TwistFilter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.TwistFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"This filter applies a twist effect making display objects appear twisted in the given direction."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"angle","type":["number"],"help":"This angle of the twist.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"This point describes the the offset of the twist.","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"radius","type":["number"],"help":"This radius of the twist.","inlineHelp":"","line":78,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLBlendModeManager.json b/docgen/output/PIXI.WebGLBlendModeManager.json deleted file mode 100644 index 6c6d36a27..000000000 --- a/docgen/output/PIXI.WebGLBlendModeManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLBlendModeManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this object.","line":55,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setBlendMode","static":false,"returns":null,"help":"Sets-up the given blendMode from WebGL's point of view.","line":38,"public":true,"protected":false,"private":false,"parameters":[{"name":"blendMode","type":["number"],"help":"the blendMode, should be a Pixi const, such as PIXI.BlendModes.ADD","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Sets the WebGL Context.","line":27,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"currentBlendMode","type":["number"],"help":"","inlineHelp":"","line":16,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLFastSpriteBatch.json b/docgen/output/PIXI.WebGLFastSpriteBatch.json deleted file mode 100644 index 61e9179da..000000000 --- a/docgen/output/PIXI.WebGLFastSpriteBatch.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLFastSpriteBatch","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"begin","static":false,"returns":null,"help":"","line":158,"public":true,"protected":false,"private":false,"parameters":[{"name":"spriteBatch","type":["PIXI.WebGLSpriteBatch"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"end","static":false,"returns":null,"help":"","line":171,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"flush","static":false,"returns":null,"help":"","line":351,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"","line":180,"public":true,"protected":false,"private":false,"parameters":[{"name":"spriteBatch","type":["PIXI.WebGLSpriteBatch"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderSprite","static":false,"returns":null,"help":"","line":211,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["PIXI.Sprite"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Sets the WebGL Context.","line":135,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"","line":399,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"","line":391,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"currentBaseTexture","type":["PIXI.BaseTexture"],"help":"","inlineHelp":"","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentBatchSize","type":["number"],"help":"","inlineHelp":"","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentBlendMode","type":["number"],"help":"","inlineHelp":"","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"drawing","type":["boolean"],"help":"","inlineHelp":"","line":87,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"indexBuffer","type":["object"],"help":"","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"indices","type":["Uint16Array"],"help":"Index data","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lastIndexCount","type":["number"],"help":"","inlineHelp":"","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"matrix","type":["PIXI.Matrix"],"help":"","inlineHelp":"","line":123,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxSize","type":["number"],"help":"","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderSession","type":["object"],"help":"","inlineHelp":"","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["object"],"help":"","inlineHelp":"","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"size","type":["number"],"help":"","inlineHelp":"","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertSize","type":["number"],"help":"","inlineHelp":"","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertexBuffer","type":["object"],"help":"","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertices","type":["Float32Array"],"help":"Vertex data","inlineHelp":"","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLFilterManager.json b/docgen/output/PIXI.WebGLFilterManager.json deleted file mode 100644 index 8aea33232..000000000 --- a/docgen/output/PIXI.WebGLFilterManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLFilterManager","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"applyFilterPass","static":false,"returns":null,"help":"Applies the filter to the specified area.","line":324,"public":true,"protected":false,"private":false,"parameters":[{"name":"filter","type":["PIXI.AbstractFilter"],"help":"the filter that needs to be applied","optional":false,"default":null},{"name":"filterArea","type":["PIXI.Texture"],"help":"TODO - might need an update","optional":false,"default":null},{"name":"width","type":["number"],"help":"the horizontal range of the filter","optional":false,"default":null},{"name":"height","type":["number"],"help":"the vertical range of the filter","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"begin","static":false,"returns":null,"help":"","line":51,"public":true,"protected":false,"private":false,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null},{"name":"buffer","type":["array"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys the filter and removes it from the filter stack.","line":429,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"initShaderBuffers","static":false,"returns":null,"help":"Initialises the shader buffers.","line":381,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"popFilter","static":false,"returns":null,"help":"Removes the last filter from the filter stack and doesn't return it.","line":143,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pushFilter","static":false,"returns":null,"help":"Applies the filter and adds it to the current filter stack.","line":68,"public":true,"protected":false,"private":false,"parameters":[{"name":"filterBlock","type":["object"],"help":"the filter that will be pushed to the current filter stack","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Initialises the context and the properties.","line":38,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"filterStack","type":["array"],"help":"","inlineHelp":"","line":15,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offsetX","type":["number"],"help":"","inlineHelp":"","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offsetY","type":["number"],"help":"","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLGraphics.json b/docgen/output/PIXI.WebGLGraphics.json deleted file mode 100644 index b9a2ab27e..000000000 --- a/docgen/output/PIXI.WebGLGraphics.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLGraphics","extends":"","static":true,"constructor":false,"parameters":[],"help":"A set of functions used by the webGL renderer to draw the primitive graphics data"},"consts":[],"methods":{"public":[{"name":"reset","static":false,"returns":null,"help":"","line":852,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"upload","static":false,"returns":null,"help":"","line":862,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"buildCircle","static":true,"returns":null,"help":"Builds a circle to draw","line":429,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object to draw","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buildComplexPoly","static":true,"returns":null,"help":"Builds a complex polygon to draw","line":724,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object containing all the necessary properties","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buildLine","static":true,"returns":null,"help":"Builds a line to draw","line":512,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object containing all the necessary properties","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buildPoly","static":true,"returns":null,"help":"Builds a polygon to draw","line":786,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object containing all the necessary properties","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buildRectangle","static":true,"returns":null,"help":"Builds a rectangle to draw","line":242,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object containing all the necessary properties","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buildRoundedRectangle","static":true,"returns":null,"help":"Builds a rounded rectangle to draw","line":310,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object containing all the necessary properties","optional":false,"default":null},{"name":"webGLData","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"quadraticBezierCurve","static":true,"returns":{"types":["array number"],"help":""},"help":"Calculate the points for a quadratic bezier curve. (helper function..)\\nBased on: https:\/\/stackoverflow.com\/questions\/785097\/how-do-i-implement-a-bezier-curve-in-c","line":383,"public":false,"protected":false,"private":true,"parameters":[{"name":"fromX","type":["number"],"help":"Origin point x","optional":false,"default":null},{"name":"fromY","type":["number"],"help":"Origin point x","optional":false,"default":null},{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderGraphics","static":true,"returns":null,"help":"Renders the graphics object","line":25,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphics","type":["PIXI.Graphics"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"switchMode","static":true,"returns":null,"help":"","line":206,"public":false,"protected":false,"private":true,"parameters":[{"name":"webGL","type":["PIXI.WebGLContext"],"help":"","optional":false,"default":null},{"name":"type","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateGraphics","static":true,"returns":null,"help":"Updates the graphics object","line":93,"public":false,"protected":false,"private":true,"parameters":[{"name":"graphicsData","type":["PIXI.Graphics"],"help":"The graphics object to update","optional":false,"default":null},{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLMaskManager.json b/docgen/output/PIXI.WebGLMaskManager.json deleted file mode 100644 index bae51f0e0..000000000 --- a/docgen/output/PIXI.WebGLMaskManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLMaskManager","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys the mask stack.","line":66,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"popMask","static":false,"returns":null,"help":"Removes the last filter from the filter stack and doesn't return it.","line":55,"public":true,"protected":false,"private":false,"parameters":[{"name":"maskData","type":["array"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"an object containing all the useful parameters","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pushMask","static":false,"returns":null,"help":"Applies the Mask and adds it to the current filter stack.","line":34,"public":true,"protected":false,"private":false,"parameters":[{"name":"maskData","type":["array"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Sets the drawing context to the one given in parameter.","line":22,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLRenderer.json b/docgen/output/PIXI.WebGLRenderer.json deleted file mode 100644 index 434f4c20b..000000000 --- a/docgen/output/PIXI.WebGLRenderer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLRenderer","extends":"","static":false,"constructor":true,"parameters":[{"name":"[width=0]","type":["number"],"help":"the width of the canvas view","optional":false,"default":null},{"name":"[height=0]","type":["number"],"help":"the height of the canvas view","optional":false,"default":null},{"name":"[options]","type":["object"],"help":"The optional renderer parameters","optional":false,"default":null},{"name":"[options.view]","type":["HTMLCanvasElement"],"help":"the canvas to use as a view, optional","optional":false,"default":null},{"name":"[options.transparent=false]","type":["boolean"],"help":"If the render view is transparent, default false","optional":false,"default":null},{"name":"[options.antialias=false]","type":["boolean"],"help":"sets antialias (only applicable in chrome at the moment)","optional":false,"default":null},{"name":"[options.preserveDrawingBuffer=false]","type":["boolean"],"help":"enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context","optional":false,"default":null},{"name":"[options.resolution=1]","type":["number"],"help":"the resolution of the renderer retina would be 2","optional":false,"default":null}],"help":"The WebGLRenderer draws the stage and all its content onto a webGL enabled canvas. This renderer\\nshould be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.\\nSo no need for Sprite Batches or Sprite Clouds.\\nDon't forget to add the view to your DOM or you will not see anything :)"},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Removes everything from the renderer (event listeners, spritebatch, etc...)","line":465,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"initContext","static":false,"returns":null,"help":"","line":231,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"mapBlendModes","static":false,"returns":null,"help":"Maps Pixi blend modes to WebGL blend modes.","line":496,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Renders the stage to its webGL view","line":270,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the Stage element to be rendered","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderDisplayObject","static":false,"returns":null,"help":"Renders a Display Object.","line":340,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The DisplayObject to render","optional":false,"default":null},{"name":"projection","type":["Phaser.Point"],"help":"The projection","optional":false,"default":null},{"name":"buffer","type":["array"],"help":"a standard WebGL buffer","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"Resizes the webGL view to the specified width and height.","line":373,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the webGL view","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the webGL view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateTexture","static":false,"returns":null,"help":"Updates and Creates a WebGL texture for the renderers context.","line":393,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to update","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"handleContextLost","static":false,"returns":null,"help":"Handles a lost webgl context","line":433,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"handleContextRestored","static":false,"returns":null,"help":"Handles a restored webgl context","line":446,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"blendModeManager","type":["PIXI.WebGLBlendModeManager"],"help":"Manages the blendModes","inlineHelp":"","line":199,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clearBeforeRender","type":["boolean"],"help":"This sets if the WebGLRenderer will clear the context texture or not before the new render pass. If true:\\nIf the Stage is NOT transparent, Pixi will clear to alpha (0, 0, 0, 0).\\nIf the Stage is transparent, Pixi will clear to the target Stage's background color.\\nDisable this by setting this to false. For example: if your game has a canvas filling background image, you often don't need this set.","inlineHelp":"","line":87,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"contextLostBound","type":["function"],"help":"","inlineHelp":"","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"contextRestoredBound","type":["function"],"help":"","inlineHelp":"","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterManager","type":["PIXI.WebGLFilterManager"],"help":"Manages the filters","inlineHelp":"","line":185,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the canvas view","inlineHelp":"","line":105,"default":"600","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maskManager","type":["PIXI.WebGLMaskManager"],"help":"Manages the masks using the stencil buffer","inlineHelp":"","line":178,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"","inlineHelp":"","line":155,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preserveDrawingBuffer","type":["boolean"],"help":"The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.","inlineHelp":"","line":75,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"projection","type":["Phaser.Point"],"help":"","inlineHelp":"","line":149,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderSession","type":["object"],"help":"TODO remove","inlineHelp":"","line":206,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the renderer","inlineHelp":"","line":57,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"shaderManager","type":["PIXI.WebGLShaderManager"],"help":"Deals with managing the shader programs and their attribs","inlineHelp":"","line":164,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteBatch","type":["PIXI.WebGLSpriteBatch"],"help":"Manages the rendering of sprites","inlineHelp":"","line":171,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stencilManager","type":["PIXI.WebGLStencilManager"],"help":"Manages the stencil buffer","inlineHelp":"","line":192,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"transparent","type":["boolean"],"help":"Whether the render view is transparent","inlineHelp":"","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"view","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to","inlineHelp":"","line":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the canvas view","inlineHelp":"","line":96,"default":"800","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_contextOptions","type":["object"],"help":"","inlineHelp":"","line":137,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLShaderManager.json b/docgen/output/PIXI.WebGLShaderManager.json deleted file mode 100644 index d981f00c4..000000000 --- a/docgen/output/PIXI.WebGLShaderManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLShaderManager","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this object.","line":140,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setAttribs","static":false,"returns":null,"help":"Takes the attributes given in parameters.","line":78,"public":true,"protected":false,"private":false,"parameters":[{"name":"attribs","type":["array"],"help":"attribs","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Initialises the context and the properties.","line":51,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setShader","static":false,"returns":null,"help":"Sets the current shader.","line":121,"public":true,"protected":false,"private":false,"parameters":[{"name":"shader","type":["any"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"attribState","type":["array"],"help":"","inlineHelp":"","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxAttibs","type":["number"],"help":"","inlineHelp":"","line":16,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stack","type":["array"],"help":"","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tempAttribState","type":["array"],"help":"","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLSpriteBatch.json b/docgen/output/PIXI.WebGLSpriteBatch.json deleted file mode 100644 index 939a12b2b..000000000 --- a/docgen/output/PIXI.WebGLSpriteBatch.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLSpriteBatch","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"begin","static":false,"returns":null,"help":"","line":168,"public":true,"protected":false,"private":false,"parameters":[{"name":"renderSession","type":["object"],"help":"The RenderSession object","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys the SpriteBatch.","line":594,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"end","static":false,"returns":null,"help":"","line":179,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"flush","static":false,"returns":null,"help":"Renders the content and empties the current batch.","line":423,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"","line":188,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["PIXI.Sprite"],"help":"the sprite to render when using this spritebatch","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderBatch","static":false,"returns":null,"help":"","line":548,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"","optional":false,"default":null},{"name":"size","type":["number"],"help":"","optional":false,"default":null},{"name":"startIndex","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderTilingSprite","static":false,"returns":null,"help":"Renders a TilingSprite using the spriteBatch.","line":303,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["PIXI.TilingSprite"],"help":"the tilingSprite to render","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"","line":584,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"","line":575,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blendModes","type":["array"],"help":"","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentBaseTexture","type":["PIXI.BaseTexture"],"help":"","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentBatchSize","type":["number"],"help":"","inlineHelp":"","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultShader","type":["PIXI.AbstractFilter"],"help":"","inlineHelp":"","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":91,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"drawing","type":["boolean"],"help":"","inlineHelp":"","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"indices","type":["Uint16Array"],"help":"Holds the indices","inlineHelp":"","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lastIndexCount","type":["number"],"help":"","inlineHelp":"","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shaders","type":["array"],"help":"","inlineHelp":"","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"size","type":["number"],"help":"The number of images in the SpriteBatch before it flushes","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sprites","type":["array"],"help":"","inlineHelp":"","line":115,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textures","type":["array"],"help":"","inlineHelp":"","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertSize","type":["number"],"help":"","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"vertices","type":["Float32Array"],"help":"Holds the vertices","inlineHelp":"","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.WebGLStencilManager.json b/docgen/output/PIXI.WebGLStencilManager.json deleted file mode 100644 index 5b097b526..000000000 --- a/docgen/output/PIXI.WebGLStencilManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.WebGLStencilManager","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"bindGraphics","static":false,"returns":null,"help":"TODO this does not belong here!","line":128,"public":true,"protected":false,"private":false,"parameters":[{"name":"graphics","type":["PIXI.Graphics"],"help":"","optional":false,"default":null},{"name":"webGLData","type":["array"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys the mask stack.","line":290,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"popStencil","static":false,"returns":null,"help":"","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"graphics","type":["PIXI.Graphics"],"help":"","optional":false,"default":null},{"name":"webGLData","type":["array"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pushMask","static":false,"returns":null,"help":"Applies the Mask and adds it to the current filter stack.","line":36,"public":true,"protected":false,"private":false,"parameters":[{"name":"graphics","type":["PIXI.Graphics"],"help":"","optional":false,"default":null},{"name":"webGLData","type":["array"],"help":"","optional":false,"default":null},{"name":"renderSession","type":["object"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setContext","static":false,"returns":null,"help":"Sets the drawing context to the one given in parameter.","line":23,"public":true,"protected":false,"private":false,"parameters":[{"name":"gl","type":["PIXI.WebGLContext"],"help":"the current WebGL drawing context","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/PIXI.autoDetectRenderer.json b/docgen/output/PIXI.autoDetectRenderer.json deleted file mode 100644 index 3d8ba570f..000000000 --- a/docgen/output/PIXI.autoDetectRenderer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"PIXI.autoDetectRenderer","extends":"","static":true,"constructor":false,"parameters":[{"name":"width=800","type":["number"],"help":"the width of the renderers view","optional":false,"default":null},{"name":"height=600","type":["number"],"help":"the height of the renderers view","optional":false,"default":null},{"name":"[options]","type":["object"],"help":"The optional renderer parameters","optional":false,"default":null},{"name":"[options.view]","type":["HTMLCanvasElement"],"help":"the canvas to use as a view, optional","optional":false,"default":null},{"name":"[options.transparent=false]","type":["boolean"],"help":"If the render view is transparent, default false","optional":false,"default":null},{"name":"[options.antialias=false]","type":["boolean"],"help":"sets antialias (only applicable in chrome at the moment)","optional":false,"default":null},{"name":"[options.preserveDrawingBuffer=false]","type":["boolean"],"help":"enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context","optional":false,"default":null},{"name":"[options.resolution=1]","type":["number"],"help":"the resolution of the renderer retina would be 2","optional":false,"default":null}],"help":"This helper function will automatically detect which renderer you should be using.\\nWebGL is the preferred renderer as it is a lot faster. If webGL is not supported by\\nthe browser then this function will return a canvas renderer\\n"},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Animation.json b/docgen/output/Phaser.Animation.json deleted file mode 100644 index 1a1326b22..000000000 --- a/docgen/output/Phaser.Animation.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Animation","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"parent","type":["Phaser.Sprite"],"help":"A reference to the owner of this Animation.","optional":false,"default":null},{"name":"name","type":["string"],"help":"The unique name for this animation, used in playback commands.","optional":false,"default":null},{"name":"frameData","type":["Phaser.FrameData"],"help":"The FrameData object that contains all frames used by this Animation.","optional":false,"default":null},{"name":"frames","type":["array number","array string"],"help":"An array of numbers or strings indicating which frames to play in which order.","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The speed at which the animation should play. The speed is given in frames per second.","optional":true,"default":"60"},{"name":"loop","type":["boolean"],"help":"Whether or not the animation is looped or just plays once.","optional":true,"default":"false"},{"name":"loop","type":["boolean"],"help":"Should this animation loop when it reaches the end or play through once.","optional":false,"default":null}],"help":"An Animation instance contains a single animation and the controls to play it.\\nIt is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite."},"consts":[],"methods":{"public":[{"name":"complete","static":false,"returns":null,"help":"Called internally when the animation finishes playback.\\nSets the isPlaying and isFinished states and dispatches the onAnimationComplete event if it exists on the parent and local onComplete event.","line":575,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Cleans up this animation ready for deletion. Nulls all values and references.","line":546,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"generateFrameNames","static":true,"returns":{"types":["array"],"help":"An array of framenames."},"help":"Really handy function for when you are creating arrays of animation data but it's using frame names and not numbers.\\nFor example imagine you've got 30 frames named: 'explosion_0001-large' to 'explosion_0030-large'\\nYou could use this function to generate those by doing: Phaser.Animation.generateFrameNames('explosion_', 1, 30, '-large', 4);","line":746,"public":true,"protected":false,"private":false,"parameters":[{"name":"prefix","type":["string"],"help":"The start of the filename. If the filename was 'explosion_0001-large' the prefix would be 'explosion_'.","optional":false,"default":null},{"name":"start","type":["number"],"help":"The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.","optional":false,"default":null},{"name":"stop","type":["number"],"help":"The number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.","optional":false,"default":null},{"name":"suffix","type":["string"],"help":"The end of the filename. If the filename was 'explosion_0001-large' the prefix would be '-large'.","optional":true,"default":"''"},{"name":"zeroPad","type":["number"],"help":"The number of zeroes to pad the min and max values with. If your frames are named 'explosion_0001' to 'explosion_0034' then the zeroPad is 4.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"next","static":false,"returns":null,"help":"Advances by the given number of frames in the Animation, taking the loop value into consideration.","line":436,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of frames to advance.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"onPause","static":false,"returns":null,"help":"Called when the Game enters a paused state.","line":333,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onResume","static":false,"returns":null,"help":"Called when the Game resumes from a paused state.","line":347,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"- A reference to this Animation instance."},"help":"Plays this animation.","line":165,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"previous","static":false,"returns":null,"help":"Moves backwards the given number of frames in the Animation, taking the loop value into consideration.","line":485,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of frames to move back.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"restart","static":false,"returns":null,"help":"Sets this animation back to the first frame and restarts the animation.","line":219,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setFrame","static":false,"returns":null,"help":"Sets this animations playback to a given frame with the given ID.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string","number"],"help":"The identifier of the frame to set. Can be the name of the frame, the sprite index of the frame, or the animation-local frame index.","optional":true,"default":null},{"name":"useLocalFrameIndex","type":["boolean"],"help":"If you provide a number for frameId, should it use the numeric indexes of the frameData, or the 0-indexed frame index local to the animation.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops playback of this animation and set it to a finished state. If a resetFrame is provided it will stop playback and set frame to the first in the animation.\\nIf `dispatchComplete` is true it will dispatch the complete events, otherwise they'll be ignored.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"resetFrame","type":["boolean"],"help":"If true after the animation stops the currentFrame value will be set to the first frame in this animation.","optional":true,"default":"false"},{"name":"dispatchComplete","type":["boolean"],"help":"Dispatch the Animation.onComplete and parent.onAnimationComplete events?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates this animation. Called automatically by the AnimationManager.","line":361,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateFrameData","static":false,"returns":null,"help":"Changes the FrameData object this Animation is using.","line":534,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameData","type":["Phaser.FrameData"],"help":"The FrameData object that contains all frames used by this Animation.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"currentFrame","type":["Phaser.Frame"],"help":"","inlineHelp":"The currently displayed frame of the Animation.","line":125,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"delay","type":["number"],"help":"","inlineHelp":"The delay in ms between each frame of the Animation, based on the given frameRate.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableUpdate","type":["boolean"],"help":"","inlineHelp":"Gets or sets if this animation will dispatch the onUpdate events upon changing frame.","line":708,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":647,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameTotal","type":["number"],"help":"","inlineHelp":"The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.","line":635,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isFinished","type":["boolean"],"help":"","inlineHelp":"The finished state of the Animation. Set to true once playback completes, false during playback.","line":80,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isPaused","type":["boolean"],"help":"","inlineHelp":"The paused state of the Animation.","line":92,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isPlaying","type":["boolean"],"help":"","inlineHelp":"The playing state of the Animation. Set to false once playback completes, true during playback.","line":86,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"killOnComplete","type":["boolean"],"help":"","inlineHelp":"Should the parent of this Animation be killed when the animation completes?","line":74,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"loop","type":["boolean"],"help":"","inlineHelp":"The loop state of the Animation.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loopCount","type":["number"],"help":"","inlineHelp":"The number of times the animation has looped since it was last started.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Animation.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when this Animation completes playback. If the animation is set to loop this is never fired, listen for onAnimationLoop instead.","line":141,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoop","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when this Animation loops.","line":146,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onStart","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when this Animation starts playback.","line":130,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpdate","type":["Phaser.Signal","null"],"help":"","inlineHelp":"This event is dispatched when the Animation changes frame. By default this event is disabled due to its intensive nature. Enable it with: `Animation.enableUpdate = true`.","line":136,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"","inlineHelp":"Gets and sets the paused state of this Animation.","line":600,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"speed","type":["number"],"help":"","inlineHelp":"Gets or sets the current speed of the animation in frames per second. Changing this in a playing animation will take effect from the next frame. Minimum value is 1.","line":685,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_frameData","type":["Phaser.FrameData"],"help":"","inlineHelp":"The FrameData the Animation uses.","line":41,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameDiff","type":["number"],"help":"","inlineHelp":"","line":113,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameIndex","type":["number"],"help":"","inlineHelp":"","line":106,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameSkip","type":["number"],"help":"","inlineHelp":"","line":120,"default":"1","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frames","type":["array"],"help":"","inlineHelp":"","line":52,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_parent","type":["Phaser.Sprite"],"help":"","inlineHelp":"A reference to the parent Sprite that owns this Animation.","line":35,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pauseStartTime","type":["boolean"],"help":"","inlineHelp":"The time the animation paused.","line":99,"default":"0","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.AnimationManager.json b/docgen/output/Phaser.AnimationManager.json deleted file mode 100644 index 270d10ce1..000000000 --- a/docgen/output/Phaser.AnimationManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.AnimationManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"A reference to the Game Object that owns this AnimationManager.","optional":false,"default":null}],"help":"The Animation Manager is used to add, play and update Phaser Animations.\\nAny Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Animation"],"help":"The Animation object that was created."},"help":"Adds a new animation under the given key. Optionally set the frames, frame rate and loop.\\nAnimations added in this way are played back with the play function.","line":179,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The unique (within this Sprite) name for the animation, i.e. \"run\", \"fire\", \"walk\".","optional":false,"default":null},{"name":"frames","type":["array"],"help":"An array of numbers\/strings that correspond to the frames to add to this animation and in which order. e.g. [1, 2, 3] or ['run0', 'run1', run2]). If null then all frames will be used.","optional":true,"default":"null"},{"name":"frameRate","type":["number"],"help":"The speed at which the animation should play. The speed is given in frames per second.","optional":true,"default":"60"},{"name":"loop","type":["boolean"],"help":"Whether or not the animation is looped or just plays once.","optional":true,"default":"false"},{"name":"useNumericIndex","type":["boolean"],"help":"Are the given frames using numeric indexes (default) or strings?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys all references this AnimationManager contains.\\nIterates through the list of animations stored in this manager and calls destroy on each of them.","line":434,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getAnimation","static":false,"returns":{"types":["Phaser.Animation"],"help":"The Animation instance, if found, otherwise null."},"help":"Returns an animation that was previously added by name.","line":397,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be returned, e.g. \"fire\".","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"next","static":false,"returns":null,"help":"Advances by the given number of frames in the current animation, taking the loop value into consideration.","line":364,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of frames to advance.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"A reference to playing Animation instance."},"help":"Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()\\nIf the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.","line":275,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be played, e.g. \"fire\", \"walk\", \"jump\".","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"previous","static":false,"returns":null,"help":"Moves backwards the given number of frames in the current animation, taking the loop value into consideration.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of frames to move back.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"refreshFrame","static":false,"returns":null,"help":"Refreshes the current frame data back to the parent Sprite and also resets the texture data.","line":416,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop playback of an animation. If a name is given that specific animation is stopped, otherwise the current animation is stopped.\\nThe currentAnim property of the AnimationManager is automatically set to the animation given.","line":312,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be stopped, e.g. \"fire\". If none is given the currently running animation is stopped.","optional":true,"default":"null"},{"name":"resetFrame","type":["boolean"],"help":"When the animation is stopped should the currentFrame be set to the first frame of the animation (true) or paused on the last frame displayed (false)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"validateFrames","static":false,"returns":{"types":["boolean"],"help":"True if all given Frames are valid, otherwise false."},"help":"Check whether the frames in the given array are valid and exist.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"An array of frames to be validated.","optional":false,"default":null},{"name":"useNumericIndex","type":["boolean"],"help":"Validate the frames based on their numeric index (true) or string index (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"update","static":false,"returns":{"types":["boolean"],"help":"True if a new animation frame has been set, otherwise false."},"help":"The main update function is called by the Sprites update loop. It's responsible for updating animation frames and firing related events.","line":341,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"copyFrameData","static":false,"returns":{"types":["boolean"],"help":"Returns `true` if the frame data was loaded successfully, otherwise `false`"},"help":"Loads FrameData into the internal temporary vars and resets the frame index to zero.\\nThis is called automatically when a new Sprite is created.","line":133,"public":false,"protected":false,"private":true,"parameters":[{"name":"frameData","type":["Phaser.FrameData"],"help":"The FrameData set to load.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"The frame to default to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"loadFrameData","static":false,"returns":{"types":["boolean"],"help":"Returns `true` if the frame data was loaded successfully, otherwise `false`"},"help":"Loads FrameData into the internal temporary vars and resets the frame index to zero.\\nThis is called automatically when a new Sprite is created.","line":84,"public":false,"protected":false,"private":true,"parameters":[{"name":"frameData","type":["Phaser.FrameData"],"help":"The FrameData set to load.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"The frame to default to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"currentAnim","type":["Phaser.Animation"],"help":"","inlineHelp":"The currently displayed animation, if any.","line":37,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentFrame","type":["Phaser.Frame"],"help":"","inlineHelp":"The currently displayed Frame of animation, if any.","line":31,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":526,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameData","type":["Phaser.FrameData"],"help":"","inlineHelp":"The current animations FrameData.","line":463,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame name and updates the Texture Cache for display.","line":565,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameTotal","type":["number"],"help":"","inlineHelp":"The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.","line":476,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isLoaded","type":["boolean"],"help":"","inlineHelp":"Set to true once animation data has been loaded.","line":49,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"Gets the current animation name, if set.","line":509,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"","inlineHelp":"Gets and sets the paused state of the current animation.","line":489,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"A reference to the parent Sprite that owns this AnimationManager.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"updateIfVisible","type":["boolean"],"help":"","inlineHelp":"Should the animation data continue to update even if the Sprite.visible is set to false.","line":43,"default":"true","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_anims","type":["object"],"help":"","inlineHelp":"An internal object that stores all of the Animation instances.","line":62,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameData","type":["Phaser.FrameData"],"help":"","inlineHelp":"A temp. var for holding the currently playing Animations FrameData.","line":56,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_outputFrames","type":["object"],"help":"","inlineHelp":"An internal object to help avoid gc.","line":68,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.AnimationParser.json b/docgen/output/Phaser.AnimationParser.json deleted file mode 100644 index 1dfa671b5..000000000 --- a/docgen/output/Phaser.AnimationParser.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.AnimationParser","extends":"","static":true,"constructor":false,"parameters":[],"help":"Responsible for parsing sprite sheet and JSON data into the internal FrameData format that Phaser uses for animations."},"consts":[],"methods":{"public":[{"name":"JSONData","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A FrameData object containing the parsed frames."},"help":"Parse the JSON data and extract the animation frame data from it.","line":108,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"json","type":["object"],"help":"The JSON data from the Texture Atlas. Must be in Array format.","optional":false,"default":null},{"name":"cacheKey","type":["string"],"help":"The Game.Cache asset key of the texture image.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"JSONDataHash","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A FrameData object containing the parsed frames."},"help":"Parse the JSON data and extract the animation frame data from it.","line":173,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"json","type":["object"],"help":"The JSON data from the Texture Atlas. Must be in JSON Hash format.","optional":false,"default":null},{"name":"cacheKey","type":["string"],"help":"The Game.Cache asset key of the texture image.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"XMLData","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A FrameData object containing the parsed frames."},"help":"Parse the XML data and extract the animation frame data from it.","line":241,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"xml","type":["object"],"help":"The XML data from the Texture Atlas. Must be in Starling XML format.","optional":false,"default":null},{"name":"cacheKey","type":["string"],"help":"The Game.Cache asset key of the texture image.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"spriteSheet","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A FrameData object containing the parsed frames."},"help":"Parse a Sprite Sheet and extract the animation frame data from it.","line":28,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.Cache asset key of the Sprite Sheet image.","optional":false,"default":null},{"name":"frameWidth","type":["number"],"help":"The fixed width of each frame of the animation.","optional":false,"default":null},{"name":"frameHeight","type":["number"],"help":"The fixed height of each frame of the animation.","optional":false,"default":null},{"name":"frameMax","type":["number"],"help":"The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means \"extract all frames\".","optional":true,"default":"-1"},{"name":"margin","type":["number"],"help":"If the frames have been drawn with a margin, specify the amount here.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"If the frames have been drawn with spacing between them, specify the amount here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.ArrayList.json b/docgen/output/Phaser.ArrayList.json deleted file mode 100644 index babe05226..000000000 --- a/docgen/output/Phaser.ArrayList.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.ArrayList","extends":"","static":false,"constructor":true,"parameters":[],"help":"A set data structure. Allows items to add themselves to and remove themselves from the set. Items can only exist once in the set."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["object"],"help":"The child that was added."},"help":"Adds a new element to this list. The item can only exist in the list once.","line":43,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to add to this list. Can be a Phaser.Sprite or any other object you need to quickly iterate through.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all members of this list, using the member as the context for the callback.\\nThe function must exist on the member.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function to call.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"exists","static":false,"returns":{"types":["boolean"],"help":"True if the child is found in the list, otherwise false."},"help":"Checks for the child within this list.","line":75,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to get the list index for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if not found."},"help":"Gets the index of the child in the list, or -1 if it isn't in the list.","line":62,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to get the list index for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":{"types":["object"],"help":"child - The child that was removed."},"help":"Removes the given element from this list if it exists.","line":100,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The child to be removed from the list.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the list length and drops all items in the list.","line":86,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setAll","static":false,"returns":null,"help":"Sets the property `key` to the given value on all members of this list.","line":120,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["object"],"help":"The object on the child to set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value to set the property to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"first","type":["object"],"help":"Resets the cursor to the first item in the list and returns it.","inlineHelp":"The first item in the list.","line":166,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"list","type":["array"],"help":"","inlineHelp":"The list.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"next","type":["object"],"help":"Gets the next item in the list and returns it, advancing the cursor.","inlineHelp":"Advanced the cursor and return.","line":191,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["number"],"help":"","inlineHelp":"Current cursor position.","line":25,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"total","type":["number"],"help":"","inlineHelp":"Number of objects in the list.","line":19,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.AudioSprite.json b/docgen/output/Phaser.AudioSprite.json deleted file mode 100644 index 0c15cf1ba..000000000 --- a/docgen/output/Phaser.AudioSprite.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.AudioSprite","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Reference to the current game instance.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"help":"Audio Sprites are a combination of audio files and a JSON configuration.\\nThe JSON follows the format of that created by https:\/\/github.com\/tonistiigi\/audiosprite"},"consts":[],"methods":{"public":[{"name":"get","static":false,"returns":{"types":["Phaser.Sound"],"help":"The sound instance."},"help":"Get a sound with the given name.","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Sound"],"help":"This sound instance."},"help":"Play a sound with the given name.","line":92,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to play","optional":true,"default":null},{"name":"volume","type":["number"],"help":"Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop a sound with the given name.","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to stop. If none is given it will stop all sounds in the audio sprite.","optional":true,"default":"''"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"autoplay","type":["boolean"],"help":"Is a sound set to autoplay or not?","inlineHelp":"","line":48,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoplayKey","type":["string"],"help":"If a sound is set to auto play, this holds the marker key of it.","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"config","type":["object"],"help":"JSON audio atlas object.","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running Game.","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"Asset key for the Audio Sprite.","inlineHelp":"","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sounds","type":["object"],"help":"An object containing the Phaser.Sound objects for the Audio Sprite.","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.BitmapData.json b/docgen/output/Phaser.BitmapData.json deleted file mode 100644 index 807c5dea9..000000000 --- a/docgen/output/Phaser.BitmapData.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.BitmapData","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Internal Phaser reference key for the render texture.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the BitmapData in pixels.","optional":true,"default":"256"},{"name":"height","type":["number"],"help":"The height of the BitmapData in pixels.","optional":true,"default":"256"}],"help":"A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.\\nA single BitmapData can be used as the texture for one or many Images\/Sprites.\\nSo if you need to dynamically create a Sprite texture then they are a good choice."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Updates the given objects so that they use this BitmapData as their texture. This will replace any texture they will currently have set.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["Phaser.Sprite","array Phaser.Sprite","Phaser.Image","array Phaser.Image"],"help":"Either a single Sprite\/Image or an Array of Sprites\/Images.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addToWorld","static":false,"returns":{"types":["Phaser.Image"],"help":"The newly added Image object."},"help":"Creates a new Phaser.Image object, assigns this BitmapData to be its texture, adds it to the world then returns it.","line":943,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to place the Image at.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate to place the Image at.","optional":true,"default":"0"},{"name":"anchorX","type":["number"],"help":"Set the x anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.","optional":true,"default":"0"},{"name":"anchorY","type":["number"],"help":"Set the y anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.","optional":true,"default":"0"},{"name":"scaleX","type":["number"],"help":"The horizontal scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on.","optional":true,"default":"1"},{"name":"scaleY","type":["number"],"help":"The vertical scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"alphaMask","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Draws the image onto this BitmapData using an image as an alpha mask.","line":1229,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapData","Image","HTMLCanvasElement","string"],"help":"The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.","optional":false,"default":null},{"name":"mask","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapData","Image","HTMLCanvasElement","string"],"help":"The object to be used as the mask. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself. If you don't provide a mask it will use this BitmapData as the mask.","optional":true,"default":null},{"name":"sourceRect","type":["Phaser.Rectangle"],"help":"A Rectangle where x\/y define the coordinates to draw the Source image to and width\/height define the size.","optional":true,"default":null},{"name":"maskRect","type":["Phaser.Rectangle"],"help":"A Rectangle where x\/y define the coordinates to draw the Mask image to and width\/height define the size.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"blendAdd","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'lighter'","line":1561,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendColor","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'color'","line":1743,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendColorBurn","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'color-burn'","line":1652,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendColorDodge","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'color-dodge'","line":1639,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDarken","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'darken'","line":1613,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDestinationAtop","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'destination-atop'","line":1535,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDestinationIn","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'destination-in'","line":1509,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDestinationOut","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'destination-out'","line":1522,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDestinationOver","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'destination-over'","line":1496,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendDifference","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'difference'","line":1691,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendExclusion","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'exclusion'","line":1704,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendHardLight","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'hard-light'","line":1665,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendHue","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'hue'","line":1717,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendLighten","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'lighten'","line":1626,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendLuminosity","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'luminosity'","line":1756,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendMultiply","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'multiply'","line":1574,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendOverlay","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'overlay'","line":1600,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendReset","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Resets the blend mode (effectively sets it to 'source-over')","line":1431,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSaturation","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'saturation'","line":1730,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendScreen","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'screen'","line":1587,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSoftLight","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'soft-light'","line":1678,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSourceAtop","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'source-atop'","line":1483,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSourceIn","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'source-in'","line":1457,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSourceOut","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'source-out'","line":1470,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendSourceOver","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'source-over'","line":1444,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"blendXor","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the blend mode to 'xor'","line":1548,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"circle","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Draws a filled Circle to the BitmapData at the given x, y coordinates and radius in size.","line":1340,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to draw the Circle at. This is the center of the circle.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to draw the Circle at. This is the center of the circle.","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the Circle in pixels. The radius is half the diameter.","optional":false,"default":null},{"name":"fillStyle","type":["string"],"help":"If set the context fillStyle will be set to this value before the circle is drawn.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clear","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Clears the BitmapData context using a clearRect.","line":281,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"cls","static":false,"returns":null,"help":"Clears the BitmapData context using a clearRect.","line":274,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"copy","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Copies a rectangular area from the source object to this BitmapData. If you give `null` as the source it will copy from itself.\\nYou can optionally resize, translate, rotate, scale, alpha or blend as it's drawn.\\nAll rotation, scaling and drawing takes place around the regions center point by default, but can be changed with the anchor parameters.\\nNote that the source image can also be this BitmapData, which can create some interesting effects.\\n\\nThis method has a lot of parameters for maximum control.\\nYou can use the more friendly methods like `copyRect` and `draw` to avoid having to remember them all.","line":986,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapData","Image","HTMLCanvasElement","string"],"help":"The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.","optional":true,"default":null},{"name":"x","type":["number"],"help":"The x coordinate representing the top-left of the region to copy from the source image.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate representing the top-left of the region to copy from the source image.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The width of the region to copy from the source image. If not specified it will use the full source image width.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The height of the region to copy from the source image. If not specified it will use the full source image height.","optional":true,"default":null},{"name":"tx","type":["number"],"help":"The x coordinate to translate to before drawing. If not specified it will default to the `x` parameter.","optional":true,"default":null},{"name":"ty","type":["number"],"help":"The y coordinate to translate to before drawing. If not specified it will default to the `y` parameter.","optional":true,"default":null},{"name":"newWidth","type":["number"],"help":"The new width of the block being copied. If not specified it will default to the `width` parameter.","optional":true,"default":null},{"name":"newHeight","type":["number"],"help":"The new height of the block being copied. If not specified it will default to the `height` parameter.","optional":true,"default":null},{"name":"rotate","type":["number"],"help":"The angle in radians to rotate the block to before drawing. Rotation takes place around the center by default, but can be changed with the `anchor` parameters.","optional":true,"default":"0"},{"name":"anchorX","type":["number"],"help":"The anchor point around which the block is rotated and scaled. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.","optional":true,"default":"0"},{"name":"anchorY","type":["number"],"help":"The anchor point around which the block is rotated and scaled. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.","optional":true,"default":"0"},{"name":"scaleX","type":["number"],"help":"The horizontal scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on.","optional":true,"default":"1"},{"name":"scaleY","type":["number"],"help":"The vertical scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on.","optional":true,"default":"1"},{"name":"alpha","type":["number"],"help":"The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque.","optional":true,"default":"1"},{"name":"blendMode","type":["number"],"help":"The composite blend mode that will be used when drawing. The default is no blend mode at all.","optional":true,"default":"null"},{"name":"roundPx","type":["boolean"],"help":"Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"copyRect","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Copies the area defined by the Rectangle parameter from the source image to this BitmapData at the given location.","line":1163,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapData","Image","string"],"help":"The Image to copy from. If you give a string it will try and find the Image in the Game.Cache.","optional":false,"default":null},{"name":"area","type":["Phaser.Rectangle"],"help":"The Rectangle region to copy from the source image.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The destination x coordinate to copy the image to.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The destination y coordinate to copy the image to.","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque.","optional":true,"default":"1"},{"name":"blendMode","type":["number"],"help":"The composite blend mode that will be used when drawing. The default is no blend mode at all.","optional":true,"default":"null"},{"name":"roundPx","type":["boolean"],"help":"Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"draw","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Draws the given Phaser.Sprite, Phaser.Image or Phaser.Text to this BitmapData at the coordinates specified.\\nYou can use the optional width and height values to 'stretch' the sprite as it is drawn. This uses drawImage stretching, not scaling.\\nWhen drawing it will take into account the Sprites rotation, scale and alpha values.","line":1184,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Image","Phaser.Text"],"help":"The Sprite, Image or Text object to draw onto this BitmapData.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to translate to before drawing. If not specified it will default to `source.x`.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate to translate to before drawing. If not specified it will default to `source.y`.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The new width of the Sprite being copied. If not specified it will default to `source.width`.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The new height of the Sprite being copied. If not specified it will default to `source.height`.","optional":true,"default":null},{"name":"blendMode","type":["number"],"help":"The composite blend mode that will be used when drawing the Sprite. The default is no blend mode at all.","optional":true,"default":"null"},{"name":"roundPx","type":["boolean"],"help":"Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"extract","static":false,"returns":null,"help":"Scans this BitmapData for all pixels matching the given r,g,b values and then draws them into the given destination BitmapData.\\nThe original BitmapData remains unchanged.\\nThe destination BitmapData must be large enough to receive all of the pixels that are scanned unless the 'resize' parameter is true.\\nAlthough the destination BitmapData is returned from this method, it's actually modified directly in place, meaning this call is perfectly valid:\\n`picture.extract(mask, r, g, b)`\\nYou can specify optional r2, g2, b2 color values. If given the pixel written to the destination bitmap will be of the r2, g2, b2 color.\\nIf not given it will be written as the same color it was extracted. You can provide one or more alternative colors, allowing you to tint\\nthe color during extraction.","line":1275,"public":true,"protected":false,"private":false,"parameters":[{"name":"destination","type":["Phaser.BitmapData"],"help":"The BitmapData that the extracted pixels will be drawn to.","optional":false,"default":null},{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 255 that the new pixel will be drawn at.","optional":true,"default":"255"},{"name":"resize","type":["boolean"],"help":"Should the destination BitmapData be resized to match this one before the pixels are copied?","optional":true,"default":"false"},{"name":"r2","type":["number"],"help":"An alternative red color component to be written to the destination, in the range 0 - 255.","optional":true,"default":null},{"name":"g2","type":["number"],"help":"An alternative green color component to be written to the destination, in the range 0 - 255.","optional":true,"default":null},{"name":"b2","type":["number"],"help":"An alternative blue color component to be written to the destination, in the range 0 - 255.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fill","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Fills the BitmapData with the given color.","line":301,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"a","type":["number"],"help":"The alpha color value, between 0 and 1.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"A Rectangle whose dimensions encompass the full extent of non-transparent pixels in this BitmapData."},"help":"Scans the BitmapData and calculates the bounds. This is a rectangle that defines the extent of all non-transparent pixels.\\nThe rectangle returned will extend from the top-left of the image to the bottom-right, exluding transparent pixels.","line":911,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"If provided this Rectangle object will be populated with the bounds, otherwise a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFirstPixel","static":false,"returns":{"types":["object"],"help":"Returns an object containing the colour of the pixel in the `r`, `g` and `b` properties and the location in the `x` and `y` properties."},"help":"Scans the BitmapData, pixel by pixel, until it encounters a pixel that isn't transparent (i.e. has an alpha value > 0).\\nIt then stops scanning and returns an object containing the colour of the pixel in r, g and b properties and the location in the x and y properties.\\n\\nThe direction parameter controls from which direction it should start the scan:\\n\\n0 = top to bottom\\n1 = bottom to top\\n2 = left to right\\n3 = right to left","line":835,"public":true,"protected":false,"private":false,"parameters":[{"name":"direction","type":["number"],"help":"The direction in which to scan for the first pixel. 0 = top to bottom, 1 = bottom to top, 2 = left to right and 3 = right to left.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"getPixel","static":false,"returns":{"types":["object"],"help":"An object with the red, green, blue and alpha values set in the r, g, b and a properties."},"help":"Get the color of a specific pixel in the context into a color object.\\nIf you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,\\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","line":748,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 4 properties will be created: r, g, b and a. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getPixel32","static":false,"returns":{"types":["number"],"help":"A native color value integer (format: 0xAARRGGBB)"},"help":"Get the color of a specific pixel including its alpha value.\\nIf you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,\\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.\\nNote that on little-endian systems the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA.","line":779,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getPixelRGB","static":false,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Get the color of a specific pixel including its alpha value as a color object containing r,g,b,a and rgba properties.\\nIf you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,\\notherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.","line":801,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.","optional":true,"default":null},{"name":"hsl","type":["boolean"],"help":"Also convert the rgb values into hsl?","optional":true,"default":"false"},{"name":"hsv","type":["boolean"],"help":"Also convert the rgb values into hsv?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"getPixels","static":false,"returns":{"types":["ImageData"],"help":"Returns a ImageData object containing a Uint8ClampedArray data property."},"help":"Gets all the pixels from the region specified by the given Rectangle object.","line":814,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"The Rectangle region to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTransform","static":false,"returns":{"types":["object"],"help":"A JavaScript object containing all of the properties BitmapData needs for transforms."},"help":"Gets a JavaScript object that has 6 properties set that are used by BitmapData in a transform.","line":1797,"public":true,"protected":false,"private":false,"parameters":[{"name":"translateX","type":["number"],"help":"The x translate value.","optional":false,"default":null},{"name":"translateY","type":["number"],"help":"The y translate value.","optional":false,"default":null},{"name":"scaleX","type":["number"],"help":"The scale x value.","optional":false,"default":null},{"name":"scaleY","type":["number"],"help":"The scale y value.","optional":false,"default":null},{"name":"skewX","type":["number"],"help":"The skew x value.","optional":false,"default":null},{"name":"skewY","type":["number"],"help":"The skew y value.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"load","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Takes the given Game Object, resizes this BitmapData to match it and then draws it into this BitmapDatas canvas, ready for further processing.\\nThe source game object is not modified by this operation.\\nIf the source object uses a texture as part of a Texture Atlas or Sprite Sheet, only the current frame will be used for sizing.\\nIf a string is given it will assume it's a cache key and look in Phaser.Cache for an image key matching the string.","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapData","Image","HTMLCanvasElement","string"],"help":"The object that will be used to populate this BitmapData. If you give a string it will try and find the Image in the Game.Cache first.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processPixel","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Scans through the area specified in this BitmapData and sends the color for every pixel to the given callback along with its x and y coordinates.\\nWhatever value the callback returns is set as the new color for that pixel, unless it returns the same color, in which case it's skipped.\\nNote that the format of the color received will be different depending on if the system is big or little endian.\\nIt is expected that your callback will deal with endianess. If you'd rather Phaser did it then use processPixelRGB instead.\\nThe callback will also be sent the pixels x and y coordinates respectively.","line":467,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback that will be sent each pixel color to be processed.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback will be called.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the top-left of the region to process from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of the top-left of the region to process from.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The width of the region to process.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The height of the region to process.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processPixelRGB","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Scans through the area specified in this BitmapData and sends a color object for every pixel to the given callback.\\nThe callback will be sent a color object with 6 properties: `{ r: number, g: number, b: number, a: number, color: number, rgba: string }`.\\nWhere r, g, b and a are integers between 0 and 255 representing the color component values for red, green, blue and alpha.\\nThe `color` property is an Int32 of the full color. Note the endianess of this will change per system.\\nThe `rgba` property is a CSS style rgba() string which can be used with context.fillStyle calls, among others.\\nThe callback will also be sent the pixels x and y coordinates respectively.\\nThe callback must return either `false`, in which case no change will be made to the pixel, or a new color object.\\nIf a new color object is returned the pixel will be set to the r, g, b and a color values given within it.","line":412,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback that will be sent each pixel color object to be processed.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback will be called.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the top-left of the region to process from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of the top-left of the region to process from.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The width of the region to process.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The height of the region to process.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rect","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Draws a filled Rectangle to the BitmapData at the given x, y coordinates and width \/ height in size.","line":1317,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the top-left of the Rectangle.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the top-left of the Rectangle.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the Rectangle.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the Rectangle.","optional":false,"default":null},{"name":"fillStyle","type":["string"],"help":"If set the context fillStyle will be set to this value before the rect is drawn.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"If the game is running in WebGL this will push the texture up to the GPU if it's dirty.\\nThis is called automatically if the BitmapData is being used by a Sprite, otherwise you need to remember to call it in your render function.\\nIf you wish to suppress this functionality set BitmapData.disableTextureUpload to `true`.","line":1413,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"replaceRGB","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Replaces all pixels matching one color with another. The color values are given as two sets of RGBA values.\\nAn optional region parameter controls if the replacement happens in just a specific area of the BitmapData or the entire thing.","line":521,"public":true,"protected":false,"private":false,"parameters":[{"name":"r1","type":["number"],"help":"The red color value to be replaced. Between 0 and 255.","optional":false,"default":null},{"name":"g1","type":["number"],"help":"The green color value to be replaced. Between 0 and 255.","optional":false,"default":null},{"name":"b1","type":["number"],"help":"The blue color value to be replaced. Between 0 and 255.","optional":false,"default":null},{"name":"a1","type":["number"],"help":"The alpha color value to be replaced. Between 0 and 255.","optional":false,"default":null},{"name":"r2","type":["number"],"help":"The red color value that is the replacement color. Between 0 and 255.","optional":false,"default":null},{"name":"g2","type":["number"],"help":"The green color value that is the replacement color. Between 0 and 255.","optional":false,"default":null},{"name":"b2","type":["number"],"help":"The blue color value that is the replacement color. Between 0 and 255.","optional":false,"default":null},{"name":"a2","type":["number"],"help":"The alpha color value that is the replacement color. Between 0 and 255.","optional":false,"default":null},{"name":"region","type":["Phaser.Rectangle"],"help":"The area to perform the search over. If not given it will replace over the whole BitmapData.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Resizes the BitmapData. This changes the size of the underlying canvas and refreshes the buffer.","line":319,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setHSL","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the hue, saturation and lightness values on every pixel in the given region, or the whole BitmapData if no region was specified.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"h","type":["number"],"help":"The hue, in the range 0 - 1.","optional":true,"default":"null"},{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":true,"default":"null"},{"name":"l","type":["number"],"help":"The lightness, in the range 0 - 1.","optional":true,"default":"null"},{"name":"region","type":["Phaser.Rectangle"],"help":"The area to perform the operation on. If not given it will run over the whole BitmapData.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setPixel","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the color of the given pixel to the specified red, green and blue values.","line":731,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"red","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"green","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"blue","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"The alpha color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"immediate","type":["boolean"],"help":"If `true` the context.putImageData will be called and the dirty flag set.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setPixel32","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the color of the given pixel to the specified red, green, blue and alpha values.","line":692,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.","optional":false,"default":null},{"name":"red","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"green","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"blue","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"The alpha color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"immediate","type":["boolean"],"help":"If `true` the context.putImageData will be called and the dirty flag set.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"shadow","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Sets the shadow properties of this BitmapDatas context which will affect all draw operations made to it.\\nYou can cancel an existing shadow by calling this method and passing no parameters.\\nNote: At the time of writing (October 2014) Chrome still doesn't support shadowBlur used with drawImage.","line":1203,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["string"],"help":"The color of the shadow, given in a CSS format, i.e. `#000000` or `rgba(0,0,0,1)`. If `null` or `undefined` the shadow will be reset.","optional":false,"default":null},{"name":"blur","type":["number"],"help":"The amount the shadow will be blurred by. Low values = a crisp shadow, high values = a softer shadow.","optional":true,"default":"5"},{"name":"x","type":["number"],"help":"The horizontal offset of the shadow in pixels.","optional":true,"default":"10"},{"name":"y","type":["number"],"help":"The vertical offset of the shadow in pixels.","optional":true,"default":"10"}],"inherited":false,"inheritedFrom":""},{"name":"shiftHSL","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Shifts any or all of the hue, saturation and lightness values on every pixel in the given region, or the whole BitmapData if no region was specified.\\nShifting will add the given value onto the current h, s and l values, not replace them.\\nThe hue is wrapped to keep it within the range 0 to 1. Saturation and lightness are clamped to not exceed 1.","line":628,"public":true,"protected":false,"private":false,"parameters":[{"name":"h","type":["number"],"help":"The amount to shift the hue by.","optional":true,"default":"null"},{"name":"s","type":["number"],"help":"The amount to shift the saturation by.","optional":true,"default":"null"},{"name":"l","type":["number"],"help":"The amount to shift the lightness by.","optional":true,"default":"null"},{"name":"region","type":["Phaser.Rectangle"],"help":"The area to perform the operation on. If not given it will run over the whole BitmapData.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"textureLine","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"Takes the given Line object and image and renders it to this BitmapData as a repeating texture line.","line":1366,"public":true,"protected":false,"private":false,"parameters":[{"name":"line","type":["Phaser.Line"],"help":"A Phaser.Line object that will be used to plot the start and end of the line.","optional":false,"default":null},{"name":"image","type":["string","Image"],"help":"The key of an image in the Phaser.Cache to use as the texture for this line, or an actual Image.","optional":false,"default":null},{"name":"repeat","type":["string"],"help":"The pattern repeat mode to use when drawing the line. Either `repeat`, `repeat-x` or `no-repeat`.","optional":true,"default":"'repeat-x'"}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"This BitmapData object for method chaining."},"help":"This re-creates the BitmapData.imageData from the current context.\\nIt then re-builds the ArrayBuffer, the data Uint8ClampedArray reference and the pixels Int32Array.\\nIf not given the dimensions defaults to the full size of the context.","line":361,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the top-left of the image data area to grab from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of the top-left of the image data area to grab from.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The width of the image data area.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The height of the image data area.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"","inlineHelp":"The PIXI.BaseTexture.","line":101,"default":"new PIXI.BaseTexture(this.canvas)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buffer","type":["array"],"help":"","inlineHelp":"An ArrayBuffer the same size as the context ImageData.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"","inlineHelp":"The canvas to which this BitmapData draws.","line":48,"default":"Phaser.Canvas.create(width, height, '', true)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"The 2d context of the canvas.","line":54,"default":"this.canvas.getContext('2d')","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ctx","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"A reference to BitmapData.context.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"data","type":["Uint8ClampedArray"],"help":"","inlineHelp":"A Uint8ClampedArray view into BitmapData.buffer.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"If dirty this BitmapData will be re-rendered.","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disableTextureUpload","type":["boolean"],"help":"","inlineHelp":"If disableTextureUpload is true this BitmapData will never send its image data to the GPU when its dirty flag is true.","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of the BitmapData in pixels.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"imageData","type":["ImageData"],"help":"","inlineHelp":"The context image data.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"","inlineHelp":"The key of the BitmapData in the Cache, if stored there.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixels","type":["Uint32Array"],"help":"","inlineHelp":"An Uint32Array view into BitmapData.buffer.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"","inlineHelp":"Gets or sets this BitmapData.contexts smoothing enabled value.","line":1769,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"","inlineHelp":"The PIXI.Texture.","line":107,"default":"new PIXI.Texture(this.baseTexture)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"textureFrame","type":["Phaser.Frame"],"help":"","inlineHelp":"The Frame this BitmapData uses for rendering.","line":113,"default":"new Phaser.Frame(0, 0, 0, width, height, 'bitmapData', game.rnd.uuid())","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":121,"default":"Phaser.BITMAPDATA","public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of the BitmapData in pixels.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_alpha","type":["object"],"help":"","inlineHelp":"Internal cache var.","line":170,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_anchor","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":176,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_circle","type":["Phaser.Circle"],"help":"","inlineHelp":"Internal cache var.","line":200,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_image","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":140,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pos","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":146,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_rotate","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":164,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_scale","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":158,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_size","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":152,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempB","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":194,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempG","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":188,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempR","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":182,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.BitmapText.json b/docgen/output/Phaser.BitmapText.json deleted file mode 100644 index 3060050ad..000000000 --- a/docgen/output/Phaser.BitmapText.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.BitmapText","extends":"PIXI.BitmapText","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the new bitmapText object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new bitmapText object.","optional":false,"default":null},{"name":"font","type":["string"],"help":"The key of the BitmapFont as stored in Game.Cache.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be rendered. Can be set later via BitmapText.text.","optional":true,"default":"''"},{"name":"size","type":["number"],"help":"The size the font will be rendered in, in pixels.","optional":true,"default":"32"}],"help":"BitmapText objects work by taking a texture file and an XML file that describes the font layout.\\n\\nOn Windows you can use the free app BMFont: http:\/\/www.angelcode.com\/products\/bmfont\/\\nOn OS X we recommend Glyph Designer: http:\/\/www.71squared.com\/en\/glyphdesigner\\nFor Web there is the great Littera: http:\/\/kvazars.com\/littera\/"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroy this BitmapText instance. This will remove any filters and un-parent any children.","line":210,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate.","line":194,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":152,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStyle","static":false,"returns":null,"help":"Set the style of the text\\nstyle.font {String} The size (optional) and bitmap font id (required) eq 'Arial' or '20px Arial' (must have loaded previously)\\n[style.align='left'] {String} Alignment for multiline text ('left', 'center' or 'right'), does not affect single lines of text","line":86,"public":true,"protected":false,"private":false,"parameters":[{"name":"style","type":["object"],"help":"The style parameters, contained as properties of an object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.BitmapText"},{"name":"setText","static":false,"returns":null,"help":"Set the text string to be rendered.","line":72,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The text that you would like displayed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.BitmapText"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":186,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"setStyle","static":false,"returns":null,"help":"","line":139,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"align","type":["string"],"help":"","inlineHelp":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.","line":269,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Text, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead.","inlineHelp":"Gets or sets the angle of rotation in degrees.","line":316,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":108,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":475,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"The dirty state of this object.","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Sprite isn't updated by the core game loop or physics subsystem at all.","line":41,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An BitmapText that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in BitmapText.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this BitmapText was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this BitmapText to the Camera at its current world coordinates.","line":448,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"font","type":["string"],"help":"","inlineHelp":"The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.","line":332,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontSize","type":["number"],"help":"","inlineHelp":"The size of the font in pixels.","line":355,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Text object won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":406,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this BitmapText.","line":47,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"text","type":["string"],"help":"The text string to be displayed by this Text object, taking into account the style settings.","inlineHelp":"The text string to be displayed by this Text object, taking into account the style settings.","line":381,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textHeight","type":["number"],"help":"[read-only] The height of the overall text, different from fontSize,\\nwhich is defined in the style object","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"textWidth","type":["number"],"help":"[read-only] The width of the overall text, different from fontSize,\\nwhich is defined in the style object","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"tint","type":["number"],"help":"","inlineHelp":"The tint applied to the BitmapText. This is a hex value. Set to white to disable (0xFFFFFF)","line":291,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_align","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":87,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":128,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_font","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":75,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fontSize","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":81,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_text","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":69,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tint","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":93,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Button.json b/docgen/output/Phaser.Button.json deleted file mode 100644 index 160e0858c..000000000 --- a/docgen/output/Phaser.Button.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Button","extends":"Phaser.Image","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the Button.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"Y position of the Button.","optional":true,"default":"0"},{"name":"key","type":["string"],"help":"The image key as defined in the Game.Cache to use as the texture for this Button.","optional":true,"default":null},{"name":"callback","type":["function"],"help":"The function to call when this Button is pressed.","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called (usually 'this').","optional":true,"default":null},{"name":"overFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"outFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"downFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"upFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null}],"help":"Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:\\n\\n* 'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.\\n* 'Out' - when the Pointer that was previously over the Button moves out of it.\\n* 'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.\\n* 'Up' - when the Pointer that was pressed down on the Button is released again.\\n\\nYou can set a unique texture frame and Sound for any of these states."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"bringToTop","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Brings the Image to the top of the display list it is a child of. Images that are members of a Phaser.Group are only\\nbought to the top of that Group, not the entire display list.","line":619,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"clearFrames","static":false,"returns":null,"help":"Clears all of the frames set on this Button.","line":215,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"crop","static":false,"returns":null,"help":"Crop allows you to crop the texture used to display this Image.\\nCropping takes place from the top-left of the Image and can be modified in real-time by providing an updated rectangle object.\\nThe rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.\\nPlease note that the rectangle object given is not duplicated by this method, but rather the Image uses a reference to the rectangle.\\nKeep this in mind if assigning a rectangle in a for-loop, or when cleaning up for garbage collection.","line":393,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.","optional":false,"default":null},{"name":"copy","type":["boolean"],"help":"If false Sprite.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Sprite.cropRect object.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the Image. This removes it from its parent group, destroys the input, event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":519,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"kill","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Kills a Image. A killed Image has its alive, exists and visible properties all set to false.\\nIt will dispatch the onKilled event, you can listen to Image.events.onKilled for the signal.\\nNote that killing a Image is a way for you to quickly recycle it in a Image pool, it doesn't free it up from memory.\\nIf you don't need this Image any more you should call Image.destroy instead.","line":496,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the Image is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":217,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":164,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Resets the Image. This places the Image at the given x\/y world coordinates and then sets alive, exists, visible and renderable all to true.","line":597,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Image at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Image at.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"resetFrame","static":false,"returns":null,"help":"Resets the Texture frame dimensions that the Image uses for rendering.","line":372,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"revive","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Brings a 'dead' Image back to life, optionally giving it the health value specified.\\nA resurrected Image has its alive, exists and visible properties all set to true.\\nIt will dispatch the onRevived event, you can listen to Image.events.onRevived for the signal.","line":471,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setDownSound","static":false,"returns":null,"help":"The Sound to be played when a Pointer presses down on this Button.","line":413,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"The Sound that will be played.","optional":false,"default":null},{"name":"marker","type":["string"],"help":"A Sound Marker that will be used in the playback.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the Image uses for rendering.\\nThis is primarily an internal method used by Image.loadTexture, although you may call it directly.","line":319,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the Image texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"setFrames","static":false,"returns":null,"help":"Used to manually set the frames that will be used for the different states of the Button.","line":240,"public":true,"protected":false,"private":false,"parameters":[{"name":"overFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"outFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"downFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"upFrame","type":["string","number"],"help":"This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setOutSound","static":false,"returns":null,"help":"The Sound to be played when a Pointer moves out of this Button.","line":389,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"The Sound that will be played.","optional":false,"default":null},{"name":"marker","type":["string"],"help":"A Sound Marker that will be used in the playback.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setOverSound","static":false,"returns":null,"help":"The Sound to be played when a Pointer moves over this Button.","line":365,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"The Sound that will be played.","optional":false,"default":null},{"name":"marker","type":["string"],"help":"A Sound Marker that will be used in the playback.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSounds","static":false,"returns":null,"help":"Sets the sounds to be played whenever this Button is interacted with. Sounds can be either full Sound objects, or markers pointing to a section of a Sound object.\\nThe most common forms of sounds are 'hover' effects and 'click' effects, which is why the order of the parameters is overSound then downSound.\\nCall this function with no parameters at all to reset all sounds on this Button.","line":349,"public":true,"protected":false,"private":false,"parameters":[{"name":"overSound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"Over Button Sound.","optional":true,"default":null},{"name":"overMarker","type":["string"],"help":"Over Button Sound Marker.","optional":true,"default":null},{"name":"downSound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"Down Button Sound.","optional":true,"default":null},{"name":"downMarker","type":["string"],"help":"Down Button Sound Marker.","optional":true,"default":null},{"name":"outSound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"Out Button Sound.","optional":true,"default":null},{"name":"outMarker","type":["string"],"help":"Out Button Sound Marker.","optional":true,"default":null},{"name":"upSound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"Up Button Sound.","optional":true,"default":null},{"name":"upMarker","type":["string"],"help":"Up Button Sound Marker.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setUpSound","static":false,"returns":null,"help":"The Sound to be played when a Pointer has pressed down and is released from this Button.","line":437,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound","Phaser.AudioSprite"],"help":"The Sound that will be played.","optional":false,"default":null},{"name":"marker","type":["string"],"help":"A Sound Marker that will be used in the playback.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":207,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCrop","static":false,"returns":null,"help":"If you have set a crop rectangle on this Image via Image.crop and since modified the Image.cropRect property (or the rectangle it references)\\nthen you need to update the crop frame by calling this method.","line":431,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"}],"protected":[{"name":"onInputDownHandler","static":false,"returns":null,"help":"Internal function that handles input events.","line":526,"public":false,"protected":true,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Button"],"help":"The Button that the event occured on.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer that activated the Button.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onInputOutHandler","static":false,"returns":null,"help":"Internal function that handles input events.","line":500,"public":false,"protected":true,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Button"],"help":"The Button that the event occured on.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer that activated the Button.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onInputOverHandler","static":false,"returns":null,"help":"Internal function that handles input events.","line":462,"public":false,"protected":true,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Button"],"help":"The Button that the event occured on.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer that activated the Button.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onInputUpHandler","static":false,"returns":null,"help":"Internal function that handles input events.","line":552,"public":false,"protected":true,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Button"],"help":"The Button that the event occured on.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer that activated the Button.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setState","static":false,"returns":null,"help":"Internal function that handles Button state changes.","line":602,"public":false,"protected":true,"private":false,"parameters":[{"name":"newState","type":["number"],"help":"The new State of the Button.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"A useful boolean to control if the Image is alive or dead (in terms of your gameplay, it doesn't effect rendering).","line":83,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Image, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Image.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Image in degrees.","line":638,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Image be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Image should be automatically camera culled or not.","line":93,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"cropRect","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.","line":115,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"Handy flag to use with Game.enableStep","line":104,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaX","type":["number"],"help":"Returns the delta x value. The difference between world.x now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was to the right, negative if to the left.","line":661,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaY","type":["number"],"help":"Returns the delta y value. The difference between world.y now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was downwards, negative if upwards.","line":678,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaZ","type":["number"],"help":"Returns the delta z value. The difference between rotation now and in the previous step.","inlineHelp":"The delta value.","line":695,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":921,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Image or its components.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Image isn't updated by the core game loop.","line":36,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Image that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Image.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Image was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Image to the Camera at its current world coordinates.","line":860,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"forceOut","type":["boolean"],"help":"When the Button is touched \/ clicked and then released you can force it to enter a state of \"out\" instead of \"up\".","inlineHelp":"","line":186,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture for display.","line":743,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame by name and updates the Texture for display.","line":772,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"freezeFrames","type":["boolean"],"help":"","inlineHelp":"When true the Button will cease to change texture frame on all events (over, out, up, down).","line":179,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inCamera","type":["boolean"],"help":"Checks if the Image bounds are within the game camera, otherwise false if fully outside of it.","inlineHelp":"True if the Image bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.","line":729,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"inWorld","type":["boolean"],"help":"Checks if the Image bounds are within the game world, otherwise false if fully outside of it.","inlineHelp":"True if the Image bounds is within the game world, even if only partially. Otherwise false if fully outside of it.","line":712,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default an Image won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":819,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Image.","line":42,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDownSound","type":["Phaser.Sound"],"help":"","inlineHelp":"The Sound to be played when this Buttons Down state is activated.","line":124,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDownSoundMarker","type":["string"],"help":"","inlineHelp":"The Sound Marker used in conjunction with the onDownSound.","line":148,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputDown","type":["Phaser.Signal"],"help":"","inlineHelp":"The Signal (or event) dispatched when this Button is in an Down state.","line":169,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputOut","type":["Phaser.Signal"],"help":"","inlineHelp":"The Signal (or event) dispatched when this Button is in an Out state.","line":164,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputOver","type":["Phaser.Signal"],"help":"","inlineHelp":"The Signal (or event) dispatched when this Button is in an Over state.","line":159,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputUp","type":["Phaser.Signal"],"help":"","inlineHelp":"The Signal (or event) dispatched when this Button is in an Up state.","line":174,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOutSound","type":["Phaser.Sound"],"help":"","inlineHelp":"The Sound to be played when this Buttons Out state is activated.","line":118,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOutSoundMarker","type":["string"],"help":"","inlineHelp":"The Sound Marker used in conjunction with the onOutSound.","line":142,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOverMouseOnly","type":["boolean"],"help":"","inlineHelp":"If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer.","line":106,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOverSound","type":["Phaser.Sound"],"help":"","inlineHelp":"The Sound to be played when this Buttons Over state is activated.","line":112,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOverSoundMarker","type":["string"],"help":"","inlineHelp":"The Sound Marker used in conjunction with the onOverSound.","line":136,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpSound","type":["Phaser.Sound"],"help":"","inlineHelp":"The Sound to be played when this Buttons Up state is activated.","line":130,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpSoundMarker","type":["string"],"help":"","inlineHelp":"The Sound Marker used in conjunction with the onUpSound.","line":154,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderOrderID","type":["number"],"help":"","inlineHelp":"The render order ID, reset every frame.","line":802,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"Enable or disable texture smoothing for this Image. Only works for bitmap\/image textures. Smoothing is enabled by default.","inlineHelp":"Set to true to smooth the texture of this Image, or false to disable smoothing (great for pixel art)","line":889,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The Phaser Object Type.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Image. This differs from the x\/y coordinates which are relative to the Images container.","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onDownFrameID","type":["number"],"help":"","inlineHelp":"Internal variable.","line":93,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onDownFrameName","type":["string"],"help":"","inlineHelp":"Internal variable.","line":65,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onOutFrameID","type":["number"],"help":"","inlineHelp":"Internal variable.","line":86,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onOutFrameName","type":["string"],"help":"","inlineHelp":"Internal variable.","line":58,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onOverFrameID","type":["number"],"help":"","inlineHelp":"Internal variable.","line":79,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onOverFrameName","type":["string"],"help":"","inlineHelp":"Internal variable.","line":51,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onUpFrameID","type":["number"],"help":"","inlineHelp":"Internal variable.","line":100,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onUpFrameName","type":["string"],"help":"","inlineHelp":"Internal variable.","line":72,"default":"null","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Cache.json b/docgen/output/Phaser.Cache.json deleted file mode 100644 index e4ae7c4d0..000000000 --- a/docgen/output/Phaser.Cache.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Cache","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds\\nand data files as a result of Loader calls. Cached items use string based keys for look-up."},"consts":[{"name":"BINARY","type":"number","help":"","line":186},{"name":"BITMAPDATA","type":"number","help":"","line":192},{"name":"BITMAPFONT","type":"number","help":"","line":198},{"name":"CANVAS","type":"number","help":"","line":144},{"name":"IMAGE","type":"number","help":"","line":150},{"name":"JSON","type":"number","help":"","line":204},{"name":"PHYSICS","type":"number","help":"","line":174},{"name":"SOUND","type":"number","help":"","line":162},{"name":"TEXT","type":"number","help":"","line":168},{"name":"TEXTURE","type":"number","help":"","line":156},{"name":"TILEMAP","type":"number","help":"","line":180},{"name":"XML","type":"number","help":"","line":210}],"methods":{"public":[{"name":"addBinary","static":false,"returns":null,"help":"Add a binary object in to the cache.","line":235,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this binary data.","optional":false,"default":null},{"name":"binaryData","type":["object"],"help":"The binary object to be addded to the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addBitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The BitmapData object to be addded to the cache."},"help":"Add a BitmapData object in to the cache.","line":250,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this BitmapData.","optional":false,"default":null},{"name":"bitmapData","type":["Phaser.BitmapData"],"help":"The BitmapData object to be addded to the cache.","optional":false,"default":null},{"name":"frameData","type":["Phaser.FrameData"],"help":"Optional FrameData set associated with the given BitmapData.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addBitmapFont","static":false,"returns":null,"help":"Add a new Bitmap Font to the Cache.","line":363,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this font xml file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra font data.","optional":false,"default":null},{"name":"xmlData","type":["object"],"help":"Texture atlas frames data.","optional":false,"default":null},{"name":"xSpacing","type":["number"],"help":"If you'd like to add additional horizontal spacing between the characters then set the pixel value here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If you'd like to add additional vertical spacing between the lines then set the pixel value here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addCanvas","static":false,"returns":null,"help":"Add a new canvas object in to the cache.","line":222,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this canvas.","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"Canvas DOM element.","optional":false,"default":null},{"name":"context","type":["CanvasRenderingContext2D"],"help":"Render context of this canvas.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addImage","static":false,"returns":null,"help":"Adds an Image file into the Cache. The file must have already been loaded, typically via Phaser.Loader.","line":491,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this image file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra image data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addJSON","static":false,"returns":null,"help":"Add a new json object into the cache.","line":461,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the json data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this json data file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra json data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addRenderTexture","static":false,"returns":null,"help":"Add a new Phaser.RenderTexture in to the cache.","line":267,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"texture","type":["Phaser.RenderTexture"],"help":"The texture to use as the base of the RenderTexture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addSound","static":false,"returns":null,"help":"Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.","line":516,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this sound file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sound data.","optional":false,"default":null},{"name":"webAudio","type":["boolean"],"help":"True if the file is using web audio.","optional":false,"default":null},{"name":"audioTag","type":["boolean"],"help":"True if the file is using legacy HTML audio.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addSpriteSheet","static":false,"returns":null,"help":"Add a new sprite sheet in to the cache.","line":288,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this sprite sheet file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sprite sheet data.","optional":false,"default":null},{"name":"frameWidth","type":["number"],"help":"Width of the sprite sheet.","optional":false,"default":null},{"name":"frameHeight","type":["number"],"help":"Height of the sprite sheet.","optional":false,"default":null},{"name":"frameMax","type":["number"],"help":"How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly.","optional":true,"default":"-1"},{"name":"margin","type":["number"],"help":"If the frames have been drawn with a margin, specify the amount here.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"If the frames have been drawn with spacing between them, specify the amount here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addText","static":false,"returns":null,"help":"Add a new text data.","line":445,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the text data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this text data file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra text data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addTextureAtlas","static":false,"returns":null,"help":"Add a new texture atlas to the Cache.","line":328,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this texture atlas file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra texture atlas data.","optional":false,"default":null},{"name":"atlasData","type":["object"],"help":" - Texture atlas frames data.","optional":false,"default":null},{"name":"format","type":["number"],"help":"The format of the texture atlas.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addTilemap","static":false,"returns":null,"help":"Add a new physics data object to the Cache.","line":387,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the physics json data.","optional":false,"default":null},{"name":"JSONData","type":["object"],"help":"The physics data object (a JSON file).","optional":false,"default":null},{"name":"format","type":["number"],"help":"The format of the physics data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addXML","static":false,"returns":null,"help":"Add a new xml object into the cache.","line":477,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the xml file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this xml file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra text data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBinaryKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Binary Cache.","line":842,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the binary file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBitmapDataKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the BitmapData Cache.","line":855,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapData to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBitmapFontKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the BitmapFont Cache.","line":868,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapFont to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkCanvasKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Canvas Cache.","line":751,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the canvas to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkImageKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.","line":764,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkJSONKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the JSON Cache.","line":881,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the JSON file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if a key for the given cache object type exists.","line":733,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["number"],"help":"The Cache type to check against. I.e. Phaser.Cache.CANVAS, Phaser.Cache.IMAGE, Phaser.Cache.JSON, etc.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkPhysicsKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Physics Cache.","line":816,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the physics data file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkSoundKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Sound Cache.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTextKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Text Cache.","line":803,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the text file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTextureKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Texture Cache.","line":777,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTilemapKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Tilemap Cache.","line":829,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the Tilemap to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkUrl","static":false,"returns":{"types":["boolean"],"help":"True if the url exists, otherwise false."},"help":"Checks if the given URL has been loaded into the Cache.","line":907,"public":true,"protected":false,"private":false,"parameters":[{"name":"url","type":["string"],"help":"The url to check for in the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkXMLKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the XML Cache.","line":894,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the XML file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"decodedSound","static":false,"returns":null,"help":"Add a new decoded sound.","line":594,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sound data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clears the cache. Removes every local cache object reference.","line":1497,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getBinary","static":false,"returns":{"types":["object"],"help":"The binary data object."},"help":"Get binary data by key.","line":1237,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the binary data object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The requested BitmapData object if found, or null if not."},"help":"Get a BitmapData object from the cache by its key.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapData object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBitmapFont","static":false,"returns":{"types":["Phaser.BitmapFont"],"help":"The requested BitmapFont object if found, or null if not."},"help":"Get a BitmapFont object from the cache by its key.","line":649,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapFont object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getCanvas","static":false,"returns":{"types":["object"],"help":"The canvas object."},"help":"Get a canvas object from the cache by its key.","line":609,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the canvas to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame data."},"help":"Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas\/spritesheet image.","line":1036,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByIndex","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame object."},"help":"Get a single frame out of a frameData set by key.","line":1002,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByName","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame object."},"help":"Get a single frame out of a frameData set by key.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameCount","static":false,"returns":{"types":["number"],"help":"Then number of frames. 0 if the image is not found."},"help":"Get the number of frames in this image.","line":1159,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image you want.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameData","static":false,"returns":{"types":["Phaser.FrameData"],"help":"The frame data."},"help":"Get frame data by key.","line":967,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null},{"name":"map","type":["string"],"help":"The asset map to get the frameData from, for example `Phaser.Cache.IMAGE`.","optional":true,"default":"Phaser.Cache.IMAGE"}],"inherited":false,"inheritedFrom":""},{"name":"getImage","static":false,"returns":{"types":["object"],"help":"The image data if found in the Cache, otherwise `null`."},"help":"Get image data by key.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getJSON","static":false,"returns":{"types":["object"],"help":"The JSON object."},"help":"Get a JSON object by key from the cache.","line":1197,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the json object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getKeys","static":false,"returns":{"types":["array"],"help":"The array of item keys."},"help":"Gets all keys used by the Cache for the given data type.","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["number"],"help":"The type of Cache keys you wish to get. Can be Cache.CANVAS, Cache.IMAGE, Cache.SOUND, etc.","optional":true,"default":"Phaser.Cache.IMAGE"}],"inherited":false,"inheritedFrom":""},{"name":"getPhysicsData","static":false,"returns":{"types":["object"],"help":"The requested physics object data if found."},"help":"Get a physics data object from the cache by its key. You can get either the entire data set, a single object or a single fixture of an object from it.","line":671,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the physics data object to retrieve from the Cache.","optional":false,"default":null},{"name":"object","type":["string"],"help":"If specified it will return just the physics object that is part of the given key, if null it will return them all.","optional":true,"default":"null"},{"name":"fixtureKey","type":["string"],"help":"Fixture key of fixture inside an object. This key can be set per fixture with the Phaser Exporter.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSound","static":false,"returns":{"types":["Phaser.Sound"],"help":"The sound object."},"help":"Get sound by key.","line":1090,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSoundData","static":false,"returns":{"types":["object"],"help":"The sound data."},"help":"Get sound data by key.","line":1110,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getText","static":false,"returns":{"types":["object"],"help":"The text data."},"help":"Get text data by key.","line":1177,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the text data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTexture","static":false,"returns":{"types":["Phaser.RenderTexture"],"help":"The RenderTexture object."},"help":"Get a RenderTexture by key.","line":1070,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the RenderTexture to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTextureFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame data."},"help":"Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas\/spritesheet image.","line":1053,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTilemapData","static":false,"returns":{"types":["object"],"help":"The raw tilemap data in CSV or JSON format."},"help":"Get tilemap data by key.","line":946,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the tilemap data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getUrl","static":false,"returns":{"types":["object"],"help":"The cached object."},"help":"Get a cached object by the URL.","line":1257,"public":true,"protected":false,"private":false,"parameters":[{"name":"url","type":["string"],"help":"The url for the object loaded to get from the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getXML","static":false,"returns":{"types":["object"],"help":"The XML object."},"help":"Get a XML object by key from the cache.","line":1217,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the XML object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isSoundDecoded","static":false,"returns":{"types":["boolean"],"help":"The decoded state of the Sound object."},"help":"Check if the given sound has finished decoding.","line":1130,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isSoundReady","static":false,"returns":{"types":["boolean"],"help":"True if the sound is decoded and the device is not touch locked."},"help":"Check if the given sound is ready for playback. A sound is considered ready when it has finished decoding and the device is no longer touch locked.","line":1146,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reloadSound","static":false,"returns":null,"help":"Reload a Sound file from the server.","line":540,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reloadSoundComplete","static":false,"returns":null,"help":"Fires the onSoundUnlock event when the sound has completed reloading.","line":562,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBinary","static":false,"returns":null,"help":"Removes a binary file from the cache.","line":1447,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBitmapData","static":false,"returns":null,"help":"Removes a bitmap data from the cache.","line":1457,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBitmapFont","static":false,"returns":null,"help":"Removes a bitmap font from the cache.","line":1467,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeCanvas","static":false,"returns":null,"help":"Removes a canvas from the cache.","line":1357,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeImage","static":false,"returns":null,"help":"Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.","line":1368,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null},{"name":"removeFromPixi","type":["boolean"],"help":"Should this image also be removed from the Pixi BaseTextureCache?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"removeJSON","static":false,"returns":null,"help":"Removes a json object from the cache.","line":1407,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removePhysics","static":false,"returns":null,"help":"Removes a physics data file from the cache.","line":1427,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeSound","static":false,"returns":null,"help":"Removes a sound from the cache.","line":1387,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeText","static":false,"returns":null,"help":"Removes a text from the cache.","line":1397,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeTilemap","static":false,"returns":null,"help":"Removes a tilemap from the cache.","line":1437,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeXML","static":false,"returns":null,"help":"Removes a xml object from the cache.","line":1417,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateFrameData","static":false,"returns":null,"help":"Replaces a set of frameData with a new Phaser.FrameData object.","line":986,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"frameData","type":["number"],"help":"The new FrameData.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateSound","static":false,"returns":null,"help":"Updates the sound object in the cache.","line":578,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"addDefaultImage","static":false,"returns":null,"help":"Adds a default image to be used in special cases such as WebGL Filters. Is mapped to the key __default.","line":401,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"addMissingImage","static":false,"returns":null,"help":"Adds an image to be used when a key is wrong \/ missing. Is mapped to the key __missing.","line":422,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"_resolveUrl","static":false,"returns":{"types":["string"],"help":"The resolved URL."},"help":"Resolves a URL to its absolute form.","line":1479,"public":false,"protected":false,"private":true,"parameters":[{"name":"url","type":["string"],"help":"The URL to resolve.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"_cacheMap","type":["array"],"help":"","inlineHelp":"Const to cache object look-up array.","line":123,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onSoundUnlock","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the sound system is unlocked via a touch event on cellular devices.","line":118,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_binary","type":["object"],"help":"","inlineHelp":"Binary file key-value container.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_bitmapDatas","type":["object"],"help":"","inlineHelp":"BitmapData key-value container.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_bitmapFont","type":["object"],"help":"","inlineHelp":"BitmapFont key-value container.","line":92,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_canvases","type":["object"],"help":"","inlineHelp":"Canvas key-value container.","line":26,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_images","type":["object"],"help":"","inlineHelp":"Image key-value container.","line":32,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_json","type":["object"],"help":"","inlineHelp":"JSOIN key-value container.","line":56,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_physics","type":["object"],"help":"","inlineHelp":"Physics data key-value container.","line":68,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sounds","type":["object"],"help":"","inlineHelp":"Sound key-value container.","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_text","type":["object"],"help":"","inlineHelp":"Text key-value container.","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_textures","type":["object"],"help":"","inlineHelp":"RenderTexture key-value container.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tilemaps","type":["object"],"help":"","inlineHelp":"Tilemap key-value container.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlMap","type":["object"],"help":"","inlineHelp":"Maps URLs to resources.","line":98,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlResolver","type":["Image"],"help":"","inlineHelp":"Used to resolve URLs to the absolute path.","line":104,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlTemp","type":["string"],"help":"","inlineHelp":"Temporary variable to hold a resolved url.","line":110,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_xml","type":["object"],"help":"","inlineHelp":"XML key-value container.","line":62,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Camera.json b/docgen/output/Phaser.Camera.json deleted file mode 100644 index 58c9c601c..000000000 --- a/docgen/output/Phaser.Camera.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Camera","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"id","type":["number"],"help":"Not being used at the moment, will be when Phaser supports multiple camera","optional":false,"default":null},{"name":"x","type":["number"],"help":"Position of the camera on the X axis","optional":false,"default":null},{"name":"y","type":["number"],"help":"Position of the camera on the Y axis","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the view rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the view rectangle","optional":false,"default":null}],"help":"A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view.\\nThe game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x\/y"},"consts":[{"name":"FOLLOW_LOCKON","type":"number","help":"","line":123},{"name":"FOLLOW_PLATFORMER","type":"number","help":"","line":129},{"name":"FOLLOW_TOPDOWN","type":"number","help":"","line":135},{"name":"FOLLOW_TOPDOWN_TIGHT","type":"number","help":"","line":141}],"methods":{"public":[{"name":"checkWorldBounds","static":false,"returns":null,"help":"Method called to ensure the camera doesn't venture outside of the game world.","line":311,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"focusOn","static":false,"returns":null,"help":"Move the camera focus on a display object instantly.","line":204,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to focus the camera on. Must have visible x\/y properties.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"focusOnXY","static":false,"returns":null,"help":"Move the camera focus on a location instantly.","line":216,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"follow","static":false,"returns":null,"help":"Tells this camera which sprite to follow.","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"target","type":["Phaser.Sprite","Phaser.Image","Phaser.Text"],"help":"The object you want the camera to track. Set to null to not follow anything.","optional":false,"default":null},{"name":"style","type":["number"],"help":"Leverage one of the existing \"deadzone\" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the camera back to 0,0 and un-follows any object it may have been tracking.","line":382,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setBoundsToWorld","static":false,"returns":null,"help":"Update the Camera bounds to match the game world.","line":298,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setPosition","static":false,"returns":null,"help":"A helper function to set both the X and Y properties of the camera at once\\nwithout having to use game.camera.x and game.camera.y.","line":351,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"Sets the size of the view rectangle given the width and height in parameters.","line":370,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The desired width.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The desired height.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"unfollow","static":false,"returns":null,"help":"Sets the Camera follow target to null, stopping it from following an object if it's doing so.","line":193,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update focusing and scrolling.","line":226,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"updateTarget","static":false,"returns":null,"help":"Internal method","line":253,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"_targetPosition","type":["Phaser.Point"],"help":"","inlineHelp":"Internal point used to calculate target position","line":115,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"atLimit","type":["boolean"],"help":"","inlineHelp":"Whether this camera is flush with the World Bounds or not.","line":80,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bounds","type":["Phaser.Rectangle"],"help":"The Camera is bound to this Rectangle and cannot move outside of it. By default it is enabled and set to the size of the World.\\nThe Rectangle can be located anywhere in the world and updated as often as you like. If you don't wish the Camera to be bound\\nat all then set this to null. The values can be anything and are in World coordinates, with 0,0 being the center of the world.","inlineHelp":"The Rectangle in which the Camera is bounded. Set to null to allow for movement anywhere.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"deadzone","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Moving inside this Rectangle will not cause the camera to move.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"","inlineHelp":"The display object to which all game objects are added. Set by World.boot","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The Cameras height. By default this is the same as the Game size and should not be adjusted for now.","inlineHelp":"Gets or sets the cameras height.","line":487,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"id","type":["number"],"help":"","inlineHelp":"Reserved for future multiple camera set-ups.","line":36,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The Cameras position. This value is automatically clamped if it falls outside of the World bounds.","inlineHelp":"Gets or sets the cameras xy position using Phaser.Point object.","line":445,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"roundPx","type":["boolean"],"help":"","inlineHelp":"If a Camera has roundPx set to `true` it will call `view.floor` as part of its update loop, keeping its boundary to integer values. Set this to `false` to disable this from happening.","line":75,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the display object to which all game objects are added. Set by World.boot","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"screenView","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Used by Sprites to work out Camera culling.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"target","type":["Phaser.Sprite"],"help":"","inlineHelp":"If the camera is tracking a Sprite, this is a reference to it, otherwise null.","line":86,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"view","type":["Phaser.Rectangle"],"help":"Camera view.\\nThe view into the world we wish to render (by default the game dimensions).\\nThe x\/y values are in world coordinates, not screen coordinates, the width\/height is how many pixels to render.\\nObjects outside of this view are not rendered if set to camera cull.","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"Whether this camera is visible or not.","line":69,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The Cameras width. By default this is the same as the Game size and should not be adjusted for now.","inlineHelp":"Gets or sets the cameras width.","line":470,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"A reference to the game world.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds.","inlineHelp":"Gets or sets the cameras x position.","line":399,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds.","inlineHelp":"Gets or sets the cameras y position.","line":422,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"edge","type":["number"],"help":"","inlineHelp":"Edge property.","line":93,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"Current position of the camera in world.","line":100,"default":"new Phaser.Point()","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Canvas.json b/docgen/output/Phaser.Canvas.json deleted file mode 100644 index da673347a..000000000 --- a/docgen/output/Phaser.Canvas.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Canvas","extends":"","static":true,"constructor":false,"parameters":[],"help":"The Canvas class handles everything related to creating the `canvas` DOM tag that Phaser will use, including styles, offset and aspect ratio."},"consts":[],"methods":{"public":[{"name":"addToDOM","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"Returns the source canvas."},"help":"Adds the given canvas element to the DOM. The canvas will be added as a child of the given parent.\\nIf no parent is given it will be added as a child of the document.body.","line":166,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to be added to the DOM.","optional":false,"default":null},{"name":"parent","type":["string","HTMLElement"],"help":"The DOM element to add the canvas to.","optional":false,"default":null},{"name":"overflowHidden","type":["boolean"],"help":"If set to true it will add the overflow='hidden' style to the parent DOM element.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"The newly created canvas element."},"help":"Creates a `canvas` DOM element. The element is not automatically added to the document.","line":24,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the canvas element.","optional":true,"default":"256"},{"name":"height","type":["number"],"help":"The height of the canvas element..","optional":true,"default":"256"},{"name":"id","type":["string"],"help":"If given this will be set as the ID of the canvas element, otherwise no ID will be set.","optional":true,"default":"''"}],"inherited":false,"inheritedFrom":""},{"name":"getAspectRatio","static":false,"returns":{"types":["number"],"help":"The ratio between canvas' width and height."},"help":"Returns the aspect ratio of the given canvas.","line":90,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to get the aspect ratio from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getOffset","static":false,"returns":{"types":["Phaser.Point"],"help":"- A point objet with the offsetX and Y as its properties."},"help":"Get the DOM offset values of any given element","line":52,"public":true,"protected":false,"private":false,"parameters":[{"name":"element","type":["HTMLElement"],"help":"The targeted element that we want to retrieve the offset.","optional":false,"default":null},{"name":"point","type":["Phaser.Point"],"help":"The point we want to take the x\/y values of the offset.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSmoothingEnabled","static":false,"returns":{"types":["boolean"],"help":"True if the given context has image smoothing enabled, otherwise false."},"help":"Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.","line":270,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["CanvasRenderingContext2D"],"help":"The context to check for smoothing on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeFromDOM","static":false,"returns":null,"help":"Removes the given canvas element from the DOM.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to be removed from the DOM.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setBackgroundColor","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"Returns the source canvas."},"help":"Sets the background color behind the canvas. This changes the canvas style property.","line":102,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to set the background color on.","optional":false,"default":null},{"name":"color","type":["string"],"help":"The color to set. Can be in the format 'rgb(r,g,b)', or '#RRGGBB' or any valid CSS color.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setImageRenderingBicubic","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"Returns the source canvas."},"help":"Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').\\nNote that if this doesn't given the desired result then see the CanvasUtils.setSmoothingEnabled method.","line":306,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":" The canvas to set image-rendering bicubic on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setImageRenderingCrisp","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"Returns the source canvas."},"help":"Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).\\nNote that if this doesn't given the desired result then see the setSmoothingEnabled.","line":284,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to set image-rendering crisp on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSmoothingEnabled","static":false,"returns":{"types":["CanvasRenderingContext2D"],"help":"Returns the source context."},"help":"Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.\\nBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\\nwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\\ndrawn to the context will be affected. This sets the property across all current browsers but support is\\npatchy on earlier browsers, especially on mobile.","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["CanvasRenderingContext2D"],"help":"The context to enable or disable the image smoothing on.","optional":false,"default":null},{"name":"value","type":["boolean"],"help":"If set to true it will enable image smoothing, false will disable it.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTouchAction","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"The source canvas."},"help":"Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.","line":120,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to set the touch action on.","optional":false,"default":null},{"name":"value","type":["string"],"help":"The touch action to set. Defaults to 'none'.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTransform","static":false,"returns":{"types":["CanvasRenderingContext2D"],"help":"Returns the source context."},"help":"Sets the transform of the given canvas to the matrix values provided.","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["CanvasRenderingContext2D"],"help":"The context to set the transform on.","optional":false,"default":null},{"name":"translateX","type":["number"],"help":"The value to translate horizontally by.","optional":false,"default":null},{"name":"translateY","type":["number"],"help":"The value to translate vertically by.","optional":false,"default":null},{"name":"scaleX","type":["number"],"help":"The value to scale horizontally by.","optional":false,"default":null},{"name":"scaleY","type":["number"],"help":"The value to scale vertically by.","optional":false,"default":null},{"name":"skewX","type":["number"],"help":"The value to skew horizontaly by.","optional":false,"default":null},{"name":"skewY","type":["number"],"help":"The value to skew vertically by.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setUserSelect","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"The source canvas."},"help":"Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.","line":140,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas to set the touch action on.","optional":false,"default":null},{"name":"value","type":["string"],"help":"The touch action to set. Defaults to 'none'.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Circle.json b/docgen/output/Phaser.Circle.json deleted file mode 100644 index 95f4824f0..000000000 --- a/docgen/output/Phaser.Circle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Circle","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the center of the circle.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of the center of the circle.","optional":true,"default":"0"},{"name":"diameter","type":["number"],"help":"The diameter of the circle.","optional":true,"default":"0"}],"help":"Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.\\nIf you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created."},"consts":[],"methods":{"public":[{"name":"circumference","static":false,"returns":{"types":["number"],"help":""},"help":"The circumference of the circle.","line":63,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"circumferencePoint","static":false,"returns":{"types":["Phaser.Point"],"help":"The Point object holding the result."},"help":"Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.","line":489,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Circle"],"help":"The first Circle object.","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The angle in radians (unless asDegrees is true) to return the point from.","optional":false,"default":null},{"name":"asDegrees","type":["boolean"],"help":"Is the given angle in radians (false) or degrees (true)?","optional":true,"default":"false"},{"name":"out","type":["Phaser.Point"],"help":"An optional Point object to put the result in to. If none specified a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clone","static":false,"returns":{"types":["Phaser.Circle"],"help":"The cloned Circle object."},"help":"Returns a new Circle object with the same values for the x, y, width, and height properties as this Circle object.","line":152,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Circle"],"help":"Optional Circle object. If given the values will be set into the object, otherwise a brand new Circle object will be created and returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this circle, otherwise false."},"help":"Return true if the given x\/y coordinates are within the Circle object.","line":440,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Circle"],"help":"The Circle to be checked.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The X value of the coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y value of the coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyFrom","static":false,"returns":{"types":["Phaser.Circle"],"help":"This Circle object."},"help":"Copies the x, y and diameter properties from any given object to this Circle.","line":101,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyTo","static":false,"returns":{"types":["object"],"help":"This dest object."},"help":"Copies the x, y and diameter properties from this Circle to any given object.","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"dest","type":["any"],"help":"The object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"distance","static":false,"returns":{"types":["number"],"help":"The distance between this Point object and the destination Point object."},"help":"Returns the distance from the center of the Circle object to the given object\\n(can be Circle, Point or anything with x\/y properties)","line":131,"public":true,"protected":false,"private":false,"parameters":[{"name":"dest","type":["object"],"help":"The target object. Must have visible x and y properties that represent the center of the object.","optional":false,"default":null},{"name":"round","type":["boolean"],"help":"Round the distance to the nearest integer (default false).","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"equals","static":false,"returns":{"types":["boolean"],"help":"A value of true if the object has exactly the same values for the x, y and diameter properties as this Circle object; otherwise false."},"help":"Determines whether the two Circle objects match. This method compares the x, y and diameter properties.","line":464,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Circle"],"help":"The first Circle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Circle"],"help":"The second Circle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The bounds of the Circle."},"help":"Returns the framing rectangle of the circle as a Phaser.Rectangle object","line":72,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":{"types":["boolean"],"help":"A value of true if the specified object intersects with this Circle object; otherwise false."},"help":"Determines whether the two Circle objects intersect.\\nThis method checks the radius distances between the two Circle objects to see if they intersect.","line":476,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Circle"],"help":"The first Circle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Circle"],"help":"The second Circle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersectsRectangle","static":false,"returns":{"types":["boolean"],"help":"True if the two objects intersect, otherwise false."},"help":"Checks if the given Circle and Rectangle objects intersect.","line":513,"public":true,"protected":false,"private":false,"parameters":[{"name":"c","type":["Phaser.Circle"],"help":"The Circle object to test.","optional":false,"default":null},{"name":"r","type":["Phaser.Rectangle"],"help":"The Rectangle object to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"offset","static":false,"returns":{"types":["Phaser.Circle"],"help":"This Circle object."},"help":"Adjusts the location of the Circle object, as determined by its center coordinate, by the specified amounts.","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"dx","type":["number"],"help":"Moves the x value of the Circle object by this amount.","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Moves the y value of the Circle object by this amount.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"offsetPoint","static":false,"returns":{"types":["Phaser.Circle"],"help":"This Circle object."},"help":"Adjusts the location of the Circle object using a Point object as a parameter. This method is similar to the Circle.offset() method, except that it takes a Point object as a parameter.","line":216,"public":true,"protected":false,"private":false,"parameters":[{"name":"point","type":["Phaser.Point"],"help":" A Point object to use to offset this Circle object (or any valid object with exposed x and y properties).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Circle"],"help":"This circle object."},"help":"Sets the members of Circle to the specified values.","line":84,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the center of the circle.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the center of the circle.","optional":false,"default":null},{"name":"diameter","type":["number"],"help":"The diameter of the circle.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"a string representation of the instance."},"help":"Returns a string representation of this object.","line":225,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"area","type":["number"],"help":"The area of this Circle.","inlineHelp":"The area of this circle.","line":392,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bottom","type":["number"],"help":"The sum of the y and radius properties. Changing the bottom property of a Circle object has no effect on the x and y properties, but does change the diameter.","inlineHelp":"Gets or sets the bottom of the circle.","line":364,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"diameter","type":["number"],"help":"The largest distance between any two points on the circle. The same as the radius * 2.","inlineHelp":"Gets or sets the diameter of the circle.","line":238,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"empty","type":["boolean"],"help":"Determines whether or not this Circle object is empty. Will return a value of true if the Circle objects diameter is less than or equal to 0; otherwise false.\\nIf set to true it will reset all of the Circle objects properties to 0. A Circle object is empty if its diameter is less than or equal to 0.","inlineHelp":"Gets or sets the empty state of the circle.","line":415,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"radius","type":["number"],"help":"The length of a line extending from the center of the circle to any point on the circle itself. The same as half the diameter.","inlineHelp":"Gets or sets the radius of the circle.","line":260,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"The x coordinate of the rightmost point of the circle. Changing the right property of a Circle object has no effect on the x and y properties. However it does affect the diameter, whereas changing the x value does not affect the diameter property.","inlineHelp":"Gets or sets the value of the rightmost point of the circle.","line":310,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"The sum of the y minus the radius property. Changing the top property of a Circle object has no effect on the x and y properties, but does change the diameter.","inlineHelp":"Gets or sets the top of the circle.","line":337,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x coordinate of the center of the circle.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y coordinate of the center of the circle.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_diameter","type":["number"],"help":"","inlineHelp":"The diameter of the circle.","line":37,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_radius","type":["number"],"help":"","inlineHelp":"The radius of the circle.","line":45,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Color.json b/docgen/output/Phaser.Color.json deleted file mode 100644 index 24be1280b..000000000 --- a/docgen/output/Phaser.Color.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Color","extends":"","static":true,"constructor":false,"parameters":[],"help":"The Phaser.Color class is a set of static methods that assist in color manipulation and conversion."},"consts":[],"methods":{"public":[{"name":"HSLColorWheel","static":true,"returns":{"types":["array"],"help":"An array containing 360 elements corresponding to the HSL color wheel."},"help":"Get HSL color wheel values in an array which will be 360 elements in size.","line":667,"public":true,"protected":false,"private":false,"parameters":[{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":true,"default":"0.5"},{"name":"l","type":["number"],"help":"The lightness, in the range 0 - 1.","optional":true,"default":"0.5"}],"inherited":false,"inheritedFrom":""},{"name":"HSLtoRGB","static":true,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Converts an HSL (hue, saturation and lightness) color value to RGB.\\nConversion forumla from http:\/\/en.wikipedia.org\/wiki\/HSL_color_space.\\nAssumes HSL values are contained in the set [0, 1] and returns r, g and b values in the set [0, 255].\\nBased on code by Michael Jackson (https:\/\/github.com\/mjijackson)","line":217,"public":true,"protected":false,"private":false,"parameters":[{"name":"h","type":["number"],"help":"The hue, in the range 0 - 1.","optional":false,"default":null},{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":false,"default":null},{"name":"l","type":["number"],"help":"The lightness, in the range 0 - 1.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"HSVColorWheel","static":true,"returns":{"types":["array"],"help":"An array containing 360 elements corresponding to the HSV color wheel."},"help":"Get HSV color wheel values in an array which will be 360 elements in size.","line":642,"public":true,"protected":false,"private":false,"parameters":[{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":true,"default":"1"},{"name":"v","type":["number"],"help":"The value, in the range 0 - 1.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"HSVtoRGB","static":true,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Converts an HSV (hue, saturation and value) color value to RGB.\\nConversion forumla from http:\/\/en.wikipedia.org\/wiki\/HSL_color_space.\\nAssumes HSV values are contained in the set [0, 1] and returns r, g and b values in the set [0, 255].\\nBased on code by Michael Jackson (https:\/\/github.com\/mjijackson)","line":324,"public":true,"protected":false,"private":false,"parameters":[{"name":"h","type":["number"],"help":"The hue, in the range 0 - 1.","optional":false,"default":null},{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":false,"default":null},{"name":"v","type":["number"],"help":"The value, in the range 0 - 1.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"RGBtoHSL","static":true,"returns":{"types":["object"],"help":"An object with the hue, saturation and lightness values set in the h, s and l properties."},"help":"Converts an RGB color value to HSL (hue, saturation and lightness).\\nConversion forumla from http:\/\/en.wikipedia.org\/wiki\/HSL_color_space.\\nAssumes RGB values are contained in the set [0, 255] and returns h, s and l in the set [0, 1].\\nBased on code by Michael Jackson (https:\/\/github.com\/mjijackson)","line":158,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created, h, s and l. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"RGBtoHSV","static":true,"returns":{"types":["object"],"help":"An object with the hue, saturation and value set in the h, s and v properties."},"help":"Converts an RGB color value to HSV (hue, saturation and value).\\nConversion forumla from http:\/\/en.wikipedia.org\/wiki\/HSL_color_space.\\nAssumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].\\nBased on code by Michael Jackson (https:\/\/github.com\/mjijackson)","line":268,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created, h, s and v. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"RGBtoString","static":true,"returns":{"types":["string"],"help":"A string containing the color values. If prefix was '#' it will be in the format `#RRGGBB` otherwise `0xAARRGGBB`."},"help":"Converts the given color values into a string.\\nIf prefix was '#' it will be in the format `#RRGGBB` otherwise `0xAARRGGBB`.","line":513,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 255.","optional":true,"default":"255"},{"name":"prefix","type":["string"],"help":"The prefix used in the return string. If '#' it will return `#RRGGBB`, else `0xAARRGGBB`.","optional":true,"default":"'#'"}],"inherited":false,"inheritedFrom":""},{"name":"componentToHex","static":true,"returns":null,"help":"Return a string containing a hex representation of the given color component.","line":626,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"The color channel to get the hex value for, must be a value between 0 and 255.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createColor","static":true,"returns":{"types":["object"],"help":"The resulting object with r, g, b, a properties and h, s, l and v."},"help":"A utility function to create a lightweight 'color' object with the default components.\\nAny components that are not specified will default to zero.\\n\\nThis is useful when you want to use a shared color object for the getPixel and getPixelAt methods.","line":440,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":true,"default":"0"},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":true,"default":"0"},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":true,"default":"0"},{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 1.","optional":true,"default":"1"},{"name":"h","type":["number"],"help":"The hue, in the range 0 - 1.","optional":true,"default":"0"},{"name":"s","type":["number"],"help":"The saturation, in the range 0 - 1.","optional":true,"default":"0"},{"name":"l","type":["number"],"help":"The lightness, in the range 0 - 1.","optional":true,"default":"0"},{"name":"v","type":["number"],"help":"The value, in the range 0 - 1.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"fromRGBA","static":true,"returns":{"types":["object"],"help":"A color object."},"help":"A utility to convert an integer in 0xRRGGBBAA format to a color object.\\nThis does not rely on endianness.","line":108,"public":true,"protected":false,"private":false,"parameters":[{"name":"rgba","type":["number"],"help":"An RGBA hex","optional":false,"default":null},{"name":"out","type":["object"],"help":"The object to use, optional.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAlpha","static":true,"returns":null,"help":"Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component, as a value between 0 and 255.","line":861,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"In the format 0xAARRGGBB.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAlphaFloat","static":true,"returns":null,"help":"Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component as a value between 0 and 1.","line":873,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"In the format 0xAARRGGBB.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBlue","static":true,"returns":null,"help":"Given a native color value (in the format 0xAARRGGBB) this will return the Blue component, as a value between 0 and 255.","line":909,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"In the format 0xAARRGGBB.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getColor","static":true,"returns":null,"help":"Given 3 color values this will return an integer representation of it.","line":494,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getColor32","static":true,"returns":null,"help":"Given an alpha and 3 color values this will return an integer representation of it.","line":478,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 255.","optional":false,"default":null},{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getGreen","static":true,"returns":null,"help":"Given a native color value (in the format 0xAARRGGBB) this will return the Green component, as a value between 0 and 255.","line":897,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"In the format 0xAARRGGBB.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getRGB","static":true,"returns":null,"help":"Return the component parts of a color as an Object with the properties alpha, red, green, blue.\\n\\nAlpha will only be set if it exist in the given color (0xAARRGGBB)","line":799,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"Color in RGB (0xRRGGBB) or ARGB format (0xAARRGGBB).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getRandomColor","static":true,"returns":null,"help":"Returns a random color value between black and white\\nSet the min value to start each channel from the given offset.\\nSet the max value to restrict the maximum color used per channel.","line":769,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The lowest value to use for the color.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The highest value to use for the color.","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"The alpha value of the returning color (default 255 = fully opaque).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getRed","static":true,"returns":null,"help":"Given a native color value (in the format 0xAARRGGBB) this will return the Red component, as a value between 0 and 255.","line":885,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":" In the format 0xAARRGGBB.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getWebRGB","static":true,"returns":null,"help":"Returns a CSS friendly string value from the given color.","line":839,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number","object"],"help":"Color in RGB (0xRRGGBB), ARGB format (0xAARRGGBB) or an Object with r, g, b, a properties.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hexToColor","static":true,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Converts a hex string into a Phaser Color object.","line":557,"public":true,"protected":false,"private":false,"parameters":[{"name":"hex","type":["string"],"help":"The hex string to convert. Can be in the short-hand format `#03f` or `#0033ff`.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created or set: r, g and b. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hexToRGB","static":true,"returns":{"types":["number"],"help":"The rgb color value in the format 0xAARRGGBB."},"help":"Converts a hex string into an integer color value.","line":537,"public":true,"protected":false,"private":false,"parameters":[{"name":"hex","type":["string"],"help":"The hex string to convert. Can be in the short-hand format `#03f` or `#0033ff`.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hueToColor","static":true,"returns":{"types":["number"],"help":"The color component value."},"help":"Converts a hue to an RGB color.\\nBased on code by Michael Jackson (https:\/\/github.com\/mjijackson)","line":390,"public":true,"protected":false,"private":false,"parameters":[{"name":"p","type":["number"],"help":"","optional":false,"default":null},{"name":"q","type":["number"],"help":"","optional":false,"default":null},{"name":"t","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"interpolateColor","static":true,"returns":null,"help":"Interpolates the two given colours based on the supplied step and currentStep properties.","line":695,"public":true,"protected":false,"private":false,"parameters":[{"name":"color1","type":["number"],"help":"The first color value.","optional":false,"default":null},{"name":"color2","type":["number"],"help":"The second color value.","optional":false,"default":null},{"name":"steps","type":["number"],"help":"The number of steps to run the interpolation over.","optional":false,"default":null},{"name":"currentStep","type":["number"],"help":"The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"The alpha of the returned color.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"interpolateColorWithRGB","static":true,"returns":null,"help":"Interpolates the two given colours based on the supplied step and currentStep properties.","line":722,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"The first color value.","optional":false,"default":null},{"name":"r","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"steps","type":["number"],"help":"The number of steps to run the interpolation over.","optional":false,"default":null},{"name":"currentStep","type":["number"],"help":"The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"interpolateRGB","static":true,"returns":null,"help":"Interpolates the two given colours based on the supplied step and currentStep properties.","line":747,"public":true,"protected":false,"private":false,"parameters":[{"name":"r1","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"g1","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"b1","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"r2","type":["number"],"help":"The red color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"g2","type":["number"],"help":"The green color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"b2","type":["number"],"help":"The blue color value, between 0 and 0xFF (255).","optional":false,"default":null},{"name":"steps","type":["number"],"help":"The number of steps to run the interpolation over.","optional":false,"default":null},{"name":"currentStep","type":["number"],"help":"The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"packPixel","static":true,"returns":{"types":["number"],"help":"The packed color as uint32"},"help":"Packs the r, g, b, a components into a single integer, for use with Int32Array.\\nIf device is little endian then ABGR order is used. Otherwise RGBA order is used.","line":27,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 255.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toRGBA","static":true,"returns":{"types":["number"],"help":"A RGBA-packed 32 bit integer"},"help":"A utility to convert RGBA components to a 32 bit integer in RRGGBBAA format.","line":138,"public":true,"protected":false,"private":false,"parameters":[{"name":"r","type":["number"],"help":"The red color component, in the range 0 - 255.","optional":false,"default":null},{"name":"g","type":["number"],"help":"The green color component, in the range 0 - 255.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The blue color component, in the range 0 - 255.","optional":false,"default":null},{"name":"a","type":["number"],"help":"The alpha color component, in the range 0 - 255.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"unpackPixel","static":true,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Unpacks the r, g, b, a components into the specified color object, or a new\\nobject, for use with Int32Array. If little endian, then ABGR order is used when\\nunpacking, otherwise, RGBA order is used. The resulting color object has the\\n`r, g, b, a` properties which are unrelated to endianness.\\n\\nNote that the integer is assumed to be packed in the correct endianness. On little-endian\\nthe format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA. If you want a\\nendian-independent method, use fromRGBA(rgba) and toRGBA(r, g, b, a).","line":59,"public":true,"protected":false,"private":false,"parameters":[{"name":"rgba","type":["number"],"help":"The integer, packed in endian order by packPixel.","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.","optional":true,"default":null},{"name":"hsl","type":["boolean"],"help":"Also convert the rgb values into hsl?","optional":true,"default":"false"},{"name":"hsv","type":["boolean"],"help":"Also convert the rgb values into hsv?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"updateColor","static":true,"returns":null,"help":"Takes a color object and updates the rgba property.","line":459,"public":true,"protected":false,"private":false,"parameters":[{"name":"out","type":["object"],"help":"The color object to update.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"webToColor","static":true,"returns":{"types":["object"],"help":"An object with the red, green and blue values set in the r, g and b properties."},"help":"Converts a CSS 'web' string into a Phaser Color object.","line":597,"public":true,"protected":false,"private":false,"parameters":[{"name":"web","type":["string"],"help":"The web string in the format: 'rgba(r,g,b,a)'","optional":false,"default":null},{"name":"out","type":["object"],"help":"An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Device.json b/docgen/output/Phaser.Device.json deleted file mode 100644 index 1a9402c1c..000000000 --- a/docgen/output/Phaser.Device.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Device","extends":"","static":false,"constructor":true,"parameters":[],"help":"Detects device support capabilities. Using some elements from System.js by MrDoob and Modernizr"},"consts":[],"methods":{"public":[{"name":"canPlayAudio","static":false,"returns":{"types":["boolean"],"help":"True if the given file type is supported by the browser, otherwise false."},"help":"Check whether the host environment can play audio.","line":882,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"One of 'mp3, 'ogg', 'm4a', 'wav', 'webm' or 'opus'.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkFullScreenSupport","static":false,"returns":null,"help":"Checks for support of the Full Screen API.","line":526,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isConsoleOpen","static":false,"returns":{"types":["boolean"],"help":"True if the browser dev console is open."},"help":"Check whether the console is open.\\nNote that this only works in Firefox with Firebug and earlier versions of Chrome.\\nIt used to work in Chrome, but then they removed the ability: http:\/\/src.chromium.org\/viewvc\/blink?view=revision&revision=151136","line":921,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_checkAudio","static":false,"returns":null,"help":"Check audio support.","line":701,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkBrowser","static":false,"returns":null,"help":"Check what browser is game running in.","line":586,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkCSS3D","static":false,"returns":null,"help":"Check whether the host environment support 3D CSS.","line":847,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkDevice","static":false,"returns":null,"help":"Check PixelRatio, iOS device, Vibration API, ArrayBuffers and endianess.","line":748,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkFeatures","static":false,"returns":null,"help":"Check HTML5 features of the host environment.","line":478,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkIsLittleEndian","static":false,"returns":null,"help":"Check Little or Big Endian system.","line":787,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkIsUint8ClampedImageData","static":false,"returns":null,"help":"Test to see if ImageData uses CanvasPixelArray or Uint8ClampedArray.","line":821,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkOS","static":false,"returns":null,"help":"Check which OS is game running on.","line":416,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"android","type":["boolean"],"help":"","inlineHelp":"Is running on android?","line":80,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"arora","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Arora.","line":204,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"audioData","type":["boolean"],"help":"","inlineHelp":"Are Audio tags available?","line":290,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cancelFullscreen","type":["string"],"help":"","inlineHelp":"If the browser supports the Full Screen API this holds the call you need to use to cancel it.","line":389,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["boolean"],"help":"","inlineHelp":"Is canvas available?","line":118,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"chrome","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Chrome.","line":210,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"chromeOS","type":["boolean"],"help":"","inlineHelp":"Is running on chromeOS?","line":86,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cocoonJS","type":["boolean"],"help":"","inlineHelp":"Is the game running under CocoonJS?","line":38,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cocoonJSApp","type":["boolean"],"help":"","inlineHelp":"Is this game running with CocoonJS.App?","line":44,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cordova","type":["boolean"],"help":"","inlineHelp":"Is the game running under Apache Cordova?","line":50,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"crosswalk","type":["boolean"],"help":"","inlineHelp":"Is the game running under the Intel Crosswalk XDK?","line":74,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"css3D","type":["boolean"],"help":"","inlineHelp":"Is css3D available?","line":166,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"desktop","type":["boolean"],"help":"","inlineHelp":"Is running desktop?","line":26,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ejecta","type":["boolean"],"help":"","inlineHelp":"Is the game running under Ejecta?","line":68,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"epiphany","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Epiphany.","line":216,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"file","type":["boolean"],"help":"","inlineHelp":"Is file available?","line":124,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fileSystem","type":["boolean"],"help":"","inlineHelp":"Is fileSystem available?","line":130,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"firefox","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Firefox.","line":222,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fullscreen","type":["boolean"],"help":"","inlineHelp":"Does the browser support the Full Screen API?","line":377,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fullscreenKeyboard","type":["boolean"],"help":"","inlineHelp":"Does the browser support access to the Keyboard during Full Screen mode?","line":395,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":18,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"getUserMedia","type":["boolean"],"help":"","inlineHelp":"Does the device support the getUserMedia API?","line":190,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iOS","type":["boolean"],"help":"","inlineHelp":"Is running on iOS?","line":32,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPad","type":["boolean"],"help":"","inlineHelp":"Is running on iPad?","line":353,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPhone","type":["boolean"],"help":"","inlineHelp":"Is running on iPhone?","line":341,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPhone4","type":["boolean"],"help":"","inlineHelp":"Is running on iPhone4?","line":347,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ie","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Internet Explorer.","line":228,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ieVersion","type":["number"],"help":"","inlineHelp":"If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Device.trident and Device.tridentVersion.","line":234,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"linux","type":["boolean"],"help":"","inlineHelp":"Is running on linux?","line":92,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"littleEndian","type":["boolean"],"help":"","inlineHelp":"Is the device big or little endian? (only detected if the browser supports TypedArrays)","line":365,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"localStorage","type":["boolean"],"help":"","inlineHelp":"Is localStorage available?","line":136,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"m4a","type":["boolean"],"help":"Can this device play m4a files?","inlineHelp":"True if this device can play m4a files.","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"macOS","type":["boolean"],"help":"","inlineHelp":"Is running on macOS?","line":98,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"midori","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Midori.","line":258,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mobileSafari","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Mobile Safari.","line":252,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mp3","type":["boolean"],"help":"","inlineHelp":"Can this device play mp3 files?","line":314,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mspointer","type":["boolean"],"help":"","inlineHelp":"Is mspointer available?","line":160,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"node","type":["boolean"],"help":"","inlineHelp":"Is the game running under Node.js?","line":56,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"nodeWebkit","type":["boolean"],"help":"","inlineHelp":"Is the game running under Node-Webkit?","line":62,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ogg","type":["boolean"],"help":"","inlineHelp":"Can this device play ogg files?","line":302,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"opera","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Opera.","line":264,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"opus","type":["boolean"],"help":"","inlineHelp":"Can this device play opus files?","line":308,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixelRatio","type":["number"],"help":"","inlineHelp":"PixelRatio of the host device?","line":359,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointerLock","type":["boolean"],"help":"","inlineHelp":"Is Pointer Lock available?","line":172,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"quirksMode","type":["boolean"],"help":"","inlineHelp":"Is the browser running in strict mode (false) or quirks mode? (true)","line":196,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"requestFullscreen","type":["string"],"help":"","inlineHelp":"If the browser supports the Full Screen API this holds the call you need to use to activate it.","line":383,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"safari","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Safari.","line":270,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"silk","type":["boolean"],"help":"","inlineHelp":"Set to true if running in the Silk browser (as used on the Amazon Kindle)","line":282,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"support32bit","type":["boolean"],"help":"","inlineHelp":"Does the device context support 32bit pixel manipulation using array buffer views?","line":371,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"touch","type":["boolean"],"help":"","inlineHelp":"Is touch available?","line":154,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"trident","type":["boolean"],"help":"","inlineHelp":"Set to true if running a Trident version of Internet Explorer (IE11+)","line":240,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"tridentVersion","type":["number"],"help":"","inlineHelp":"If running in Internet Explorer 11 this will contain the major version number. See http:\/\/msdn.microsoft.com\/en-us\/library\/ie\/ms537503(v=vs.85).aspx","line":246,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"typedArray","type":["boolean"],"help":"","inlineHelp":"Does the browser support TypedArrays?","line":178,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"vibration","type":["boolean"],"help":"","inlineHelp":"Does the device support the Vibration API?","line":184,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"wav","type":["boolean"],"help":"","inlineHelp":"Can this device play wav files?","line":320,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webApp","type":["boolean"],"help":"","inlineHelp":"Set to true if running as a WebApp, i.e. within a WebView","line":276,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webAudio","type":["boolean"],"help":"","inlineHelp":"Is the WebAudio API available?","line":296,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webGL","type":["boolean"],"help":"","inlineHelp":"Is webGL available?","line":142,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webm","type":["boolean"],"help":"","inlineHelp":"Can this device play webm files?","line":333,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"windows","type":["boolean"],"help":"","inlineHelp":"Is running on windows?","line":104,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"windowsPhone","type":["boolean"],"help":"","inlineHelp":"Is running on a Windows Phone?","line":110,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"worker","type":["boolean"],"help":"","inlineHelp":"Is worker available?","line":148,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Easing.json b/docgen/output/Phaser.Easing.json deleted file mode 100644 index e6ae3cc18..000000000 --- a/docgen/output/Phaser.Easing.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Easing","extends":"","static":true,"constructor":false,"parameters":[],"help":"A collection of easing methods defining ease-in and ease-out curves."},"consts":[],"methods":{"public":[{"name":"In","static":false,"returns":null,"help":"Bounce ease-in.","line":512,"public":true,"protected":false,"private":false,"parameters":[{"name":"k","type":["number"],"help":"The value to be tweened.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"InOut","static":false,"returns":null,"help":"Bounce ease-in\/out.","line":554,"public":true,"protected":false,"private":false,"parameters":[{"name":"k","type":["number"],"help":"The value to be tweened.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"None","static":false,"returns":null,"help":"Linear Easing (no variation).","line":30,"public":true,"protected":false,"private":false,"parameters":[{"name":"k","type":["number"],"help":"The value to be tweened.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"Out","static":false,"returns":null,"help":"Bounce ease-out.","line":525,"public":true,"protected":false,"private":false,"parameters":[{"name":"k","type":["number"],"help":"The value to be tweened.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Ellipse.json b/docgen/output/Phaser.Ellipse.json deleted file mode 100644 index 5f9de2183..000000000 --- a/docgen/output/Phaser.Ellipse.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Ellipse","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The overall width of this ellipse.","optional":true,"default":"0"},{"name":"height","type":["number"],"help":"The overall height of this ellipse.","optional":true,"default":"0"}],"help":"Creates a Ellipse object. A curve on a plane surrounding two focal points."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"The cloned Ellipse object."},"help":"Returns a new Ellipse object with the same values for the x, y, width, and height properties as this Ellipse object.","line":117,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Ellipse"],"help":"Optional Ellipse object. If given the values will be set into the object, otherwise a brand new Ellipse object will be created and returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this ellipse, otherwise false."},"help":"Return true if the given x\/y coordinates are within the Ellipse object.","line":275,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Ellipse"],"help":"The Ellipse to be checked.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The X value of the coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y value of the coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyFrom","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"This Ellipse object."},"help":"Copies the x, y, width and height properties from any given object to this Ellipse.","line":88,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyTo","static":false,"returns":{"types":["object"],"help":"This dest object."},"help":"Copies the x, y, width and height properties from this Ellipse to any given object.","line":100,"public":true,"protected":false,"private":false,"parameters":[{"name":"dest","type":["any"],"help":"The object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The framing rectangle"},"help":"Returns the framing rectangle of the ellipse as a Phaser.Rectangle object.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Ellipse"],"help":"This Ellipse object."},"help":"Sets the members of the Ellipse to the specified values.","line":60,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The overall width of this ellipse.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The overall height of this ellipse.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"A string representation of the instance."},"help":"Returns a string representation of this object.","line":150,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"The sum of the y and height properties. Changing the bottom property of an Ellipse doesn't adjust the y property, but does change the height.","inlineHelp":"Gets or sets the bottom of the ellipse.","line":224,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"empty","type":["boolean"],"help":"Determines whether or not this Ellipse object is empty. Will return a value of true if the Ellipse objects dimensions are less than or equal to 0; otherwise false.\\nIf set to true it will reset all of the Ellipse objects properties to 0. An Ellipse object is empty if its width or height is less than or equal to 0.","inlineHelp":"Gets or sets the empty state of the ellipse.","line":250,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The overall height of this ellipse.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"The x coordinate of the rightmost point of the Ellipse. Changing the right property of an Ellipse object has no effect on the x property, but does adjust the width.","inlineHelp":"Gets or sets the value of the rightmost point of the ellipse.","line":182,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"The top of the Ellipse. The same as its y property.","inlineHelp":"Gets or sets the top of the ellipse.","line":207,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The overall width of this ellipse.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The X coordinate of the upper-left corner of the framing rectangle of this ellipse.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Events.json b/docgen/output/Phaser.Events.json deleted file mode 100644 index c1f6e083f..000000000 --- a/docgen/output/Phaser.Events.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Events","extends":"","static":false,"constructor":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"A reference to the Sprite that owns this Events object.","optional":false,"default":null}],"help":"The Events component is a collection of events fired by the parent game object.\\n\\nFor example to tell when a Sprite has been added to a new group:\\n\\n`sprite.events.onAddedToGroup.add(yourFunction, this);`\\n\\nWhere `yourFunction` is the function you want called when this event occurs.\\n\\nNote that the Input related events only exist if the Sprite has had `inputEnabled` set to `true`."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Removes all events.","line":127,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"onAddedToGroup","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is added to a new Group.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onAnimationComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent has an animation that finishes playing.","line":110,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onAnimationLoop","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent has an animation that loops playback.","line":116,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onAnimationStart","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent has an animation that is played.","line":104,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDragStart","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives a drag start event from a Pointer.","line":92,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDragStop","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives a drag stop event from a Pointer.","line":98,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onEnterBounds","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent returns within the world bounds (only if Sprite.checkWorldBounds is true).","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputDown","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives a down event from a Pointer.","line":80,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputOut","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives an out event from a Pointer.","line":74,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputOver","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives an over event from a Pointer.","line":68,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInputUp","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched if the parent is inputEnabled and receives an up event from a Pointer.","line":86,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onKilled","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is killed.","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onOutOfBounds","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent leaves the world bounds (only if Sprite.checkWorldBounds is true).","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onRemovedFromGroup","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is removed from a Group.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onRevived","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is revived.","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Sprite"],"help":"","inlineHelp":"The Sprite that owns these events.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Filter.json b/docgen/output/Phaser.Filter.json deleted file mode 100644 index 209ec4473..000000000 --- a/docgen/output/Phaser.Filter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Filter","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"uniforms","type":["object"],"help":"Uniform mappings object","optional":false,"default":null},{"name":"fragmentSrc","type":["array"],"help":"The fragment shader code.","optional":false,"default":null}],"help":"This is a base Filter class to use for any Phaser filter development."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Clear down this Filter and null out references","line":150,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"Should be over-ridden.","line":105,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setResolution","static":false,"returns":null,"help":"Set the resolution uniforms on the filter.","line":115,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the display.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the display.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates the filter.","line":127,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"A Pointer object to use for the filter. The coordinates are mapped to the mouse uniform.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"Internal PIXI var.","line":47,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fragmentSrc","type":["array"],"help":"","inlineHelp":"The fragment shader code.","line":95,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height (resolution uniform)","line":180,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"Internal PIXI var.","line":53,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"prevPoint","type":["Phaser.Point"],"help":"","inlineHelp":"The previous position of the pointer (we don't update the uniform if the same)","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object, either Phaser.WEBGL_FILTER or Phaser.CANVAS_FILTER.","line":27,"default":"Phaser.WEBGL_FILTER","public":true,"protected":false,"private":false,"readOnly":false},{"name":"uniforms","type":["object"],"help":"","inlineHelp":"Default uniform mappings. Compatible with ShaderToy and GLSLSandbox.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width (resolution uniform)","line":164,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"passes","type":["array"],"help":"An array of passes - some filters contain a few steps this array simply stores the steps in a linear fashion.\\nFor example the blur filter has two passes blurX and blurY.","inlineHelp":"An array of filter objects.","line":35,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"shaders","type":["array"],"help":"","inlineHelp":"Array an array of shaders.","line":41,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.FlexGrid.json b/docgen/output/Phaser.FlexGrid.json deleted file mode 100644 index f8c59cdc7..000000000 --- a/docgen/output/Phaser.FlexGrid.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.FlexGrid","extends":"","static":false,"constructor":true,"parameters":[{"name":"manager","type":["Phaser.ScaleManager"],"help":"The ScaleManager.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the game.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the game.","optional":false,"default":null}],"help":"WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.\\nPlease try to avoid using in production games with a long time to build.\\nThis is also why the documentation is incomplete.\\n\\nFlexGrid is a a responsive grid manager that works in conjunction with the ScaleManager RESIZE scaling mode and FlexLayers\\nto provide for game object positioning in a responsive manner."},"consts":[],"methods":{"public":[{"name":"createCustomLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A custom layer is centered on the game and maintains its aspect ratio as it scales up and down.","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"Width of this layer in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of this layer in pixels.","optional":false,"default":null},{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFixedLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A fixed layer is centered on the game and is the size of the required dimensions and is never scaled.","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFluidLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A fluid layer is centered on the game and maintains its aspect ratio as it scales up and down.","line":148,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFullLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A full layer is placed at 0,0 and extends to the full size of the game. Children are scaled according to the fluid ratios.","line":177,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"debug","static":false,"returns":null,"help":"Call in the render function to output the bounds rects.","line":304,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onResize","static":false,"returns":null,"help":"Called when the game container changes dimensions.","line":247,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The new width of the game container.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The new height of the game container.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"refresh","static":false,"returns":null,"help":"Updates all internal vars such as the bounds and scale values.","line":258,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the layer children references","line":223,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"Sets the core game size. This resets the w\/h parameters and bounds.","line":84,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The new dimensions.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The new dimensions.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"A reference to the ScaleManager.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleFactor","type":["Phaser.Point"],"help":"","inlineHelp":"The scale factor based on the game dimensions vs. the scaled dimensions.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.FlexLayer.json b/docgen/output/Phaser.FlexLayer.json deleted file mode 100644 index cb1adba9c..000000000 --- a/docgen/output/Phaser.FlexLayer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.FlexLayer","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"manager","type":["Phaser.ScaleManager"],"help":"The ScaleManager.","optional":false,"default":null},{"name":"position","type":["Phaser.Point"],"help":"A reference to the Point object used for positioning.","optional":false,"default":null},{"name":"bounds","type":["Phaser.Rectangle"],"help":"A reference to the Rectangle used for the layer bounds.","optional":false,"default":null},{"name":"scale","type":["Phaser.Point"],"help":"A reference to the Point object used for layer scaling.","optional":false,"default":null}],"help":"WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.\\nPlease try to avoid using in production games with a long time to build.\\nThis is also why the documentation is incomplete.\\n\\nA responsive grid layer."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"grid","type":["Phaser.FlexGrid"],"help":"","inlineHelp":"A reference to the FlexGrid that owns this layer.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A name for this Group. Not used internally but useful for debugging.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"A reference to the ScaleManager.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The x coordinate of the Group container.","line":1865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The y coordinate of the Group container.","line":1872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Frame.json b/docgen/output/Phaser.Frame.json deleted file mode 100644 index 2699df37d..000000000 --- a/docgen/output/Phaser.Frame.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Frame","extends":"","static":false,"constructor":true,"parameters":[{"name":"index","type":["number"],"help":"The index of this Frame within the FrameData set it is being added to.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the frame within the texture image.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the frame within the texture image.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the frame within the texture image.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the frame within the texture image.","optional":false,"default":null},{"name":"name","type":["string"],"help":"The name of the frame. In Texture Atlas data this is usually set to the filename.","optional":false,"default":null},{"name":"uuid","type":["string"],"help":"Internal UUID key.","optional":false,"default":null}],"help":"A Frame is a single frame of an animation and is part of a FrameData collection."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Frame"],"help":"An exact copy of this Frame object."},"help":"Clones this Frame into a new Phaser.Frame object and returns it.\\nNote that all properties are cloned, including the name, index and UUID.","line":175,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getRect","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"A rectangle."},"help":"Returns a Rectangle set to the dimensions of this Frame.","line":198,"public":true,"protected":false,"private":false,"parameters":[{"name":"out","type":["Phaser.Rectangle"],"help":"A rectangle to copy the frame dimensions to.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTrim","static":false,"returns":null,"help":"If the frame was trimmed when added to the Texture Atlas this records the trim and source data.","line":150,"public":true,"protected":false,"private":false,"parameters":[{"name":"trimmed","type":["boolean"],"help":"If this frame was trimmed or not.","optional":false,"default":null},{"name":"actualWidth","type":["number"],"help":"The width of the frame before being trimmed.","optional":false,"default":null},{"name":"actualHeight","type":["number"],"help":"The height of the frame before being trimmed.","optional":false,"default":null},{"name":"destX","type":["number"],"help":"The destination X position of the trimmed frame for display.","optional":false,"default":null},{"name":"destY","type":["number"],"help":"The destination Y position of the trimmed frame for display.","optional":false,"default":null},{"name":"destWidth","type":["number"],"help":"The destination width of the trimmed frame for display.","optional":false,"default":null},{"name":"destHeight","type":["number"],"help":"The destination height of the trimmed frame for display.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"","inlineHelp":"The bottom of the frame (y + height).","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerX","type":["number"],"help":"","inlineHelp":"Center X position within the image to cut from.","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerY","type":["number"],"help":"","inlineHelp":"Center Y position within the image to cut from.","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"distance","type":["number"],"help":"","inlineHelp":"The distance from the top left to the bottom-right of this Frame.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Height of the frame.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The index of this Frame within the FrameData set it is being added to.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"Useful for Texture Atlas files (is set to the filename value).","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The right of the Frame (x + width).","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotated","type":["boolean"],"help":"","inlineHelp":"Rotated? (not yet implemented)","line":76,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotationDirection","type":["string"],"help":"","inlineHelp":"Either 'cw' or 'ccw', rotation is always 90 degrees.","line":82,"default":"'cw'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceSizeH","type":["number"],"help":"","inlineHelp":"Height of the original sprite.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceSizeW","type":["number"],"help":"","inlineHelp":"Width of the original sprite.","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeH","type":["number"],"help":"","inlineHelp":"Height of the trimmed sprite.","line":122,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeW","type":["number"],"help":"","inlineHelp":"Width of the trimmed sprite.","line":116,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeX","type":["number"],"help":"","inlineHelp":"X position of the trimmed sprite inside original sprite.","line":104,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeY","type":["number"],"help":"","inlineHelp":"Y position of the trimmed sprite inside original sprite.","line":110,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"trimmed","type":["boolean"],"help":"","inlineHelp":"Was it trimmed when packed?","line":88,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"uuid","type":["string"],"help":"","inlineHelp":"DEPRECATED: A link to the PIXI.TextureCache entry.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"Width of the frame.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"X position within the image to cut from.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"Y position within the image to cut from.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.FrameData.json b/docgen/output/Phaser.FrameData.json deleted file mode 100644 index 560e4c952..000000000 --- a/docgen/output/Phaser.FrameData.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.FrameData","extends":"","static":false,"constructor":true,"parameters":[],"help":"FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser."},"consts":[],"methods":{"public":[{"name":"addFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame that was just added."},"help":"Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.","line":39,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The frame to add to this FrameData set.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkFrameName","static":false,"returns":{"types":["boolean"],"help":"True if the frame is found, otherwise false."},"help":"Check if there is a Frame with the given name.","line":97,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the frame you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clone","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A clone of this object, including clones of the Frame objects it contains."},"help":"Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.","line":114,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame, if found."},"help":"Get a Frame by its numerical index.","line":61,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the frame you want to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByName","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame, if found."},"help":"Get a Frame by its frame name.","line":79,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the frame you want to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameIndexes","static":false,"returns":{"types":["array"],"help":"An array of all Frame indexes matching the given names or IDs."},"help":"Returns all of the Frame indexes in this FrameData set.\\nThe frames indexes are returned in the output array, or if none is provided in a new Array object.","line":212,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.","optional":false,"default":null},{"name":"useNumericIndex","type":["boolean"],"help":"Are the given frames using numeric indexes (default) or strings? (false)","optional":true,"default":"true"},{"name":"output","type":["array"],"help":"If given the results will be appended to the end of this array otherwise a new array will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameRange","static":false,"returns":{"types":["array"],"help":"An array of Frames between the start and end index values, or an empty array if none were found."},"help":"Returns a range of frames based on the given start and end frame indexes and returns them in an Array.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"start","type":["number"],"help":"The starting frame index.","optional":false,"default":null},{"name":"end","type":["number"],"help":"The ending frame index.","optional":false,"default":null},{"name":"output","type":["array"],"help":"If given the results will be appended to the end of this array otherwise a new array will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrames","static":false,"returns":{"types":["array"],"help":"An array of all Frames in this FrameData set matching the given names or IDs."},"help":"Returns all of the Frames in this FrameData set where the frame index is found in the input array.\\nThe frames are returned in the output array, or if none is provided in a new Array object.","line":165,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.","optional":false,"default":null},{"name":"useNumericIndex","type":["boolean"],"help":"Are the given frames using numeric indexes (default) or strings? (false)","optional":true,"default":"true"},{"name":"output","type":["array"],"help":"If given the results will be appended to the end of this array otherwise a new array will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of frames in this FrameData set.","line":258,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_frameNames","type":["array"],"help":"","inlineHelp":"Local array of frame names for name to index conversions.","line":26,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frames","type":["array"],"help":"","inlineHelp":"Local array of frames.","line":19,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Game.json b/docgen/output/Phaser.Game.json deleted file mode 100644 index 712d0a923..000000000 --- a/docgen/output/Phaser.Game.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Game","extends":"","static":false,"constructor":true,"parameters":[{"name":"width","type":["number","string"],"help":"The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.","optional":true,"default":"800"},{"name":"height","type":["number","string"],"help":"The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.","optional":true,"default":"600"},{"name":"renderer","type":["number"],"help":"Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).","optional":true,"default":"Phaser.AUTO"},{"name":"parent","type":["string","HTMLElement"],"help":"The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.","optional":true,"default":"''"},{"name":"state","type":["object"],"help":"The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.","optional":true,"default":"null"},{"name":"transparent","type":["boolean"],"help":"Use a transparent canvas background or not.","optional":true,"default":"false"},{"name":"antialias","type":["boolean"],"help":"Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.","optional":true,"default":"true"},{"name":"physicsConfig","type":["object"],"help":"A physics configuration object to pass to the Physics world on creation.","optional":true,"default":"null"}],"help":"This is where the magic happens. The Game object is the heart of your game,\\nproviding quick access to common functions and handling the boot process.\\n\"Hell, there are no rules here - we're trying to accomplish something.\"\\nThomas A. Edison"},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Nukes the entire game from orbit.","line":752,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableStep","static":false,"returns":null,"help":"Disables core game loop stepping.","line":727,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"enableStep","static":false,"returns":null,"help":"Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?)\\nCalling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!","line":714,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"step","static":false,"returns":null,"help":"When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame.\\nThis is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.","line":740,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Initialize engine sub modules and start the game.","line":421,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"focusGain","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":844,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused the game to pause, if any.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"focusLoss","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":826,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused the game to pause, if any.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"gamePaused","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":785,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused the game to pause, if any.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"gameResumed","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":805,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused the game to pause, if any.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"parseConfig","static":false,"returns":null,"help":"Parses a Game configuration object.","line":346,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setUpRenderer","static":false,"returns":null,"help":"Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.","line":569,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"showDebugHeader","static":false,"returns":null,"help":"Displays a Phaser version debug header in the console.","line":507,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"The core game loop.","line":645,"public":false,"protected":true,"private":false,"parameters":[{"name":"time","type":["number"],"help":"The current time as provided by RequestAnimationFrame.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"add","type":["Phaser.GameObjectFactory"],"help":"","inlineHelp":"Reference to the Phaser.GameObjectFactory.","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"antialias","type":["boolean"],"help":"","inlineHelp":"Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally.","line":69,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cache","type":["Phaser.Cache"],"help":"","inlineHelp":"Reference to the assets cache.","line":122,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"camera","type":["Phaser.Camera"],"help":"","inlineHelp":"A handy reference to world.camera.","line":192,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"","inlineHelp":"A handy reference to renderer.view, the canvas that the game is being rendered in to.","line":197,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"config","type":["object"],"help":"","inlineHelp":"The Phaser.Game configuration object.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"A handy reference to renderer.context (only set for CANVAS games, not WebGL)","line":202,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["Phaser.Utils.Debug"],"help":"","inlineHelp":"A set of useful debug utilitie.","line":207,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"device","type":["Phaser.Device"],"help":"","inlineHelp":"Contains device information and capabilities.","line":187,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The calculated game height in pixels.","line":57,"default":"600","public":true,"protected":false,"private":false,"readOnly":false},{"name":"id","type":["boolean"],"help":"","inlineHelp":"Is game running or paused?","line":102,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.Input"],"help":"","inlineHelp":"Reference to the input manager","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isBooted","type":["boolean"],"help":"","inlineHelp":"Whether the game engine is booted, aka available.","line":96,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"load","type":["Phaser.Loader"],"help":"","inlineHelp":"Reference to the assets loader.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"make","type":["Phaser.GameObjectCreator"],"help":"","inlineHelp":"Reference to the GameObject Creator.","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"math","type":["Phaser.Math"],"help":"","inlineHelp":"Reference to the math helper.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"net","type":["Phaser.Net"],"help":"","inlineHelp":"Reference to the network class.","line":142,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onBlur","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is fired when the game no longer has focus (typically on page hide).","line":248,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFocus","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is fired when the game has focus (typically on page show).","line":253,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPause","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is fired when the game pauses.","line":238,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResume","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is fired when the game resumes from a paused state.","line":243,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["string","HTMLElement"],"help":"","inlineHelp":"The Games DOM parent.","line":45,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"particles","type":["Phaser.Particles"],"help":"","inlineHelp":"The Particle Manager.","line":212,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"The paused state of the Game. A paused game doesn't update any of its subsystems.\\nWhen a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched.","inlineHelp":"Gets and sets the paused state of the Game.","line":865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pendingStep","type":["boolean"],"help":"","inlineHelp":"An internal property used by enableStep, but also useful to query from your own game objects.","line":226,"default":"false","public":true,"protected":false,"private":false,"readOnly":true},{"name":"physics","type":["Phaser.Physics"],"help":"","inlineHelp":"Reference to the physics manager.","line":177,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsConfig","type":["object"],"help":"","inlineHelp":"The Phaser.Physics.World configuration object.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preserveDrawingBuffer","type":["boolean"],"help":"","inlineHelp":"The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.","line":75,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"raf","type":["Phaser.RequestAnimationFrame"],"help":"","inlineHelp":"Automatically handles the core game loop via requestAnimationFrame or setTimeout","line":107,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderType","type":["number"],"help":"","inlineHelp":"The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS or Phaser.WEBGL.","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"","inlineHelp":"The Pixi Renderer.","line":80,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rnd","type":["Phaser.RandomDataGenerator"],"help":"","inlineHelp":"Instance of repeatable random data generator helper.","line":182,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"The game scale manager.","line":147,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sound","type":["Phaser.SoundManager"],"help":"","inlineHelp":"Reference to the sound manager.","line":152,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["Phaser.Stage"],"help":"","inlineHelp":"Reference to the stage.","line":157,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"state","type":["Phaser.StateManager"],"help":"","inlineHelp":"The StateManager.","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stepCount","type":["number"],"help":"","inlineHelp":"When stepping is enabled this contains the current step cycle.","line":233,"default":"0","public":true,"protected":false,"private":false,"readOnly":true},{"name":"stepping","type":["boolean"],"help":"","inlineHelp":"Enable core loop stepping with Game.enableStep().","line":219,"default":"false","public":true,"protected":false,"private":false,"readOnly":true},{"name":"time","type":["Phaser.Time"],"help":"","inlineHelp":"Reference to the core game clock.","line":162,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"transparent","type":["boolean"],"help":"","inlineHelp":"Use a transparent canvas background or not.","line":63,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"tweens","type":["Phaser.TweenManager"],"help":"","inlineHelp":"Reference to the tween manager.","line":167,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The calculated game width in pixels.","line":51,"default":"800","public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"Reference to the world.","line":172,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_codePaused","type":["boolean"],"help":"","inlineHelp":"Was the game paused via code or a visibility change?","line":265,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_paused","type":["boolean"],"help":"","inlineHelp":"Is game paused?","line":259,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.GameObjectCreator.json b/docgen/output/Phaser.GameObjectCreator.json deleted file mode 100644 index ece5943b1..000000000 --- a/docgen/output/Phaser.GameObjectCreator.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.GameObjectCreator","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Game Object Creator is a quick way to create all of the different sorts of core objects that Phaser uses, but not add them to the game world.\\nUse the GameObjectFactory to create and add the objects into the world."},"consts":[],"methods":{"public":[{"name":"audio","static":false,"returns":{"types":["Phaser.Sound"],"help":"The newly created text object."},"help":"Creates a new Sound object.","line":122,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"The volume at which the sound will be played.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"},{"name":"connect","type":["boolean"],"help":"Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"audioSprite","static":false,"returns":{"types":["Phaser.AudioSprite"],"help":"The newly created AudioSprite object."},"help":"Creates a new AudioSprite object.","line":135,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"bitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The newly created BitmapData object."},"help":"A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.","line":360,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the BitmapData in pixels.","optional":true,"default":"256"},{"name":"height","type":["number"],"help":"The height of the BitmapData in pixels.","optional":true,"default":"256"},{"name":"key","type":["string"],"help":"Asset key for the BitmapData when stored in the Cache (see addToCache parameter).","optional":true,"default":"''"},{"name":"addToCache","type":["boolean"],"help":"Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"bitmapText","static":false,"returns":{"types":["Phaser.BitmapText"],"help":"The newly created bitmapText object."},"help":"Create a new BitmapText object.","line":298,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new bitmapText object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new bitmapText object.","optional":false,"default":null},{"name":"font","type":["string"],"help":"The key of the BitmapText font as stored in Game.Cache.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be rendered. Can be set later via BitmapText.text.","optional":true,"default":null},{"name":"size","type":["number"],"help":"The size the font will be rendered in, in pixels.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"button","static":false,"returns":{"types":["Phaser.Button"],"help":"The newly created button object."},"help":"Creates a new Button object.","line":224,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":" X position of the new button object.","optional":true,"default":null},{"name":"y","type":["number"],"help":" Y position of the new button object.","optional":true,"default":null},{"name":"key","type":["string"],"help":" The image key as defined in the Game.Cache to use as the texture for this button.","optional":true,"default":null},{"name":"callback","type":["function"],"help":" The function to call when this button is pressed","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":" The context in which the callback will be called (usually 'this')","optional":true,"default":null},{"name":"overFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"outFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"downFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"upFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"emitter","static":false,"returns":{"types":["Phaser.Emitter"],"help":"The newly created emitter object."},"help":"Emitter is a lightweight particle emitter. It can be used for one-time explosions or for\\ncontinuous effects like rain and fire. All it really does is launch Particle objects out\\nat set intervals, and fixes their positions and velocities accorindgly.","line":255,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"maxParticles","type":["number"],"help":"The total number of particles in this emitter.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"filter","static":false,"returns":{"types":["Phaser.Filter"],"help":"The newly created Phaser.Filter object."},"help":"A WebGL shader\/filter that can be applied to Sprites.","line":384,"public":true,"protected":false,"private":false,"parameters":[{"name":"filter","type":["string"],"help":"The name of the filter you wish to create, for example HueRotate or SineWave.","optional":false,"default":null},{"name":"-","type":["any"],"help":" Whatever parameters are needed to be passed to the filter init function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"graphics","static":false,"returns":{"types":["Phaser.Graphics"],"help":"The newly created graphics object."},"help":"Creates a new Graphics object.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new graphics object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new graphics object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"group","static":false,"returns":{"types":["Phaser.Group"],"help":"The newly created Group."},"help":"A Group is a container for display objects that allows for fast pooling, recycling and collision checks.","line":88,"public":true,"protected":false,"private":false,"parameters":[{"name":"parent","type":["any"],"help":"The parent Group or DisplayObjectContainer that will hold this group, if any.","optional":false,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"'group'"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"},{"name":"enableBody","type":["boolean"],"help":"If true all Sprites created with `Group.create` or `Group.createMulitple` will have a physics body created on them. Change the body type with physicsBodyType.","optional":true,"default":"false"},{"name":"physicsBodyType","type":["number"],"help":"If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"image","static":false,"returns":null,"help":"Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.\\nIt can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.","line":42,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the image.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the image.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderTexture","static":false,"returns":{"types":["Phaser.RenderTexture"],"help":"The newly created RenderTexture object."},"help":"A dynamic initially blank canvas to which images can be drawn.","line":334,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the width of the RenderTexture.","optional":true,"default":"100"},{"name":"height","type":["number"],"help":"the height of the RenderTexture.","optional":true,"default":"100"},{"name":"key","type":["string"],"help":"Asset key for the RenderTexture when stored in the Cache (see addToCache parameter).","optional":true,"default":"''"},{"name":"addToCache","type":["boolean"],"help":"Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"retroFont","static":false,"returns":{"types":["Phaser.RetroFont"],"help":"The newly created RetroFont texture which can be applied to an Image or Sprite."},"help":"Create a new RetroFont object to be used as a texture for an Image or Sprite and optionally add it to the Cache.\\nA RetroFont uses a bitmap which contains fixed with characters for the font set. You use character spacing to define the set.\\nIf you need variable width character support then use a BitmapText object instead. The main difference between a RetroFont and a BitmapText\\nis that a RetroFont creates a single texture that you can apply to a game object, where-as a BitmapText creates one Sprite object per letter of text.\\nThe texture can be asssigned or one or multiple images\/sprites, but note that the text the RetroFont uses will be shared across them all,\\ni.e. if you need each Image to have different text in it, then you need to create multiple RetroFont objects.","line":281,"public":true,"protected":false,"private":false,"parameters":[{"name":"font","type":["string"],"help":"The key of the image in the Game.Cache that the RetroFont will use.","optional":false,"default":null},{"name":"characterWidth","type":["number"],"help":"The width of each character in the font set.","optional":false,"default":null},{"name":"characterHeight","type":["number"],"help":"The height of each character in the font set.","optional":false,"default":null},{"name":"chars","type":["string"],"help":"The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.","optional":false,"default":null},{"name":"charsPerRow","type":["number"],"help":"The number of characters per row in the font set.","optional":false,"default":null},{"name":"xSpacing","type":["number"],"help":"If the characters in the font set have horizontal spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If the characters in the font set have vertical spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"xOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","optional":true,"default":"0"},{"name":"yOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"rope","static":false,"returns":{"types":["Phaser.Rope"],"help":"The newly created rope object."},"help":"Creates a new Rope object.","line":187,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Rope at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Rope at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the Rope.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the Rope.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Rope is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"sound","static":false,"returns":{"types":["Phaser.Sound"],"help":"The newly created text object."},"help":"Creates a new Sound object.","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"The volume at which the sound will be played.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"},{"name":"connect","type":["boolean"],"help":"Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"sprite","static":false,"returns":null,"help":"Create a new Sprite with specific position and sprite sheet key.","line":58,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new sprite.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new sprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"spriteBatch","static":false,"returns":{"types":["Phaser.Group"],"help":"The newly created group."},"help":"A Group is a container for display objects that allows for fast pooling, recycling and collision checks.","line":103,"public":true,"protected":false,"private":false,"parameters":[{"name":"parent","type":["any"],"help":"The parent Group or DisplayObjectContainer that will hold this group, if any.","optional":false,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"'group'"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"text","static":false,"returns":{"types":["Phaser.Text"],"help":"The newly created text object."},"help":"Creates a new Text object.","line":203,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new text object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new text object.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be written.","optional":false,"default":null},{"name":"style","type":["object"],"help":"The style object containing style attributes like font, font size , etc.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tileSprite","static":false,"returns":{"types":["Phaser.TileSprite"],"help":"The newly created tileSprite object."},"help":"Creates a new TileSprite object.","line":169,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the TileSprite.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the TileSprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tilemap","static":false,"returns":null,"help":"Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.\\nTo do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.\\nWhen using CSV data you must provide the key and the tileWidth and tileHeight parameters.\\nIf creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.\\nNote that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.","line":318,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.","optional":true,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"width","type":["number"],"help":"The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"},{"name":"height","type":["number"],"help":"The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"}],"inherited":false,"inheritedFrom":""},{"name":"tween","static":false,"returns":{"types":["Phaser.Tween"],"help":"The Tween object."},"help":"Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.","line":71,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"Object the tween will be run on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"A reference to the game world.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.GameObjectFactory.json b/docgen/output/Phaser.GameObjectFactory.json deleted file mode 100644 index c6e6f0422..000000000 --- a/docgen/output/Phaser.GameObjectFactory.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.GameObjectFactory","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Game Object Factory is a quick way to create all of the different sorts of core objects that Phaser uses."},"consts":[],"methods":{"public":[{"name":"audio","static":false,"returns":{"types":["Phaser.Sound"],"help":"The newly created text object."},"help":"Creates a new Sound object.","line":160,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"The volume at which the sound will be played.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"},{"name":"connect","type":["boolean"],"help":"Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"audioSprite","static":false,"returns":{"types":["Phaser.AudioSprite"],"help":"The newly created AudioSprite object."},"help":"Creates a new AudioSprite object.","line":189,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"bitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The newly created BitmapData object."},"help":"A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.","line":417,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the BitmapData in pixels.","optional":true,"default":"256"},{"name":"height","type":["number"],"help":"The height of the BitmapData in pixels.","optional":true,"default":"256"},{"name":"key","type":["string"],"help":"Asset key for the BitmapData when stored in the Cache (see addToCache parameter).","optional":true,"default":"''"},{"name":"addToCache","type":["boolean"],"help":"Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"bitmapText","static":false,"returns":{"types":["Phaser.BitmapText"],"help":"The newly created bitmapText object."},"help":"Create a new BitmapText object.","line":352,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new bitmapText object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new bitmapText object.","optional":false,"default":null},{"name":"font","type":["string"],"help":"The key of the BitmapText font as stored in Game.Cache.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be rendered. Can be set later via BitmapText.text.","optional":true,"default":null},{"name":"size","type":["number"],"help":"The size the font will be rendered in, in pixels.","optional":true,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"button","static":false,"returns":{"types":["Phaser.Button"],"help":"The newly created button object."},"help":"Creates a new Button object.","line":272,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":" X position of the new button object.","optional":true,"default":null},{"name":"y","type":["number"],"help":" Y position of the new button object.","optional":true,"default":null},{"name":"key","type":["string"],"help":" The image key as defined in the Game.Cache to use as the texture for this button.","optional":true,"default":null},{"name":"callback","type":["function"],"help":" The function to call when this button is pressed","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":" The context in which the callback will be called (usually 'this')","optional":true,"default":null},{"name":"overFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"outFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"downFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"upFrame","type":["string","number"],"help":" This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"emitter","static":false,"returns":{"types":["Phaser.Emitter"],"help":"The newly created emitter object."},"help":"Emitter is a lightweight particle emitter. It can be used for one-time explosions or for\\ncontinuous effects like rain and fire. All it really does is launch Particle objects out\\nat set intervals, and fixes their positions and velocities accorindgly.","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"maxParticles","type":["number"],"help":"The total number of particles in this emitter.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"existing","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to the game world.","line":36,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"filter","static":false,"returns":{"types":["Phaser.Filter"],"help":"The newly created Phaser.Filter object."},"help":"A WebGL shader\/filter that can be applied to Sprites.","line":441,"public":true,"protected":false,"private":false,"parameters":[{"name":"filter","type":["string"],"help":"The name of the filter you wish to create, for example HueRotate or SineWave.","optional":false,"default":null},{"name":"-","type":["any"],"help":" Whatever parameters are needed to be passed to the filter init function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"graphics","static":false,"returns":{"types":["Phaser.Graphics"],"help":"The newly created graphics object."},"help":"Creates a new Graphics object.","line":289,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new graphics object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new graphics object.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"group","static":false,"returns":{"types":["Phaser.Group"],"help":"The newly created group."},"help":"A Group is a container for display objects that allows for fast pooling, recycling and collision checks.","line":105,"public":true,"protected":false,"private":false,"parameters":[{"name":"parent","type":["any"],"help":"The parent Group or DisplayObjectContainer that will hold this group, if any. If set to null the Group won't be added to the display list. If undefined it will be added to World by default.","optional":true,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"'group'"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"},{"name":"enableBody","type":["boolean"],"help":"If true all Sprites created with `Group.create` or `Group.createMulitple` will have a physics body created on them. Change the body type with physicsBodyType.","optional":true,"default":"false"},{"name":"physicsBodyType","type":["number"],"help":"If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"image","static":false,"returns":null,"help":"Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.\\nIt can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.","line":54,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the image.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the image.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"physicsGroup","static":false,"returns":{"types":["Phaser.Group"],"help":"The newly created group."},"help":"A Group is a container for display objects that allows for fast pooling, recycling and collision checks.\\nA Physics Group is the same as an ordinary Group except that is has enableBody turned on by default, so any Sprites it creates\\nare automatically given a physics body.","line":123,"public":true,"protected":false,"private":false,"parameters":[{"name":"physicsBodyType","type":["number"],"help":"If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","optional":true,"default":"Phaser.Physics.ARCADE"},{"name":"parent","type":["any"],"help":"The parent Group or DisplayObjectContainer that will hold this group, if any. If set to null the Group won't be added to the display list. If undefined it will be added to World by default.","optional":true,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"'group'"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"plugin","static":false,"returns":{"types":["Phaser.Plugin"],"help":"The Plugin that was added to the manager."},"help":"Add a new Plugin into the PluginManager.\\nThe Plugin must have 2 properties: game and parent. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.","line":462,"public":true,"protected":false,"private":false,"parameters":[{"name":"plugin","type":["object","Phaser.Plugin"],"help":"The Plugin to add into the PluginManager. This can be a function or an existing object.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the Plugin.init method.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"renderTexture","static":false,"returns":{"types":["Phaser.RenderTexture"],"help":"The newly created RenderTexture object."},"help":"A dynamic initially blank canvas to which images can be drawn.","line":391,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the width of the RenderTexture.","optional":true,"default":"100"},{"name":"height","type":["number"],"help":"the height of the RenderTexture.","optional":true,"default":"100"},{"name":"key","type":["string"],"help":"Asset key for the RenderTexture when stored in the Cache (see addToCache parameter).","optional":true,"default":"''"},{"name":"addToCache","type":["boolean"],"help":"Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"retroFont","static":false,"returns":{"types":["Phaser.RetroFont"],"help":"The newly created RetroFont texture which can be applied to an Image or Sprite."},"help":"Create a new RetroFont object to be used as a texture for an Image or Sprite and optionally add it to the Cache.\\nA RetroFont uses a bitmap which contains fixed with characters for the font set. You use character spacing to define the set.\\nIf you need variable width character support then use a BitmapText object instead. The main difference between a RetroFont and a BitmapText\\nis that a RetroFont creates a single texture that you can apply to a game object, where-as a BitmapText creates one Sprite object per letter of text.\\nThe texture can be asssigned or one or multiple images\/sprites, but note that the text the RetroFont uses will be shared across them all,\\ni.e. if you need each Image to have different text in it, then you need to create multiple RetroFont objects.","line":334,"public":true,"protected":false,"private":false,"parameters":[{"name":"font","type":["string"],"help":"The key of the image in the Game.Cache that the RetroFont will use.","optional":false,"default":null},{"name":"characterWidth","type":["number"],"help":"The width of each character in the font set.","optional":false,"default":null},{"name":"characterHeight","type":["number"],"help":"The height of each character in the font set.","optional":false,"default":null},{"name":"chars","type":["string"],"help":"The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.","optional":false,"default":null},{"name":"charsPerRow","type":["number"],"help":"The number of characters per row in the font set.","optional":false,"default":null},{"name":"xSpacing","type":["number"],"help":"If the characters in the font set have horizontal spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If the characters in the font set have vertical spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"xOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","optional":true,"default":"0"},{"name":"yOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"rope","static":false,"returns":{"types":["Phaser.TileSprite"],"help":"The newly created tileSprite object."},"help":"Creates a new Rope object.\\n\\nExample usage: https:\/\/github.com\/codevinsky\/phaser-rope-demo\/blob\/master\/dist\/demo.js","line":229,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null},{"name":"points","type":["array"],"help":"An array of {Phaser.Point}.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"sound","static":false,"returns":{"types":["Phaser.Sound"],"help":"The newly created text object."},"help":"Creates a new Sound object.","line":176,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Game.cache key of the sound that this object will use.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"The volume at which the sound will be played.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"},{"name":"connect","type":["boolean"],"help":"Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"sprite","static":false,"returns":null,"help":"Create a new Sprite with specific position and sprite sheet key.","line":73,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new sprite.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new sprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.","optional":true,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"spriteBatch","static":false,"returns":{"types":["Phaser.Group"],"help":"The newly created group."},"help":"A SpriteBatch is a really fast version of a Phaser Group built solely for speed.\\nUse when you need a lot of sprites or particles all sharing the same texture.\\nThe speed gains are specifically for WebGL. In Canvas mode you won't see any real difference.","line":140,"public":true,"protected":false,"private":false,"parameters":[{"name":"parent","type":["Phaser.Group","null"],"help":"The parent Group that will hold this Sprite Batch. Set to `undefined` or `null` to add directly to game.world.","optional":false,"default":null},{"name":"name","type":["string"],"help":"A name for this Sprite Batch. Not used internally but useful for debugging.","optional":true,"default":"'group'"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Sprite Batch will be added directly to the Game.Stage instead of the parent.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"text","static":false,"returns":{"types":["Phaser.Text"],"help":"The newly created text object."},"help":"Creates a new Text object.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the new text object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new text object.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be written.","optional":false,"default":null},{"name":"style","type":["object"],"help":"The style object containing style attributes like font, font size , etc.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tileSprite","static":false,"returns":{"types":["Phaser.TileSprite"],"help":"The newly created tileSprite object."},"help":"Creates a new TileSprite object.","line":208,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the TileSprite.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the TileSprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tilemap","static":false,"returns":{"types":["Phaser.Tilemap"],"help":"The newly created tilemap object."},"help":"Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.\\nTo do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.\\nWhen using CSV data you must provide the key and the tileWidth and tileHeight parameters.\\nIf creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.\\nNote that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.","line":375,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.","optional":true,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"width","type":["number"],"help":"The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"},{"name":"height","type":["number"],"help":"The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"}],"inherited":false,"inheritedFrom":""},{"name":"tween","static":false,"returns":{"types":["Phaser.Tween"],"help":"The newly created Phaser.Tween object."},"help":"Create a tween on a specific object. The object can be any JavaScript object or Phaser object such as Sprite.","line":88,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"Object the tween will be run on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"A reference to the game world.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Gamepad.json b/docgen/output/Phaser.Gamepad.json deleted file mode 100644 index 205940157..000000000 --- a/docgen/output/Phaser.Gamepad.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Gamepad","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Gamepad class handles looking after gamepad input for your game.\\nRemember to call gamepad.start(); expecting input!\\n\\nHTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE!\\nAt moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it\\nvia prefs flags (about:config, search gamepad). The browsers map the same controllers differently.\\nThis class has constants for Windows 7 Chrome mapping of XBOX 360 controller."},"consts":[],"methods":{"public":[{"name":"addCallbacks","static":false,"returns":null,"help":"Add callbacks to the main Gamepad handler to handle connect\/disconnect\/button down\/button up\/axis change\/float value buttons\\nonConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback","line":145,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context under which the callbacks are run.","optional":false,"default":null},{"name":"callbacks","type":["object"],"help":"Object that takes six different callback methods:","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this object and the associated event listeners.","line":468,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isDown","static":false,"returns":{"types":["boolean"],"help":"True if a button is currently down."},"help":"Returns true if the button is currently pressed down, on ANY gamepad.","line":450,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"True if the button is just released otherwise false."},"help":"Returns the \"just released\" state of a button from ANY gamepad connected. Just released is considered as being true if the button was released within the duration given (default 250ms).","line":430,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check for.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration below which the button is considered as being just released.","optional":true,"default":"250"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Reset all buttons\/axes of all gamepads","line":391,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setDeadZones","static":false,"returns":null,"help":"Sets the deadZone variable for all four gamepads","line":364,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the Gamepad event handling.\\nThis MUST be called manually before Phaser will start polling the Gamepad API.","line":165,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops the Gamepad event handling.","line":378,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"update","static":false,"returns":null,"help":"Main gamepad update loop. Should not be called manually.","line":233,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"_pollGamepads","static":false,"returns":null,"help":"Updating connected gamepads (for Google Chrome). Should not be called manually.","line":250,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onGamepadConnected","static":false,"returns":null,"help":"Handles the connection of a Gamepad.","line":197,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["object"],"help":"The DOM event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onGamepadDisconnected","static":false,"returns":null,"help":"Handles the disconnection of a Gamepad.","line":212,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["object"],"help":"The DOM event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"If the gamepad input is active or not - if not active it should not be updated from Input.js","inlineHelp":"If the gamepad input is active or not.","line":489,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which the callbacks are run.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"You can disable all Gamepad Input by setting disabled to true. While true all new input related events will be ignored.","inlineHelp":"The disabled state of the Gamepad.","line":51,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onAxisCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad axis is changed.","line":104,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onConnectCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad is connected","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDisconnectCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad is disconnected","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDownCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad button is pressed down.","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFloatCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad button is changed to a value where value > 0 and value < 1.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time any gamepad button is released.","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pad1","type":["Phaser.SinglePad"],"help":"Gamepad #1","inlineHelp":"Gamepad #1;","line":531,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pad2","type":["Phaser.SinglePad"],"help":"Gamepad #2","inlineHelp":"Gamepad #2","line":545,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pad3","type":["Phaser.SinglePad"],"help":"Gamepad #3","inlineHelp":"Gamepad #3","line":559,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pad4","type":["Phaser.SinglePad"],"help":"Gamepad #4","inlineHelp":"Gamepad #4","line":573,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"padsConnected","type":["number"],"help":"How many live gamepads are currently connected.","inlineHelp":"How many live gamepads are currently connected.","line":517,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"supported","type":["boolean"],"help":"Whether or not gamepads are supported in current browser.","inlineHelp":"Whether or not gamepads are supported in current browser.","line":503,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_active","type":["boolean"],"help":"","inlineHelp":"Private flag for whether or not the API is polled","line":44,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_gamepadIndexMap","type":["object"],"help":"","inlineHelp":"Maps the browsers gamepad indices to our Phaser Gamepads","line":31,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_gamepadSupportAvailable","type":["boolean"],"help":"Whether or not gamepads are supported in the current browser. Note that as of Dec. 2013 this check is actually not accurate at all due to poor implementation.","inlineHelp":"Are gamepads supported in this browser or not?","line":58,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_gamepaddisconnected","type":["function"],"help":"","inlineHelp":"Private callback for Firefox gamepad connection handling","line":121,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_gamepads","type":["array Phaser.SinglePad"],"help":"","inlineHelp":"The four Phaser Gamepads.","line":127,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_ongamepadconnected","type":["function"],"help":"","inlineHelp":"Private callback for Firefox gamepad connection handling","line":115,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_prevRawGamepadTypes","type":["array"],"help":"Used to check for differences between earlier polls and current state of gamepads.","inlineHelp":"","line":66,"default":"[]","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_prevTimestamps","type":["array"],"help":"Used to check for differences between earlier polls and current state of gamepads.","inlineHelp":"","line":74,"default":"[]","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_rawPads","type":["array"],"help":"","inlineHelp":"The raw state of the gamepads from the browser","line":37,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.GamepadButton.json b/docgen/output/Phaser.GamepadButton.json deleted file mode 100644 index a47d545d0..000000000 --- a/docgen/output/Phaser.GamepadButton.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.GamepadButton","extends":"","static":false,"constructor":true,"parameters":[{"name":"pad","type":["Phaser.SinglePad"],"help":"A reference to the gamepad that owns this button.","optional":false,"default":null},{"name":"buttonCode","type":["number"],"help":"The button code this GamepadButton is responsible for.","optional":false,"default":null}],"help":"If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this GamepadButton, this disposes of the onDown, onUp and onFloat signals and clears the pad and game references.","line":199,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"True if the button is just pressed otherwise false."},"help":"Returns the \"just released\" state of this button. Just released is considered as being true if the button was released within the duration given (default 250ms).","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The duration below which the button is considered as being just released.","optional":true,"default":"250"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets this GamepadButton, changing it to an isUp state and resetting the duration and repeats counters.","line":184,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"processButtonDown","static":false,"returns":null,"help":"Called automatically by Phaser.SinglePad.","line":103,"public":false,"protected":true,"private":false,"parameters":[{"name":"value","type":["number"],"help":"Button value","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processButtonFloat","static":false,"returns":null,"help":"Called automatically by Phaser.SinglePad.","line":141,"public":false,"protected":true,"private":false,"parameters":[{"name":"value","type":["number"],"help":"Button value","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processButtonUp","static":false,"returns":null,"help":"Called automatically by Phaser.SinglePad.","line":123,"public":false,"protected":true,"private":false,"parameters":[{"name":"value","type":["number"],"help":"Button value","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"buttonCode","type":["number"],"help":"","inlineHelp":"The buttoncode of this button.","line":75,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"duration","type":["number"],"help":"If the button is down this value holds the duration of that button press and is constantly updated.\\nIf the button is up it holds the duration of the previous down session.","inlineHelp":"The number of milliseconds this button has been held down for.","line":52,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isDown","type":["boolean"],"help":"","inlineHelp":"The \"down\" state of the button.","line":32,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isUp","type":["boolean"],"help":"","inlineHelp":"The \"up\" state of the button.","line":38,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDown","type":["Phaser.Signal"],"help":"","inlineHelp":"This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).","line":80,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFloat","type":["Phaser.Signal"],"help":"","inlineHelp":"This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUp","type":["Phaser.Signal"],"help":"","inlineHelp":"This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pad","type":["Phaser.SinglePad"],"help":"","inlineHelp":"A reference to the gamepad that owns this button.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"repeats","type":["number"],"help":"","inlineHelp":"If a button is held down this holds down the number of times the button has 'repeated'.","line":64,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeDown","type":["number"],"help":"","inlineHelp":"The timestamp when the button was last pressed down.","line":44,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeUp","type":["number"],"help":"","inlineHelp":"The timestamp when the button was last released.","line":58,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"value","type":["number"],"help":"","inlineHelp":"Button value. Mainly useful for checking analog buttons (like shoulder triggers)","line":70,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Graphics.json b/docgen/output/Phaser.Graphics.json deleted file mode 100644 index 936a93636..000000000 --- a/docgen/output/Phaser.Graphics.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Graphics","extends":"PIXI.Graphics","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the new graphics object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new graphics object.","optional":false,"default":null}],"help":"Creates a new `Graphics` object."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"arc","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"The arc method creates an arc\/curve (used to create circles, or parts of circles).","line":419,"public":true,"protected":false,"private":false,"parameters":[{"name":"cx","type":["number"],"help":"The x-coordinate of the center of the circle","optional":false,"default":null},{"name":"cy","type":["number"],"help":"The y-coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null},{"name":"startAngle","type":["number"],"help":"The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)","optional":false,"default":null},{"name":"endAngle","type":["number"],"help":"The ending angle, in radians","optional":false,"default":null},{"name":"anticlockwise","type":["boolean"],"help":"Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"beginFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies a simple one-color fill that subsequent calls to other Graphics methods\\n(such as lineTo() or drawCircle()) use when drawing.","line":486,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"the color of the fill","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"the alpha of the fill","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"bezierCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a bezier curve and then draws it.","line":297,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"cpX2","type":["number"],"help":"Second Control point x","optional":false,"default":null},{"name":"cpY2","type":["number"],"help":"Second Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"clear","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.","line":604,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroy this Graphics instance.","line":149,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"destroyCachedSprite","static":false,"returns":null,"help":"Destroys a previous cached sprite.","line":1039,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawCircle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a circle.","line":560,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the circle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawEllipse","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws an ellipse.","line":577,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the ellipse","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the ellipse","optional":false,"default":null},{"name":"width","type":["number"],"help":"The half width of the ellipse","optional":false,"default":null},{"name":"height","type":["number"],"help":"The half height of the ellipse","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawPolygon","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a polygon using the given path.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"path","type":["array"],"help":"The path data used to construct the polygon.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRect","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRoundedRect","static":false,"returns":null,"help":"","line":544,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"Radius of the rectangle corners","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawShape","static":false,"returns":{"types":["PIXI.GraphicsData"],"help":"The generated GraphicsData object."},"help":"Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.","line":1055,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["Phaser.Circle","Phaser.Rectangle","Phaser.Ellipse","Phaser.Line","Phaser.Polygon"],"help":" The Shape object to draw.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"endFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.","line":510,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the graphics object that can then be used to create sprites\\nThis can be quite useful if your geometry is complicated and needs to be reused multiple times.","line":625,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the rectangular bounding area"},"help":"Retrieves the bounds of the graphic shape as a rectangle object","line":800,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"lineStyle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"lineWidth","type":["number"],"help":"width of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"color","type":["number"],"help":"color of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"alpha of the line to draw, will update the objects stored style","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"lineTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a line using the current line style from the current drawing position to (x, y);\\nThe current drawing position is then set to (x, y).","line":227,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to draw to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to draw to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Moves the current drawing position to x, y.","line":211,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to move to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to move to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":89,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"quadraticCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a quadratic bezier curve and then draws it.\\nBased on: https:\/\/stackoverflow.com\/questions\/785097\/how-do-i-implement-a-bezier-curve-in-c","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":124,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateBounds","static":false,"returns":null,"help":"Update the bounds of the object","line":875,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Graphics, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead.","inlineHelp":"Gets or sets the angle of rotation in degrees.","line":331,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.","inlineHelp":"","line":68,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsPadding","type":["number"],"help":"The bounds' padding used for bounds calculation.","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":378,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Text isn't updated by the core game loop.","line":31,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fillAlpha","type":["number"],"help":"The alpha value used when filling the Graphics object.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Graphics that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Graphics.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Graphics was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Graphics to the Camera at its current world coordinates.","line":351,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isMask","type":["boolean"],"help":"Whether this shape is being used as a mask.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineColor","type":["string"],"help":"The color of any lines drawn.","inlineHelp":"","line":41,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineWidth","type":["number"],"help":"The width (thickness) of any lines drawn.","inlineHelp":"","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this object.","line":37,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"tint","type":["number"],"help":"The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.","inlineHelp":"","line":59,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":43,"default":"Phaser.GRAPHICS","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":78,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Group.json b/docgen/output/Phaser.Group.json deleted file mode 100644 index 5140d29c8..000000000 --- a/docgen/output/Phaser.Group.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Group","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"parent","type":["Phaser.Group","Phaser.Sprite","null"],"help":"The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If `undefined` it will use game.world. If null it won't be added to anything.","optional":false,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"group"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"},{"name":"enableBody","type":["boolean"],"help":"If true all Sprites created with `Group.create` or `Group.createMulitple` will have a physics body created on them. Change the body type with physicsBodyType.","optional":true,"default":"false"},{"name":"physicsBodyType","type":["number"],"help":"If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","optional":true,"default":"0"}],"help":"A Group is a container for display objects that allows for fast pooling and object recycling.\\nGroups can be nested within other Groups and have their own local transforms."},"consts":[{"name":"RETURN_CHILD","type":"number","help":"","line":183},{"name":"RETURN_NONE","type":"number","help":"","line":171},{"name":"RETURN_TOTAL","type":"number","help":"","line":177},{"name":"SORT_ASCENDING","type":"number","help":"","line":189},{"name":"SORT_DESCENDING","type":"number","help":"","line":195}],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[{"name":"callbackFromArray","static":false,"returns":null,"help":"Returns a reference to a function that exists on a child of the Group based on the given callback array.","line":1042,"public":false,"protected":true,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The object to inspect.","optional":false,"default":null},{"name":"callback","type":["array"],"help":"The array of function names.","optional":false,"default":null},{"name":"length","type":["number"],"help":"The size of the array (pre-calculated in callAll).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"The core postUpdate - as called by World.","line":1191,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"The core preUpdate - as called by World.","line":1151,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"The core update - as called by World.","line":1175,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateZ","static":false,"returns":null,"help":"Internal method that re-applies all of the childrens Z values.","line":397,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A name for this Group. Not used internally but useful for debugging.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the Group container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The x coordinate of the Group container.","line":1865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The y coordinate of the Group container.","line":1872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"type","type":["number"],"help":"","inlineHelp":"Internal Phaser Type value.","line":65,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = cursor index\\n9 = sort order","inlineHelp":"","line":160,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sortProperty","type":["string"],"help":"","inlineHelp":"The property on which children are sorted.","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Image.json b/docgen/output/Phaser.Image.json deleted file mode 100644 index 85ac95644..000000000 --- a/docgen/output/Phaser.Image.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Image","extends":"PIXI.Sprite","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the Image. The coordinate is relative to any parent container this Image may be in.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"The texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"help":"An Image is a light-weight object you can use to display anything that doesn't need physics or animation.\\nIt can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"bringToTop","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Brings the Image to the top of the display list it is a child of. Images that are members of a Phaser.Group are only\\nbought to the top of that Group, not the entire display list.","line":619,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"crop","static":false,"returns":null,"help":"Crop allows you to crop the texture used to display this Image.\\nCropping takes place from the top-left of the Image and can be modified in real-time by providing an updated rectangle object.\\nThe rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.\\nPlease note that the rectangle object given is not duplicated by this method, but rather the Image uses a reference to the rectangle.\\nKeep this in mind if assigning a rectangle in a for-loop, or when cleaning up for garbage collection.","line":393,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.","optional":false,"default":null},{"name":"copy","type":["boolean"],"help":"If false Sprite.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Sprite.cropRect object.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the Image. This removes it from its parent group, destroys the input, event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":519,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"kill","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Kills a Image. A killed Image has its alive, exists and visible properties all set to false.\\nIt will dispatch the onKilled event, you can listen to Image.events.onKilled for the signal.\\nNote that killing a Image is a way for you to quickly recycle it in a Image pool, it doesn't free it up from memory.\\nIf you don't need this Image any more you should call Image.destroy instead.","line":496,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the Image is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":217,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":164,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Resets the Image. This places the Image at the given x\/y world coordinates and then sets alive, exists, visible and renderable all to true.","line":597,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Image at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Image at.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"resetFrame","static":false,"returns":null,"help":"Resets the Texture frame dimensions that the Image uses for rendering.","line":372,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"revive","static":false,"returns":{"types":["Phaser.Image"],"help":"This instance."},"help":"Brings a 'dead' Image back to life, optionally giving it the health value specified.\\nA resurrected Image has its alive, exists and visible properties all set to true.\\nIt will dispatch the onRevived event, you can listen to Image.events.onRevived for the signal.","line":471,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the Image uses for rendering.\\nThis is primarily an internal method used by Image.loadTexture, although you may call it directly.","line":319,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the Image texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":207,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCrop","static":false,"returns":null,"help":"If you have set a crop rectangle on this Image via Image.crop and since modified the Image.cropRect property (or the rectangle it references)\\nthen you need to update the crop frame by calling this method.","line":431,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Image"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"A useful boolean to control if the Image is alive or dead (in terms of your gameplay, it doesn't effect rendering).","line":83,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Image, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Image.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Image in degrees.","line":638,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Image be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Image should be automatically camera culled or not.","line":93,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"cropRect","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.","line":115,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"Handy flag to use with Game.enableStep","line":104,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaX","type":["number"],"help":"Returns the delta x value. The difference between world.x now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was to the right, negative if to the left.","line":661,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaY","type":["number"],"help":"Returns the delta y value. The difference between world.y now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was downwards, negative if upwards.","line":678,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaZ","type":["number"],"help":"Returns the delta z value. The difference between rotation now and in the previous step.","inlineHelp":"The delta value.","line":695,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":921,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Image or its components.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Image isn't updated by the core game loop.","line":36,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Image that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Image.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Image was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Image to the Camera at its current world coordinates.","line":860,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture for display.","line":743,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame by name and updates the Texture for display.","line":772,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inCamera","type":["boolean"],"help":"Checks if the Image bounds are within the game camera, otherwise false if fully outside of it.","inlineHelp":"True if the Image bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.","line":729,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"inWorld","type":["boolean"],"help":"Checks if the Image bounds are within the game world, otherwise false if fully outside of it.","inlineHelp":"True if the Image bounds is within the game world, even if only partially. Otherwise false if fully outside of it.","line":712,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default an Image won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":819,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Image.","line":42,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderOrderID","type":["number"],"help":"","inlineHelp":"The render order ID, reset every frame.","line":802,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"Enable or disable texture smoothing for this Image. Only works for bitmap\/image textures. Smoothing is enabled by default.","inlineHelp":"Set to true to smooth the texture of this Image, or false to disable smoothing (great for pixel art)","line":889,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Image. This differs from the x\/y coordinates which are relative to the Images container.","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_bounds","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":149,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":131,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_crop","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":137,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frame","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Input.json b/docgen/output/Phaser.Input.json deleted file mode 100644 index 208a9036a..000000000 --- a/docgen/output/Phaser.Input.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Input","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null}],"help":"Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.\\nThe Input manager is updated automatically by the core game loop."},"consts":[{"name":"MOUSE_OVERRIDES_TOUCH","type":"number","help":"","line":318},{"name":"MOUSE_TOUCH_COMBINE","type":"number","help":"","line":330},{"name":"TOUCH_OVERRIDES_MOUSE","type":"number","help":"","line":324}],"methods":{"public":[{"name":"addMoveCallback","static":false,"returns":{"types":["number"],"help":"The index of the callback entry. Use this index when calling Input.deleteMoveCallback."},"help":"Adds a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove.\\nIt will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best\\nto only use if you've limited input to a single pointer (i.e. mouse or touch).\\nThe callback is added to the Phaser.Input.moveCallbacks array and should be removed with Phaser.Input.deleteMoveCallback.","line":406,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback that will be called each time the activePointer receives a DOM move event.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addPointer","static":false,"returns":{"types":["Phaser.Pointer"],"help":"A reference to the new Pointer object that was created."},"help":"Add a new Pointer object to the Input Manager. By default Input creates 3 pointer objects: mousePointer, pointer1 and pointer2.\\nIf you need more then use this to create a new one, up to a maximum of 10.","line":433,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deleteMoveCallback","static":false,"returns":null,"help":"Removes the callback at the defined index from the Phaser.Input.moveCallbacks array","line":418,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the callback to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Stops all of the Input Managers from running.","line":383,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getLocalPosition","static":false,"returns":{"types":["Phaser.Point"],"help":"A point containing the coordinates of the Pointer position relative to the DisplayObject."},"help":"This will return the local coordinates of the specified displayObject based on the given Pointer.","line":771,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image"],"help":"The DisplayObject to get the local coordinates for.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer to use in the check against the displayObject.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getPointer","static":false,"returns":{"types":["Phaser.Pointer"],"help":"A Pointer object or null if no Pointer object matches the requested state."},"help":"Get the next Pointer object whos active property matches the given state","line":668,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"The state the Pointer should be in (false for inactive, true for active).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getPointerFromId","static":false,"returns":{"types":["Phaser.Pointer"],"help":"A Pointer object or null if no Pointer object matches the requested identifier."},"help":"Get the Pointer object whos `pointerId` property matches the given value.\\nThe pointerId property is not set until the Pointer has been used at least once, as its populated by the DOM event.\\nAlso it can change every time you press the pointer down if the browser recycles it.","line":739,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointerId","type":["number"],"help":"The Pointer.pointerId value to search for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getPointerFromIdentifier","static":false,"returns":{"types":["Phaser.Pointer"],"help":"A Pointer object or null if no Pointer object matches the requested identifier."},"help":"Get the Pointer object whos `identifier` property matches the given identifier value.\\nThe identifier property is not set until the Pointer has been used at least once, as its populated by the DOM event.\\nAlso it can change every time you press the pointer down, and is not fixed once set.\\nNote: Not all browsers set the identifier property and it's not part of the W3C spec, so you may need getPointerFromId instead.","line":705,"public":true,"protected":false,"private":false,"parameters":[{"name":"identifier","type":["number"],"help":"The Pointer.identifier value to search for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hitTest","static":false,"returns":null,"help":"Tests if the pointer hits the given object.","line":793,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The displayObject to test for a hit.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The pointer to use for the test.","optional":false,"default":null},{"name":"localPoint","type":["Phaser.Point"],"help":"The local translated point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Reset all of the Pointers and Input states. The optional `hard` parameter will reset any events or callbacks that may be bound.\\nInput.reset is called automatically during a State change or if a game loses focus \/ visibility. If you wish to control the reset\\ndirectly yourself then set InputManager.resetLocked to `true`.","line":506,"public":true,"protected":false,"private":false,"parameters":[{"name":"hard","type":["boolean"],"help":"A soft reset won't reset any events or callbacks that are bound. A hard reset will.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"resetSpeed","static":false,"returns":null,"help":"Resets the speed and old position properties.","line":557,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Sets the oldPosition.x value.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Sets the oldPosition.y value.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"startPointer","static":false,"returns":{"types":["Phaser.Pointer"],"help":"The Pointer object that was started or null if no Pointer object is available."},"help":"Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.","line":570,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["any"],"help":"The event data from the Touch event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stopPointer","static":false,"returns":{"types":["Phaser.Pointer"],"help":"The Pointer object that was stopped or null if no Pointer object is available."},"help":"Stops the matching Pointer object, passing in the event data.","line":637,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["any"],"help":"The event data from the Touch event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updatePointer","static":false,"returns":{"types":["Phaser.Pointer"],"help":"The Pointer object that was updated or null if no Pointer object is available."},"help":"Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["any"],"help":"The event data from the Touch event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Starts the Input Manager running.","line":339,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates the Input Manager. Called by the core Game loop.","line":464,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"activePointer","type":["Phaser.Pointer"],"help":"The most recently active Pointer object.\\nWhen you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.","inlineHelp":"","line":212,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"circle","type":["Phaser.Circle"],"help":"A Circle object centered on the x\/y screen coordinates of the Input.\\nDefault size of 44px (Apples recommended \"finger tip\" size) but can be changed to anything.","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentPointers","type":["number"],"help":"","inlineHelp":"The current number of active Pointers.","line":102,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"You can disable all Input by setting Input.disabled = true. While set all new input related events will be ignored.\\nIf you need to disable just one type of input; for example mouse; use Input.mouse.disabled = true instead","inlineHelp":"","line":61,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"doubleTapRate","type":["number"],"help":"","inlineHelp":"The number of milliseconds between taps of the same Pointer for it to be considered a double tap \/ click.","line":114,"default":"300","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gamepad","type":["Phaser.Gamepad"],"help":"","inlineHelp":"The Gamepad Input manager.","line":242,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitCanvas","type":["HTMLCanvasElement"],"help":"","inlineHelp":"The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.","line":26,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitContext","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"The context of the pixel perfect hit canvas.","line":32,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"holdRate","type":["number"],"help":"","inlineHelp":"The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.","line":120,"default":"2000","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactiveItems","type":["Phaser.ArrayList"],"help":"A list of interactive objects. The InputHandler components add and remove themselves from this list.","inlineHelp":"","line":280,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"justPressedRate","type":["number"],"help":"","inlineHelp":"The number of milliseconds below which the Pointer is considered justPressed.","line":126,"default":"200","public":true,"protected":false,"private":false,"readOnly":false},{"name":"justReleasedRate","type":["number"],"help":"","inlineHelp":"The number of milliseconds below which the Pointer is considered justReleased .","line":132,"default":"200","public":true,"protected":false,"private":false,"readOnly":false},{"name":"keyboard","type":["Phaser.Keyboard"],"help":"","inlineHelp":"The Keyboard Input manager.","line":227,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxPointers","type":["number"],"help":"","inlineHelp":"The maximum number of Pointers allowed to be active at any one time. For lots of games it's useful to set this to 1.","line":96,"default":"10","public":true,"protected":false,"private":false,"readOnly":false},{"name":"minPriorityID","type":["number"],"help":"","inlineHelp":"You can tell all Pointers to ignore any object with a priorityID lower than the minPriorityID. Useful when stacking UI layers. Set to zero to disable.","line":274,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouse","type":["Phaser.Mouse"],"help":"","inlineHelp":"The Mouse Input manager.","line":222,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mousePointer","type":["Pointer"],"help":"","inlineHelp":"The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.","line":217,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"moveCallback","type":["function"],"help":"","inlineHelp":"An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"moveCallbackContext","type":["object"],"help":"","inlineHelp":"The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"moveCallbacks","type":["array"],"help":"","inlineHelp":"An array of callbacks that will be fired every time the activePointer receives a move event from the DOM.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mspointer","type":["Phaser.MSPointer"],"help":"","inlineHelp":"The MSPointer Input manager.","line":237,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"multiInputOverride","type":["number"],"help":"","inlineHelp":"Controls the expected behaviour when using a mouse and touch together on a multi-input device.","line":67,"default":"Phaser.Input.MOUSE_TOUCH_COMBINE","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDown","type":["Phaser.Signal"],"help":"","inlineHelp":"A Signal that is dispatched each time a pointer is pressed down.","line":253,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onHold","type":["Phaser.Signal"],"help":"","inlineHelp":"A Signal that is dispatched each time a pointer is held down.","line":268,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onTap","type":["Phaser.Signal"],"help":"","inlineHelp":"A Signal that is dispatched each time a pointer is tapped.","line":263,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUp","type":["Phaser.Signal"],"help":"","inlineHelp":"A Signal that is dispatched each time a pointer is released.","line":258,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer1","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":160,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer10","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":205,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer2","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":165,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer3","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":170,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer4","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":175,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer5","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":180,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer6","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":185,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer7","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":190,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer8","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":195,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointer9","type":["Phaser.Pointer"],"help":"","inlineHelp":"A Pointer object.","line":200,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pollLocked","type":["boolean"],"help":"","inlineHelp":"True if the Input is currently poll rate locked.","line":915,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pollRate","type":["number"],"help":"","inlineHelp":"How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps); a value of 1 means every other frame (30fps) and so on.","line":53,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"A point object representing the current position of the Pointer.","line":73,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"recordLimit","type":["number"],"help":"The total number of entries that can be recorded into the Pointer objects tracking history.\\nIf the Pointer is tracking one event every 100ms; then a trackLimit of 100 would store the last 10 seconds worth of history.","inlineHelp":"","line":155,"default":"100","public":true,"protected":false,"private":false,"readOnly":false},{"name":"recordPointerHistory","type":["boolean"],"help":"Sets if the Pointer objects should record a history of x\/y coordinates they have passed through.\\nThe history is cleared each time the Pointer is pressed down.\\nThe history is updated at the rate specified in Input.pollRate","inlineHelp":"","line":141,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"recordRate","type":["number"],"help":"","inlineHelp":"The rate in milliseconds at which the Pointer objects should update their tracking history.","line":147,"default":"100","public":true,"protected":false,"private":false,"readOnly":false},{"name":"resetLocked","type":["boolean"],"help":"","inlineHelp":"If the Input Manager has been reset locked then all calls made to InputManager.reset, such as from a State change, are ignored.","line":248,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale by which all input coordinates are multiplied; calculated by the ScaleManager. In an un-scaled game the values will be x = 1 and y = 1.","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"speed","type":["Phaser.Point"],"help":"","inlineHelp":"A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.","line":78,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tapRate","type":["number"],"help":"","inlineHelp":"The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.","line":108,"default":"200","public":true,"protected":false,"private":false,"readOnly":false},{"name":"totalActivePointers","type":["number"],"help":"The total number of active Pointers","inlineHelp":"The total number of active Pointers.","line":943,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"totalInactivePointers","type":["number"],"help":"The total number of inactive Pointers","inlineHelp":"The total number of inactive Pointers.","line":929,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"touch","type":["Phaser.Touch"],"help":"","inlineHelp":"the Touch Input manager.","line":232,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldX","type":["number"],"help":"The world X coordinate of the most recently active pointer.","inlineHelp":"The world X coordinate of the most recently active pointer.","line":968,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldY","type":["number"],"help":"The world Y coordinate of the most recently active pointer.","inlineHelp":"The world Y coordinate of the most recently active pointer.","line":981,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX\/clientX for source values.","inlineHelp":"The X coordinate of the most recently active pointer.","line":881,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY\/clientY for source values.","inlineHelp":"The Y coordinate of the most recently active pointer.","line":898,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_localPoint","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":286,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_oldPosition","type":["Phaser.Point"],"help":"","inlineHelp":"A point object representing the previous position of the Pointer.","line":298,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pollCounter","type":["number"],"help":"","inlineHelp":"Internal var holding the current poll counter.","line":292,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_x","type":["number"],"help":"","inlineHelp":"x coordinate of the most recent Pointer event","line":304,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_y","type":["number"],"help":"","inlineHelp":"Y coordinate of the most recent Pointer event","line":310,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.InputHandler.json b/docgen/output/Phaser.InputHandler.json deleted file mode 100644 index 3220c1f8c..000000000 --- a/docgen/output/Phaser.InputHandler.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.InputHandler","extends":"","static":false,"constructor":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite object to which this Input Handler belongs.","optional":false,"default":null}],"help":"The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite."},"consts":[],"methods":{"public":[{"name":"checkBoundsRect","static":false,"returns":null,"help":"Bounds Rect check for the sprite drag","line":1421,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkBoundsSprite","static":false,"returns":null,"help":"Parent Sprite Bounds check for the sprite drag.","line":1470,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkPixel","static":false,"returns":{"types":["boolean"],"help":"true if there is the alpha of the pixel is >= InputHandler.pixelPerfectAlpha"},"help":"Runs a pixel perfect check against the given x\/y coordinates of the Sprite this InputHandler is bound to.\\nIt compares the alpha value of the pixel and if >= InputHandler.pixelPerfectAlpha it returns true.","line":728,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to check.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to check.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The pointer to get the x\/y coordinate from if not passed as the first two parameters.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkPointerDown","static":false,"returns":{"types":["boolean"],"help":"True if the pointer is down, otherwise false."},"help":"Checks if the given pointer is both down and over the Sprite this InputHandler belongs to.\\nUse the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.","line":658,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"fastTest","type":["boolean"],"help":"Force a simple hit area check even if `pixelPerfectOver` is true for this object?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"checkPointerOver","static":false,"returns":{"types":["boolean"],"help":""},"help":"Checks if the given pointer is over the Sprite this InputHandler belongs to.\\nUse the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.","line":693,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"fastTest","type":["boolean"],"help":"Force a simple hit area check even if `pixelPerfectOver` is true for this object?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clean up memory.","line":386,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableDrag","static":false,"returns":null,"help":"Stops this sprite from being able to be dragged. If it is currently the target of an active drag it will be stopped immediately. Also disables any set callbacks.","line":1230,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableSnap","static":false,"returns":null,"help":"Stops the sprite from snapping to a grid during drag or release.","line":1410,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"downDuration","static":false,"returns":{"types":["number"],"help":"The number of milliseconds the pointer has been pressed down on the Sprite, or -1 if not over."},"help":"If the pointer is currently over this Sprite this returns how long it has been there for in milliseconds.","line":1173,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"enableDrag","static":false,"returns":null,"help":"Make this Sprite draggable by the mouse. You can also optionally set mouseStartDragCallback and mouseStopDragCallback","line":1196,"public":true,"protected":false,"private":false,"parameters":[{"name":"lockCenter","type":["boolean"],"help":"If false the Sprite will drag from where you click it minus the dragOffset. If true it will center itself to the tip of the mouse pointer.","optional":true,"default":"false"},{"name":"bringToTop","type":["boolean"],"help":"If true the Sprite will be bought to the top of the rendering list in its current Group.","optional":true,"default":"false"},{"name":"pixelPerfect","type":["boolean"],"help":"If true it will use a pixel perfect test to see if you clicked the Sprite. False uses the bounding box.","optional":true,"default":"false"},{"name":"alphaThreshold","type":["boolean"],"help":"If using pixel perfect collision this specifies the alpha level from 0 to 255 above which a collision is processed.","optional":true,"default":"255"},{"name":"boundsRect","type":["Phaser.Rectangle"],"help":"If you want to restrict the drag of this sprite to a specific Rectangle, pass the Phaser.Rectangle here, otherwise it's free to drag anywhere.","optional":true,"default":"null"},{"name":"boundsSprite","type":["Phaser.Sprite"],"help":"If you want to restrict the drag of this sprite to within the bounding box of another sprite, pass it here.","optional":true,"default":"null"}],"inherited":false,"inheritedFrom":""},{"name":"enableSnap","static":false,"returns":null,"help":"Make this Sprite snap to the given grid either during drag or when it's released.\\nFor example 16x16 as the snapX and snapY would make the sprite snap to every 16 pixels.","line":1390,"public":true,"protected":false,"private":false,"parameters":[{"name":"snapX","type":["number"],"help":"The width of the grid cell to snap to.","optional":false,"default":null},{"name":"snapY","type":["number"],"help":"The height of the grid cell to snap to.","optional":false,"default":null},{"name":"onDrag","type":["boolean"],"help":"If true the sprite will snap to the grid while being dragged.","optional":true,"default":"true"},{"name":"onRelease","type":["boolean"],"help":"If true the sprite will snap to the grid when released.","optional":true,"default":"false"},{"name":"snapOffsetX","type":["number"],"help":"Used to offset the top-left starting point of the snap grid.","optional":true,"default":"0"},{"name":"snapOffsetX","type":["number"],"help":"Used to offset the top-left starting point of the snap grid.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"globalToLocalX","static":false,"returns":null,"help":"Warning: EXPERIMENTAL","line":1299,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"globalToLocalY","static":false,"returns":null,"help":"Warning: EXPERIMENTAL","line":1316,"public":true,"protected":false,"private":false,"parameters":[{"name":"y","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isPixelPerfect","static":false,"returns":{"types":["boolean"],"help":"True if the this InputHandler has either `pixelPerfectClick` or `pixelPerfectOver` set to `true`."},"help":"Is this object using pixel perfect checking?","line":449,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"justOut","static":false,"returns":{"types":["boolean"],"help":""},"help":"Returns true if the pointer has left the Sprite within the specified delay time (defaults to 500ms, half a second)","line":1107,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The time below which the pointer is considered as just out.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justOver","static":false,"returns":{"types":["boolean"],"help":""},"help":"Returns true if the pointer has entered the Sprite within the specified delay time (defaults to 500ms, half a second)","line":1091,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The time below which the pointer is considered as just over.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":""},"help":"Returns true if the pointer has touched or clicked on the Sprite within the specified delay time (defaults to 500ms, half a second)","line":1123,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The time below which the pointer is considered as just over.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":""},"help":"Returns true if the pointer was touching this Sprite, but has been released within the specified delay time (defaults to 500ms, half a second)","line":1139,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The time below which the pointer is considered as just out.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"overDuration","static":false,"returns":{"types":["number"],"help":"The number of milliseconds the pointer has been over the Sprite, or -1 if not over."},"help":"If the pointer is currently over this Sprite this returns how long it has been there for in milliseconds.","line":1154,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerDown","static":false,"returns":{"types":["boolean"],"help":"- True if the given pointer is down, otherwise false."},"help":"If the Pointer is down this returns true. Please note that it only checks if the Pointer is down, not if it's down over any specific Sprite.","line":494,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["number"],"help":"The index of the pointer to check. You can get this from Phaser.Pointer.id.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerDragged","static":false,"returns":{"types":["boolean"],"help":"True if the pointer is dragging an object, otherwise false."},"help":"Is this sprite being dragged by the mouse or not?","line":641,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerOut","static":false,"returns":{"types":["boolean"],"help":"True if the given pointer (if a index was given, or any pointer if not) is out of this object."},"help":"Is the Pointer outside of this Sprite?","line":583,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The ID number of a Pointer to check. If you don't provide a number it will check all Pointers.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerOver","static":false,"returns":{"types":["boolean"],"help":"- True if the given pointer (if a index was given, or any pointer if not) is over this object."},"help":"Is the Pointer over this Sprite?","line":553,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The ID number of a Pointer to check. If you don't provide a number it will check all Pointers.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerTimeDown","static":false,"returns":{"types":["number"],"help":""},"help":"A timestamp representing when the Pointer first touched the touchscreen.","line":524,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["number"],"help":"The index of the pointer to check. You can get this from Phaser.Pointer.id.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerTimeOut","static":false,"returns":{"types":["number"],"help":""},"help":"A timestamp representing when the Pointer left the touchscreen.","line":627,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerTimeOver","static":false,"returns":{"types":["number"],"help":""},"help":"A timestamp representing when the Pointer first touched the touchscreen.","line":613,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerTimeUp","static":false,"returns":{"types":["number"],"help":""},"help":"A timestamp representing when the Pointer left the touchscreen.","line":538,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerUp","static":false,"returns":{"types":["boolean"],"help":"- True if the given pointer is up, otherwise false."},"help":"If the Pointer is up this returns true. Please note that it only checks if the Pointer is up, not if it's up over any specific Sprite.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["number"],"help":"The index of the pointer to check. You can get this from Phaser.Pointer.id.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerX","static":false,"returns":{"types":["number"],"help":"The x coordinate of the Input pointer."},"help":"The x coordinate of the Input pointer, relative to the top-left of the parent Sprite.\\nThis value is only set when the pointer is over this Sprite.","line":463,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["number"],"help":"The index of the pointer to check. You can get this from Phaser.Pointer.id.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerY","static":false,"returns":{"types":["number"],"help":"The y coordinate of the Input pointer."},"help":"The y coordinate of the Input pointer, relative to the top-left of the parent Sprite\\nThis value is only set when the pointer is over this Sprite.","line":479,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["number"],"help":"The index of the pointer to check. You can get this from Phaser.Pointer.id.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the Input Handler and disables it.","line":337,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setDragLock","static":false,"returns":null,"help":"Restricts this sprite to drag movement only on the given axis. Note: If both are set to false the sprite will never move!","line":1369,"public":true,"protected":false,"private":false,"parameters":[{"name":"allowHorizontal","type":["boolean"],"help":"To enable the sprite to be dragged horizontally set to true, otherwise false.","optional":true,"default":"true"},{"name":"allowVertical","type":["boolean"],"help":"To enable the sprite to be dragged vertically set to true, otherwise false.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":{"types":["Phaser.Sprite"],"help":"The Sprite object to which the Input Handler is bound."},"help":"Starts the Input Handler running. This is called automatically when you enable input on a Sprite, or can be called directly if you need to set a specific priority.","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"priority","type":["number"],"help":"Higher priority sprites take click priority over low-priority sprites when they are stacked on-top of each other.","optional":false,"default":null},{"name":"useHandCursor","type":["boolean"],"help":"If true the Sprite will show the hand cursor on mouse-over (doesn't apply to mobile browsers)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"startDrag","static":false,"returns":null,"help":"Called by Pointer when drag starts on this Sprite. Should not usually be called directly.","line":1251,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops the Input Handler from running.","line":366,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stopDrag","static":false,"returns":null,"help":"Called by Pointer when drag is stopped on this Sprite. Should not usually be called directly.","line":1333,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateDrag","static":false,"returns":{"types":["boolean"],"help":""},"help":"Updates the Pointer drag on this Sprite.","line":1012,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"update","static":false,"returns":null,"help":"Update.","line":794,"public":false,"protected":true,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"validForInput","static":false,"returns":{"types":["boolean"],"help":"True if the object this InputHandler is bound to should be considered as valid for input detection."},"help":"Checks if the object this InputHandler is bound to is valid for consideration in the Pointer move event.\\nThis is called by Phaser.Pointer and shouldn't typically be called directly.","line":419,"public":false,"protected":true,"private":false,"parameters":[{"name":"highestID","type":["number"],"help":"The highest ID currently processed by the Pointer.","optional":false,"default":null},{"name":"highestRenderID","type":["number"],"help":"The highest Render Order ID currently processed by the Pointer.","optional":false,"default":null},{"name":"includePixelPerfect","type":["boolean"],"help":"If this object has `pixelPerfectClick` or `pixelPerfectOver` set should it be considered as valid?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"_pointerOutHandler","static":false,"returns":null,"help":"Internal method handling the pointer out event.","line":872,"public":false,"protected":false,"private":true,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_pointerOverHandler","static":false,"returns":null,"help":"Internal method handling the pointer over event.","line":835,"public":false,"protected":false,"private":true,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_releasedHandler","static":false,"returns":null,"help":"Internal method handling the pointer released event.","line":953,"public":false,"protected":false,"private":true,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_touchedHandler","static":false,"returns":null,"help":"Internal method handling the touched event.","line":903,"public":false,"protected":false,"private":true,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addedToGroup","static":false,"returns":null,"help":"Handles when the parent Sprite is added to a new Group.","line":294,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removedFromGroup","static":false,"returns":null,"help":"Handles when the parent Sprite is removed from a Group.","line":314,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"allowHorizontalDrag","type":["boolean"],"help":"","inlineHelp":"Controls if the Sprite is allowed to be dragged horizontally.","line":69,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"allowVerticalDrag","type":["boolean"],"help":"","inlineHelp":"Controls if the Sprite is allowed to be dragged vertically.","line":75,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsRect","type":["Phaser.Rectangle"],"help":"","inlineHelp":"A region of the game world within which the sprite is restricted during drag.","line":159,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsSprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"A Sprite the bounds of which this sprite is restricted during drag.","line":165,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"bringToTop","type":["boolean"],"help":"","inlineHelp":"If true when this Sprite is clicked or dragged it will automatically be bought to the top of the Group it is within.","line":81,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"consumePointerEvent","type":["boolean"],"help":"If this object is set to consume the pointer event then it will stop all propogation from this object on.\\nFor example if you had a stack of 6 sprites with the same priority IDs and one consumed the event, none of the others would receive it.","inlineHelp":"","line":173,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"draggable","type":["boolean"],"help":"","inlineHelp":"Is this sprite allowed to be dragged by the mouse? true = yes, false = no","line":153,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enabled","type":["boolean"],"help":"","inlineHelp":"If enabled the Input Handler will process input requests and monitor pointer activity.","line":30,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isDragged","type":["boolean"],"help":"","inlineHelp":"true if the Sprite is being currently dragged.","line":63,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixelPerfectAlpha","type":["number"],"help":"","inlineHelp":"The alpha tolerance threshold. If the alpha value of the pixel matches or is above this value, it's considered a hit.","line":147,"default":"255","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixelPerfectClick","type":["number"],"help":"Set to true to use pixel perfect hit detection when checking if the pointer is over this Sprite when it's clicked or touched.\\nThe x\/y coordinates of the pointer are tested against the image in combination with the InputHandler.pixelPerfectAlpha value.\\nWarning: This is expensive so only enable if you really need it.","inlineHelp":"Use a pixel perfect check when testing for clicks or touches on the Sprite.","line":141,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixelPerfectOver","type":["number"],"help":"Set to true to use pixel perfect hit detection when checking if the pointer is over this Sprite.\\nThe x\/y coordinates of the pointer are tested against the image in combination with the InputHandler.pixelPerfectAlpha value.\\nWarning: This is expensive, especially on mobile (where it's not even needed!) so only enable if required. Also see the less-expensive InputHandler.pixelPerfectClick.","inlineHelp":"Use a pixel perfect check when testing for pointer over.","line":132,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"priorityID","type":["number"],"help":"The priorityID is used to determine which game objects should get priority when input events occur. For example if you have\\nseveral Sprites that overlap, by default the one at the top of the display list is given priority for input events. You can\\nstop this from happening by controlling the priorityID value. The higher the value, the more important they are considered to the Input events.","inlineHelp":"","line":45,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleLayer","type":["boolean"],"help":"","inlineHelp":"EXPERIMENTAL: Please do not use this property unless you know what it does. Likely to change in the future.","line":178,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapOffset","type":["Phaser.Point"],"help":"","inlineHelp":"A Point object that contains by how far the Sprite snap is offset.","line":87,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapOffsetX","type":["number"],"help":"","inlineHelp":"This defines the top-left X coordinate of the snap grid.","line":117,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapOffsetY","type":["number"],"help":"","inlineHelp":"This defines the top-left Y coordinate of the snap grid..","line":123,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapOnDrag","type":["boolean"],"help":"","inlineHelp":"When the Sprite is dragged this controls if the center of the Sprite will snap to the pointer on drag or not.","line":93,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapOnRelease","type":["boolean"],"help":"","inlineHelp":"When the Sprite is dragged this controls if the Sprite will be snapped on release.","line":99,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapX","type":["number"],"help":"","inlineHelp":"When a Sprite has snapping enabled this holds the width of the snap grid.","line":105,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"snapY","type":["number"],"help":"","inlineHelp":"When a Sprite has snapping enabled this holds the height of the snap grid.","line":111,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"sprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"The Sprite object to which this Input Handler belongs.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"useHandCursor","type":["boolean"],"help":"","inlineHelp":"On a desktop browser you can set the 'hand' cursor to appear when moving over the Sprite.","line":51,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"checked","type":["boolean"],"help":"","inlineHelp":"A disposable flag used by the Pointer class when performing priority checks.","line":36,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_dragPhase","type":["boolean"],"help":"","inlineHelp":"Internal cache var.","line":184,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pointerData","type":["array"],"help":"","inlineHelp":"Internal cache var.","line":202,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_setHandCursor","type":["boolean"],"help":"","inlineHelp":"Did this Sprite trigger the hand cursor?","line":57,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempPoint","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":196,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_wasEnabled","type":["boolean"],"help":"","inlineHelp":"Internal cache var.","line":190,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Key.json b/docgen/output/Phaser.Key.json deleted file mode 100644 index adc4b5c75..000000000 --- a/docgen/output/Phaser.Key.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Key","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"keycode","type":["number"],"help":"The key code this Key is responsible for.","optional":false,"default":null}],"help":"If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects."},"consts":[],"methods":{"public":[{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"True if the key is just pressed otherwise false."},"help":"Returns the \"just pressed\" state of the Key. Just pressed is considered true if the key was pressed down within the duration given.","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The duration below which the key is considered as being just pressed.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":"True if the key is just released otherwise false."},"help":"Returns the \"just released\" state of the Key. Just released is considered as being true if the key was released within the duration given.","line":239,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The duration below which the key is considered as being just released.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the state of this Key. This sets isDown to false, isUp to true, resets the time to be the current time and clears any callbacks\\nassociated with the onDown and onUp events and nulls the onHoldCallback if set.","line":199,"public":true,"protected":false,"private":false,"parameters":[{"name":"hard","type":["boolean"],"help":"A soft reset won't reset any events or callbacks that are bound to this Key. A hard reset will.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"processKeyDown","static":false,"returns":null,"help":"Called automatically by Phaser.Keyboard.","line":141,"public":false,"protected":true,"private":false,"parameters":[{"name":"event.","type":["KeyboardEvent"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processKeyUp","static":false,"returns":null,"help":"Called automatically by Phaser.Keyboard.","line":172,"public":false,"protected":true,"private":false,"parameters":[{"name":"event.","type":["KeyboardEvent"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"altKey","type":["boolean"],"help":"","inlineHelp":"The down state of the ALT key, if pressed at the same time as this key.","line":50,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ctrlKey","type":["boolean"],"help":"","inlineHelp":"The down state of the CTRL key, if pressed at the same time as this key.","line":56,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"duration","type":["number"],"help":"If the key is down this value holds the duration of that key press and is constantly updated.\\nIf the key is up it holds the duration of the previous down session.","inlineHelp":"The number of milliseconds this key has been held down for.","line":75,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enabled","type":["boolean"],"help":"","inlineHelp":"An enabled key processes its update and dispatches events. You can toggle this at run-time to disable a key without deleting it.","line":26,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["object"],"help":"","inlineHelp":"Stores the most recent DOM event.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isDown","type":["boolean"],"help":"","inlineHelp":"The \"down\" state of the key.","line":38,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isUp","type":["boolean"],"help":"","inlineHelp":"The \"up\" state of the key.","line":44,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"keyCode","type":["number"],"help":"","inlineHelp":"The keycode of this key.","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDown","type":["Phaser.Signal"],"help":"","inlineHelp":"This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onHoldCallback","type":["function"],"help":"","inlineHelp":"A callback that is called while this Key is held down. Warning: Depending on refresh rate that could be 60+ times per second.","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onHoldContext","type":["object"],"help":"","inlineHelp":"The context under which the onHoldCallback will be called.","line":107,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUp","type":["Phaser.Signal"],"help":"","inlineHelp":"This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"repeats","type":["number"],"help":"","inlineHelp":"If a key is held down this holds down the number of times the key has 'repeated'.","line":87,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"shiftKey","type":["boolean"],"help":"","inlineHelp":"The down state of the SHIFT key, if pressed at the same time as this key.","line":62,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeDown","type":["number"],"help":"","inlineHelp":"The timestamp when the key was last pressed down. This is based on Game.time.now.","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeUp","type":["number"],"help":"","inlineHelp":"The timestamp when the key was last released. This is based on Game.time.now.","line":81,"default":"-2500","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Keyboard.json b/docgen/output/Phaser.Keyboard.json deleted file mode 100644 index 9572e60c8..000000000 --- a/docgen/output/Phaser.Keyboard.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Keyboard","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Keyboard class handles looking after keyboard input for your game.\\nIt will recognise and respond to key presses and dispatch the required events.\\nPlease be aware that lots of keyboards are unable to process certain combinations of keys due to hardware\\nlimitations known as ghosting. Full details here: http:\/\/www.html5gamedevs.com\/topic\/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time\/"},"consts":[],"methods":{"public":[{"name":"addCallbacks","static":false,"returns":null,"help":"Add callbacks to the Keyboard handler so that each time a key is pressed down or released the callbacks are activated.","line":119,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context under which the callbacks are run.","optional":false,"default":null},{"name":"onDown","type":["function"],"help":"This callback is invoked every time a key is pressed down.","optional":true,"default":"null"},{"name":"onUp","type":["function"],"help":"This callback is invoked every time a key is released.","optional":true,"default":"null"},{"name":"onPress","type":["function"],"help":"This callback is invoked every time the onkeypress event is raised.","optional":true,"default":"null"}],"inherited":false,"inheritedFrom":""},{"name":"addKey","static":false,"returns":{"types":["Phaser.Key"],"help":"The Key object which you can store locally and reference directly."},"help":"If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method.\\nThe Key object can then be polled, have events attached to it, etc.","line":148,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addKeyCapture","static":false,"returns":null,"help":"By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\\nThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\\nYou can use addKeyCapture to consume the keyboard event for specific keys so it doesn't bubble up to the the browser.\\nPass in either a single keycode or an array\/hash of keycodes.","line":277,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number","array","object"],"help":"Either a single numeric keycode or an array\/hash of keycodes: [65, 67, 68].","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearCaptures","static":false,"returns":null,"help":"Clear all set key captures.","line":309,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"createCursorKeys","static":false,"returns":{"types":["object"],"help":"An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object."},"help":"Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.","line":184,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the window.\\nAlso clears all key captures and currently created Key objects.","line":257,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isDown","static":false,"returns":{"types":["boolean"],"help":"True if the key is currently down."},"help":"Returns true of the key is currently pressed down. Note that it can only detect key presses on the web browser.","line":507,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"True if the key is just pressed otherwise false."},"help":"Returns the \"just pressed\" state of the key. Just pressed is considered true if the key was pressed down within the duration given (default 250ms)","line":462,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration below which the key is considered as being just pressed.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":"True if the key is just released otherwise false."},"help":"Returns the \"just released\" state of the Key. Just released is considered as being true if the key was released within the duration given (default 250ms)","line":485,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration below which the key is considered as being just released.","optional":true,"default":"50"}],"inherited":false,"inheritedFrom":""},{"name":"removeKey","static":false,"returns":null,"help":"Removes a Key object from the Keyboard manager.","line":167,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeKeyCapture","static":false,"returns":null,"help":"Removes an existing key capture.","line":298,"public":true,"protected":false,"private":false,"parameters":[{"name":"keycode","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets all Keys.","line":436,"public":true,"protected":false,"private":false,"parameters":[{"name":"hard","type":["boolean"],"help":"A soft reset won't reset any events or callbacks that are bound to the Keys. A hard reset will.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the Keyboard event listeners running (keydown and keyup). They are attached to the window.\\nThis is called automatically by Phaser.Input and should not normally be invoked directly.","line":201,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops the Keyboard event listeners from running (keydown, keyup and keypress). They are removed from the window.","line":239,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates all currently defined keys.","line":320,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"processKeyDown","static":false,"returns":null,"help":"Process the keydown event.","line":341,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["KeyboardEvent"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processKeyPress","static":false,"returns":null,"help":"Process the keypress event.","line":379,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["KeyboardEvent"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processKeyUp","static":false,"returns":null,"help":"Process the keyup event.","line":402,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["KeyboardEvent"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which the callbacks are run.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"You can disable all Keyboard Input by setting disabled to true. While true all new input related events will be ignored.","inlineHelp":"The disabled state of the Keyboard.","line":29,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["object"],"help":"","inlineHelp":"The most recent DOM event from keydown or keyup. This is updated every time a new key is pressed or released.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lastChar","type":["string"],"help":"Returns the string value of the most recently pressed key.","inlineHelp":"The string value of the most recently pressed key.","line":526,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"lastKey","type":["Phaser.Key"],"help":"Returns the most recently pressed Key. This is a Phaser.Key object and it changes every time a key is pressed.","inlineHelp":"The most recently pressed Key.","line":549,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"onDownCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a key is pressed down, including key repeats when a key is held down.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPressCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a DOM onkeypress event is raised, which is only for printable keys.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a key is released.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pressEvent","type":["object"],"help":"","inlineHelp":"The most recent DOM event from keypress.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_capture","type":["array"],"help":"","inlineHelp":"The array the key capture values are stored in.","line":71,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_i","type":["number"],"help":"","inlineHelp":"Internal cache var","line":98,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_k","type":["number"],"help":"","inlineHelp":"Internal cache var","line":104,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_keys","type":["array Phaser.Key"],"help":"","inlineHelp":"The array the Phaser.Key objects are stored in.","line":65,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onKeyDown","type":["function"],"help":"","inlineHelp":"","line":78,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onKeyPress","type":["function"],"help":"","inlineHelp":"","line":85,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onKeyUp","type":["function"],"help":"","inlineHelp":"","line":92,"default":"null","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Line.json b/docgen/output/Phaser.Line.json deleted file mode 100644 index a9444f4c1..000000000 --- a/docgen/output/Phaser.Line.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Line","extends":"","static":false,"constructor":true,"parameters":[{"name":"x1","type":["number"],"help":"The x coordinate of the start of the line.","optional":true,"default":"0"},{"name":"y1","type":["number"],"help":"The y coordinate of the start of the line.","optional":true,"default":"0"},{"name":"x2","type":["number"],"help":"The x coordinate of the end of the line.","optional":true,"default":"0"},{"name":"y2","type":["number"],"help":"The y coordinate of the end of the line.","optional":true,"default":"0"}],"help":"Creates a new Line object with a start and an end point."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Line"],"help":"The cloned Line object."},"help":"Returns a new Line object with the same values for the start and end properties as this Line object.","line":190,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Line"],"help":"Optional Line object. If given the values will be set into the object, otherwise a brand new Line object will be created and returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"coordinatesOnLine","static":false,"returns":{"types":["array"],"help":"An array of coordinates."},"help":"Using Bresenham's line algorithm this will return an array of all coordinates on this line.\\nThe start and end points are rounded before this runs as the algorithm works on integers.","line":135,"public":true,"protected":false,"private":false,"parameters":[{"name":"stepRate","type":["number"],"help":"How many steps will we return? 1 = every coordinate on the line, 2 = every other coordinate, etc.","optional":true,"default":"1"},{"name":"results","type":["array"],"help":"The array to store the results in. If not provided a new one will be generated.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromSprite","static":false,"returns":{"types":["Phaser.Line"],"help":"This line object"},"help":"Sets the line to match the x\/y coordinates of the two given sprites.\\nCan optionally be calculated from their center coordinates.","line":65,"public":true,"protected":false,"private":false,"parameters":[{"name":"startSprite","type":["Phaser.Sprite"],"help":"The coordinates of this Sprite will be set to the Line.start point.","optional":false,"default":null},{"name":"endSprite","type":["Phaser.Sprite"],"help":"The coordinates of this Sprite will be set to the Line.start point.","optional":false,"default":null},{"name":"useCenter","type":["boolean"],"help":"If true it will use startSprite.center.x, if false startSprite.x. Note that Sprites don't have a center property by default, so only enable if you've over-ridden your Sprite with a custom class.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":{"types":["Phaser.Point"],"help":"The intersection segment of the two lines as a Point, or null if there is no intersection."},"help":"Checks for intersection between two lines.\\nIf asSegment is true it will check for segment intersection.\\nIf asSegment is false it will check for line intersection.\\nReturns the intersection segment of AB and EF as a Point, or null if there is no intersection.\\nAdapted from code by Keith Hair","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Line"],"help":"The first Line to be checked.","optional":false,"default":null},{"name":"b","type":["Phaser.Line"],"help":"The second Line to be checked.","optional":false,"default":null},{"name":"asSegment","type":["boolean"],"help":"If true it will check for segment intersection, otherwise full line intersection.","optional":true,"default":"true"},{"name":"result","type":["Phaser.Point"],"help":"A Point object to store the result in, if not given a new one will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersectsPoints","static":false,"returns":{"types":["Phaser.Point"],"help":"The intersection segment of the two lines as a Point, or null if there is no intersection."},"help":"Checks for intersection between two lines as defined by the given start and end points.\\nIf asSegment is true it will check for line segment intersection. If asSegment is false it will check for line intersection.\\nReturns the intersection segment of AB and EF as a Point, or null if there is no intersection.\\nAdapted from code by Keith Hair","line":378,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The start of the first Line to be checked.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The end of the first line to be checked.","optional":false,"default":null},{"name":"e","type":["Phaser.Point"],"help":"The start of the second Line to be checked.","optional":false,"default":null},{"name":"f","type":["Phaser.Point"],"help":"The end of the second line to be checked.","optional":false,"default":null},{"name":"asSegment","type":["boolean"],"help":"If true it will check for segment intersection, otherwise full line intersection.","optional":true,"default":"true"},{"name":"result","type":["Phaser.Point"],"help":"A Point object to store the result in, if not given a new one will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointOnLine","static":false,"returns":{"types":["boolean"],"help":"True if the point is on the line, false if not."},"help":"Tests if the given coordinates fall on this line. See pointOnSegment to test against just the line segment.","line":102,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The line to check against this one.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The line to check against this one.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointOnSegment","static":false,"returns":{"types":["boolean"],"help":"True if the point is on the line and segment, false if not."},"help":"Tests if the given coordinates fall on this line and within the segment. See pointOnLine to test against just the line.","line":115,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The line to check against this one.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The line to check against this one.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Line"],"help":"This line object"},"help":"Sets the components of the Line to the specified values.","line":47,"public":true,"protected":false,"private":false,"parameters":[{"name":"x1","type":["number"],"help":"The x coordinate of the start of the line.","optional":true,"default":"0"},{"name":"y1","type":["number"],"help":"The y coordinate of the start of the line.","optional":true,"default":"0"},{"name":"x2","type":["number"],"help":"The x coordinate of the end of the line.","optional":true,"default":"0"},{"name":"y2","type":["number"],"help":"The y coordinate of the end of the line.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"angle","type":["number"],"help":"","inlineHelp":"Gets the angle of the line.","line":225,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bottom","type":["number"],"help":"","inlineHelp":"Gets the bottom-most point of this line.","line":329,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"end","type":["Phaser.Point"],"help":"","inlineHelp":"The end point of the line.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Gets the height of this bounds of this line.","line":355,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"left","type":["number"],"help":"","inlineHelp":"Gets the left-most point of this line.","line":290,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"length","type":["number"],"help":"","inlineHelp":"Gets the length of the line segment.","line":212,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"perpSlope","type":["number"],"help":"","inlineHelp":"Gets the perpendicular slope of the line (x\/y).","line":251,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"right","type":["number"],"help":"","inlineHelp":"Gets the right-most point of this line.","line":303,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"slope","type":["number"],"help":"","inlineHelp":"Gets the slope of the line (y\/x).","line":238,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"start","type":["Phaser.Point"],"help":"","inlineHelp":"The start point of the line.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"","inlineHelp":"Gets the top-most point of this line.","line":316,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"width","type":["number"],"help":"","inlineHelp":"Gets the width of this bounds of this line.","line":342,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"x","type":["number"],"help":"","inlineHelp":"Gets the x coordinate of the top left of the bounds around this line.","line":264,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"y","type":["number"],"help":"","inlineHelp":"Gets the y coordinate of the top left of the bounds around this line.","line":277,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.LinkedList.json b/docgen/output/Phaser.LinkedList.json deleted file mode 100644 index 28e598439..000000000 --- a/docgen/output/Phaser.LinkedList.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.LinkedList","extends":"","static":false,"constructor":true,"parameters":[],"help":"A basic linked list data structure."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["object"],"help":"The child that was added."},"help":"Adds a new element to this linked list.","line":56,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to add to this list. Can be a Phaser.Sprite or any other object you need to quickly iterate through.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all members of this list, using the member as the context for the callback.\\nThe function must exist on the member.","line":153,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function to call.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Removes the given element from this linked list if it exists.","line":103,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The child to be removed from the list.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the first, last, next and previous node pointers in this list.","line":87,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"first","type":["object"],"help":"","inlineHelp":"First element in the list.","line":31,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"last","type":["object"],"help":"","inlineHelp":"Last element in the list.","line":37,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"next","type":["object"],"help":"","inlineHelp":"Next element in the list.","line":19,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"prev","type":["object"],"help":"","inlineHelp":"Previous element in the list.","line":25,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"total","type":["number"],"help":"","inlineHelp":"Number of elements in the list.","line":43,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Loader.json b/docgen/output/Phaser.Loader.json deleted file mode 100644 index ed8d571f8..000000000 --- a/docgen/output/Phaser.Loader.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Loader","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.\\nIt uses a combination of Image() loading and xhr and provides progress and completion callbacks."},"consts":[{"name":"PHYSICS_LIME_CORONA_JSON","type":"number","help":"","line":173},{"name":"PHYSICS_PHASER_JSON","type":"number","help":"","line":179},{"name":"TEXTURE_ATLAS_JSON_ARRAY","type":"number","help":"","line":155},{"name":"TEXTURE_ATLAS_JSON_HASH","type":"number","help":"","line":161},{"name":"TEXTURE_ATLAS_XML_STARLING","type":"number","help":"","line":167}],"methods":{"public":[{"name":"atlas","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new texture atlas to the loader.","line":856,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the texture atlas file.","optional":false,"default":null},{"name":"textureURL","type":["string"],"help":"The url of the texture atlas image file.","optional":false,"default":null},{"name":"atlasURL","type":["string"],"help":"The url of the texture atlas data file (json\/xml). You don't need this if you are passing an atlasData object instead.","optional":true,"default":null},{"name":"atlasData","type":["object"],"help":"A JSON or XML data object. You don't need this if the data is being loaded from a URL.","optional":true,"default":null},{"name":"format","type":["number"],"help":"A value describing the format of the data, the default is Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"atlasJSONArray","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new texture atlas to the loader. This atlas uses the JSON Array data format.","line":807,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the texture atlas file.","optional":false,"default":null},{"name":"textureURL","type":["string"],"help":"The url of the texture atlas image file.","optional":false,"default":null},{"name":"atlasURL","type":["string"],"help":"The url of the texture atlas data file (json\/xml). You don't need this if you are passing an atlasData object instead.","optional":true,"default":null},{"name":"atlasData","type":["object"],"help":"A JSON or XML data object. You don't need this if the data is being loaded from a URL.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"atlasJSONHash","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new texture atlas to the loader. This atlas uses the JSON Hash data format.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the texture atlas file.","optional":false,"default":null},{"name":"textureURL","type":["string"],"help":"The url of the texture atlas image file.","optional":false,"default":null},{"name":"atlasURL","type":["string"],"help":"The url of the texture atlas data file (json\/xml). You don't need this if you are passing an atlasData object instead.","optional":true,"default":null},{"name":"atlasData","type":["object"],"help":"A JSON or XML data object. You don't need this if the data is being loaded from a URL.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"atlasXML","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new texture atlas to the loader. This atlas uses the Starling XML data format.","line":839,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the texture atlas file.","optional":false,"default":null},{"name":"textureURL","type":["string"],"help":"The url of the texture atlas image file.","optional":false,"default":null},{"name":"atlasURL","type":["string"],"help":"The url of the texture atlas data file (json\/xml). You don't need this if you are passing an atlasData object instead.","optional":true,"default":null},{"name":"atlasData","type":["object"],"help":"A JSON or XML data object. You don't need this if the data is being loaded from a URL.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"audio","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new audio file to the loader.","line":607,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the audio file.","optional":false,"default":null},{"name":"urls","type":["array","string"],"help":"An array containing the URLs of the audio files, i.e.: [ 'jump.mp3', 'jump.ogg', 'jump.m4a' ] or a single string containing just one URL.","optional":false,"default":null},{"name":"autoDecode","type":["boolean"],"help":"When using Web Audio the audio files can either be decoded at load time or run-time. They can't be played until they are decoded, but this let's you control when that happens. Decoding is a non-blocking async process.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"audiosprite","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new audiosprite file to the loader. Audio Sprites are a combination of audio files and a JSON configuration.\\nThe JSON follows the format of that created by https:\/\/github.com\/tonistiigi\/audiosprite","line":627,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the audio file.","optional":false,"default":null},{"name":"urls","type":["array","string"],"help":"An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.","optional":false,"default":null},{"name":"atlasURL","type":["string"],"help":"The URL of the audiosprite configuration json.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"binary","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a binary file to the Loader. It will be loaded via xhr with a responseType of \"arraybuffer\". You can specify an optional callback to process the file after load.\\nWhen the callback is called it will be passed 2 parameters: the key of the file and the file data.\\nWARNING: If you specify a callback, the file data will be set to whatever your callback returns. So always return the data object, even if you didn't modify it.","line":562,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the binary file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the binary file.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional callback that will be passed the file after loading, so you can perform additional processing on it.","optional":true,"default":null},{"name":"callbackContext","type":["function"],"help":"The context under which the callback will be applied. If not specified it will use the callback itself as the context.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"bitmapFont","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new bitmap font loading request.","line":745,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the bitmap font.","optional":false,"default":null},{"name":"textureURL","type":["string"],"help":"The url of the font image file.","optional":false,"default":null},{"name":"xmlURL","type":["string"],"help":"The url of the font data file (xml\/fnt)","optional":true,"default":null},{"name":"xmlData","type":["object"],"help":"An optional XML data object.","optional":true,"default":null},{"name":"xSpacing","type":["number"],"help":"If you'd like to add additional horizontal spacing between the characters then set the pixel value here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If you'd like to add additional vertical spacing between the lines then set the pixel value here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"checkKeyExists","static":false,"returns":{"types":["boolean"],"help":"Return true if exists, otherwise return false."},"help":"Check whether asset exists with a specific key.\\nUse Phaser.Cache to access loaded assets, e.g. Phaser.Cache#checkImageKey","line":224,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type asset you want to check.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Key of the asset you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"csvLoadComplete","static":false,"returns":null,"help":"Successfully loaded a CSV file.","line":1625,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that loaded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"dataLoadError","static":false,"returns":null,"help":"Error occured when load a JSON.","line":1650,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that errored.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fileComplete","static":false,"returns":null,"help":"Called when a file is successfully loaded.","line":1434,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that loaded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fileError","static":false,"returns":null,"help":"Error occured when loading a file.","line":1415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that errored.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAsset","static":false,"returns":{"types":["any"],"help":"Returns an object if found that has 2 properties: index and file. Otherwise false."},"help":"Gets the asset that is queued for load.","line":274,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type asset you want to check.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Key of the asset you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAssetIndex","static":false,"returns":{"types":["number"],"help":"The index of this key in the filelist, or -1 if not found."},"help":"Gets the fileList index for the given key.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type asset you want to check.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Key of the asset you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"image","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add an image to the Loader.","line":433,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of this image file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of image file.","optional":false,"default":null},{"name":"overwrite","type":["boolean"],"help":"If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"json","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a json file to the Loader.","line":485,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the json file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the json file.","optional":false,"default":null},{"name":"overwrite","type":["boolean"],"help":"If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"jsonLoadComplete","static":false,"returns":null,"help":"Successfully loaded a JSON file.","line":1581,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that loaded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pack","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add an image to the Loader.","line":397,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of this image file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the Asset Pack JSON file. If you wish to pass a json object instead set this to null and pass the object as the data parameter.","optional":true,"default":null},{"name":"data","type":["object"],"help":"The Asset Pack JSON data. Use this to pass in a json data object rather than loading it from a URL. TODO","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":"Some Loader operations, like Binary and Script require a context for their callbacks. Pass the context here.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"physics","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new physics data object loading request.\\nThe data must be in Lime + Corona JSON format. Physics Editor by code'n'web exports in this format natively.","line":701,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the physics json data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The url of the map data file (csv\/json)","optional":true,"default":null},{"name":"data","type":["object"],"help":"An optional JSON data object. If given then the url is ignored and this JSON object is used for physics data instead.","optional":true,"default":null},{"name":"format","type":["string"],"help":"The format of the physics data.","optional":true,"default":"Phaser.Physics.LIME_CORONA_JSON"}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all file loading requests.","line":948,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeFile","static":false,"returns":null,"help":"Remove loading request of a file.","line":932,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type of resource to add to the list (image, audio, xml, etc).","optional":false,"default":null},{"name":"key","type":["string"],"help":"Key of the file you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Reset loader, this will remove the load queue.","line":296,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"script","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a JavaScript file to the Loader. Once loaded the JavaScript file will be automatically turned into a script tag (and executed), so be careful what you load!\\nYou can also specify a callback. This will be executed as soon as the script tag has been created.","line":539,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the script file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the JavaScript file.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional callback that will be called after the script tag has loaded, so you can perform additional processing.","optional":true,"default":null},{"name":"callbackContext","type":["function"],"help":"The context under which the callback will be applied. If not specified it will use the callback itself as the context.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setPreloadSprite","static":false,"returns":null,"help":"You can set a Sprite to be a \"preload\" sprite by passing it to this method.\\nA \"preload\" sprite will have its width or height crop adjusted based on the percentage of the loader in real-time.\\nThis allows you to easily make loading bars for games. Note that Sprite.visible = true will be set when calling this.","line":192,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image"],"help":"The sprite or image that will be cropped during the load.","optional":false,"default":null},{"name":"direction","type":["number"],"help":"A value of zero means the sprite will be cropped horizontally, a value of 1 means its will be cropped vertically.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"spritesheet","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new sprite sheet to the loader.","line":586,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the sheet file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the sheet file.","optional":false,"default":null},{"name":"frameWidth","type":["number"],"help":"Width of each single frame.","optional":false,"default":null},{"name":"frameHeight","type":["number"],"help":"Height of each single frame.","optional":false,"default":null},{"name":"frameMax","type":["number"],"help":"How many frames in this sprite sheet. If not specified it will divide the whole image into frames.","optional":true,"default":"-1"},{"name":"margin","type":["number"],"help":"If the frames have been drawn with a margin, specify the amount here.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"If the frames have been drawn with spacing between them, specify the amount here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Start loading the assets. Normally you don't need to call this yourself as the StateManager will do so.","line":959,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"text","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a text file to the Loader.","line":459,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the text file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the text file.","optional":false,"default":null},{"name":"overwrite","type":["boolean"],"help":"If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"tilemap","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add a new tilemap loading request.","line":647,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the tilemap data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The url of the map data file (csv\/json)","optional":true,"default":null},{"name":"data","type":["object"],"help":"An optional JSON data object. If given then the url is ignored and this JSON object is used for map data instead.","optional":true,"default":null},{"name":"format","type":["number"],"help":"The format of the map data. Either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.","optional":true,"default":"Phaser.Tilemap.CSV"}],"inherited":false,"inheritedFrom":""},{"name":"totalLoadedFiles","static":false,"returns":{"types":["number"],"help":"The number of files that have already been loaded (even if they errored)"},"help":"Returns the number of files that have already been loaded, even if they errored.","line":1781,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"totalLoadedPacks","static":false,"returns":{"types":["number"],"help":"The number of asset packs that have already been loaded (even if they errored)"},"help":"Returns the number of asset packs that have already been loaded, even if they errored.","line":1825,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"totalQueuedFiles","static":false,"returns":{"types":["number"],"help":"The number of files that still remain in the load queue."},"help":"Returns the number of files still waiting to be processed in the load queue. This value decreases as each file in the queue is loaded.","line":1803,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"totalQueuedPacks","static":false,"returns":{"types":["number"],"help":"The number of asset packs that still remain in the load queue."},"help":"Returns the number of asset packs still waiting to be processed in the load queue. This value decreases as each pack in the queue is loaded.","line":1847,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"xml","static":false,"returns":{"types":["Phaser.Loader"],"help":"This Loader instance."},"help":"Add an XML file to the Loader.","line":511,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Unique asset key of the xml file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the xml file.","optional":false,"default":null},{"name":"overwrite","type":["boolean"],"help":"If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"xmlLoadComplete","static":false,"returns":null,"help":"Successfully loaded an XML file.","line":1669,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that loaded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"addToFileList","static":false,"returns":null,"help":"Internal function that adds a new entry to the file list. Do not call directly.","line":319,"public":false,"protected":true,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type of resource to add to the list (image, audio, xml, etc).","optional":false,"default":null},{"name":"key","type":["string"],"help":"The unique Cache ID key of this resource.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The URL the asset will be loaded from.","optional":false,"default":null},{"name":"properties","type":["object"],"help":"Any additional properties needed to load the file.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"replaceInFileList","static":false,"returns":null,"help":"Internal function that replaces an existing entry in the file list with a new one. Do not call directly.","line":355,"public":false,"protected":true,"private":false,"parameters":[{"name":"type","type":["string"],"help":"The type of resource to add to the list (image, audio, xml, etc).","optional":false,"default":null},{"name":"key","type":["string"],"help":"The unique Cache ID key of this resource.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The URL the asset will be loaded from.","optional":false,"default":null},{"name":"properties","type":["object"],"help":"Any additional properties needed to load the file.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"beginLoad","static":false,"returns":null,"help":"Starts off the actual loading process after the asset packs have been sorted out.","line":984,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getAudioURL","static":false,"returns":null,"help":"Private method ONLY used by loader.","line":1383,"public":false,"protected":false,"private":true,"parameters":[{"name":"urls","type":["array","string"],"help":"Either an array of audio file URLs or a string containing a single URL path.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"loadFile","static":false,"returns":null,"help":"Load files. Private method ONLY used by loader.","line":1195,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadPack","static":false,"returns":null,"help":"Loads the current asset pack in the queue.","line":1016,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"nextFile","static":false,"returns":null,"help":"Handle loading next file.","line":1732,"public":false,"protected":false,"private":true,"parameters":[{"name":"previousIndex","type":["number"],"help":"Index of the previously loaded asset.","optional":false,"default":null},{"name":"success","type":["boolean"],"help":"Whether the previous asset loaded successfully or not.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"nextPack","static":false,"returns":null,"help":"Handle loading the next asset pack.","line":1172,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"packError","static":false,"returns":null,"help":"Error occured when loading an asset pack.","line":1153,"public":false,"protected":false,"private":true,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that errored.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"packLoadComplete","static":false,"returns":null,"help":"Handle the successful loading of a JSON asset pack.","line":1046,"public":false,"protected":false,"private":true,"parameters":[{"name":"index","type":["number"],"help":"The index of the file in the file queue that loaded.","optional":false,"default":null},{"name":"parse","type":["boolean"],"help":"Automatically parse the JSON data?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"xhrLoad","static":false,"returns":null,"help":"Starts the xhr loader.","line":1357,"public":false,"protected":false,"private":true,"parameters":[{"name":"index","type":["number"],"help":"The index of the file to load from the file list.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The URL of the file.","optional":false,"default":null},{"name":"type","type":["string"],"help":"The xhr responseType.","optional":false,"default":null},{"name":"onload","type":["string"],"help":"A String of the name of the local function to be called on a successful file load.","optional":false,"default":null},{"name":"onerror","type":["string"],"help":"A String of the name of the local function to be called on a file load error.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseURL","type":["string"],"help":"If you want to append a URL before the path of any asset you can set this here.\\nUseful if you need to allow an asset url to be configured outside of the game code.\\nMUST have \/ on the end of it!","inlineHelp":"","line":69,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"crossOrigin","type":["boolean","string"],"help":"","inlineHelp":"The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.","line":60,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasLoaded","type":["boolean"],"help":"","inlineHelp":"True if all assets in the queue have finished loading.","line":33,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isLoading","type":["boolean"],"help":"","inlineHelp":"True if the Loader is in the process of loading the queue.","line":27,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFileComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when a file completes loading successfully.","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFileError","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when a file errors as a result of the load request.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFileStart","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched immediately before a file starts loading. It's possible the file may still error (404, etc) after this event is sent.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoadComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the final file in the load queue has either loaded or failed.","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoadStart","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the loading process starts, before the first file has been requested.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPackComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when an asset pack has either loaded or failed.","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preloadSprite","type":["object"],"help":"You can optionally link a sprite to the preloader.\\nIf you do so the Sprites width or height will be cropped based on the percentage loaded.\\nThis property is an object containing: sprite, rect, direction, width and height","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"progress","type":["number"],"help":"","inlineHelp":"The rounded load progress percentage value (from 0 to 100)","line":39,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"progressFloat","type":["number"],"help":"","inlineHelp":"The non-rounded load progress value (from 0.0 to 100.0)","line":45,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"useXDomainRequest","type":["boolean"],"help":"","inlineHelp":"If true and if the browser supports XDomainRequest, it will be used in preference for xhr when loading json files. It is enabled automatically if the browser is IE9, but you can disable it as required.","line":104,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"-","type":["XDomainRequest"],"help":"","inlineHelp":" An ajax request used specifically by IE9 for CORs loading issues.","line":147,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fileIndex","type":["number"],"help":"","inlineHelp":"The index of the current file being loaded.","line":128,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fileList","type":["array"],"help":"","inlineHelp":"Contains all the assets file infos.","line":122,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_packIndex","type":["number"],"help":"","inlineHelp":"The index of the current asset pack.","line":116,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_packList","type":["array"],"help":"","inlineHelp":"Contains all the assets packs.","line":110,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_progressChunk","type":["number"],"help":"","inlineHelp":"Indicates the size of 1 file in terms of a percentage out of 100.","line":135,"default":"0","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.LoaderParser.json b/docgen/output/Phaser.LoaderParser.json deleted file mode 100644 index 55b8e7af1..000000000 --- a/docgen/output/Phaser.LoaderParser.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.LoaderParser","extends":"","static":true,"constructor":false,"parameters":[],"help":"Phaser.LoaderParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into the Cache."},"consts":[],"methods":{"public":[{"name":"bitmapFont","static":false,"returns":null,"help":"Parse a Bitmap Font from an XML file.","line":24,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the current game.","optional":false,"default":null},{"name":"xml","type":["object"],"help":"XML data you want to parse.","optional":false,"default":null},{"name":"cacheKey","type":["string"],"help":"The key of the texture this font uses in the cache.","optional":false,"default":null},{"name":"xSpacing","type":["number"],"help":"Additional horizontal spacing between the characters.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"Additional vertical spacing between the characters.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.MSPointer.json b/docgen/output/Phaser.MSPointer.json deleted file mode 100644 index 46828fdf8..000000000 --- a/docgen/output/Phaser.MSPointer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.MSPointer","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The MSPointer class handles touch interactions with the game and the resulting Pointer objects.\\nIt will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 apps using JavaScript.\\nhttp:\/\/msdn.microsoft.com\/en-us\/library\/ie\/hh673557(v=vs.85).aspx"},"consts":[],"methods":{"public":[{"name":"onPointerDown","static":false,"returns":null,"help":"The function that handles the PointerDown event.","line":105,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["PointerEvent"],"help":"The native DOM event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onPointerMove","static":false,"returns":null,"help":"The function that handles the PointerMove event.","line":124,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["PointerEvent"],"help":"The native DOM event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onPointerUp","static":false,"returns":null,"help":"The function that handles the PointerUp event.","line":143,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["PointerEvent"],"help":"The native DOM event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the event listeners running.","line":60,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop the event listeners.","line":161,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which callbacks are called (defaults to game).","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"You can disable all Input by setting disabled = true. While set all new input related events will be ignored.","inlineHelp":"","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onMSPointerDown","type":["function"],"help":"","inlineHelp":"Internal function to handle MSPointer events.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMSPointerMove","type":["function"],"help":"","inlineHelp":"Internal function to handle MSPointer events.","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMSPointerUp","type":["function"],"help":"","inlineHelp":"Internal function to handle MSPointer events.","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Math.json b/docgen/output/Phaser.Math.json deleted file mode 100644 index 8e14f9c24..000000000 --- a/docgen/output/Phaser.Math.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Math","extends":"","static":true,"constructor":false,"parameters":[],"help":"A collection of mathematical methods."},"consts":[],"methods":{"public":[{"name":"Linear","static":false,"returns":{"types":["number"],"help":""},"help":"Calculates a linear value over t.","line":973,"public":true,"protected":false,"private":false,"parameters":[{"name":"p0","type":["number"],"help":"","optional":false,"default":null},{"name":"p1","type":["number"],"help":"","optional":false,"default":null},{"name":"t","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"PI2","static":false,"returns":null,"help":"= 2 π","line":18,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"angleBetween","static":false,"returns":{"types":["number"],"help":""},"help":"Find the angle of a segment from (x1, y1) -> (x2, y2).","line":338,"public":true,"protected":false,"private":false,"parameters":[{"name":"x1","type":["number"],"help":"","optional":false,"default":null},{"name":"y1","type":["number"],"help":"","optional":false,"default":null},{"name":"x2","type":["number"],"help":"","optional":false,"default":null},{"name":"y2","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleBetweenPoints","static":false,"returns":{"types":["number"],"help":""},"help":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).","line":365,"public":true,"protected":false,"private":false,"parameters":[{"name":"point1","type":["Phaser.Point"],"help":"","optional":false,"default":null},{"name":"point2","type":["Phaser.Point"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleBetweenPointsY","static":false,"returns":{"types":["number"],"help":""},"help":"Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).","line":376,"public":true,"protected":false,"private":false,"parameters":[{"name":"point1","type":["Phaser.Point"],"help":"","optional":false,"default":null},{"name":"point2","type":["Phaser.Point"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleBetweenY","static":false,"returns":{"types":["number"],"help":""},"help":"Find the angle of a segment from (x1, y1) -> (x2, y2).\\nNote that the difference between this method and Math.angleBetween is that this assumes the y coordinate travels\\ndown the screen.","line":354,"public":true,"protected":false,"private":false,"parameters":[{"name":"x1","type":["number"],"help":"","optional":false,"default":null},{"name":"y1","type":["number"],"help":"","optional":false,"default":null},{"name":"x2","type":["number"],"help":"","optional":false,"default":null},{"name":"y2","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleLimit","static":false,"returns":{"types":["number"],"help":"The new angle value, returns the same as the input angle if it was within bounds"},"help":"Keeps an angle value between the given min and max values.","line":859,"public":true,"protected":false,"private":false,"parameters":[{"name":"angle","type":["number"],"help":"The angle value to check. Must be between -180 and +180.","optional":false,"default":null},{"name":"min","type":["number"],"help":"The minimum angle that is allowed (must be -180 or greater).","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum angle that is allowed (must be 180 or less).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"average","static":false,"returns":{"types":["number"],"help":"The average of all given values."},"help":"Averages all values passed to the function and returns the result. You can pass as many parameters as you like.","line":86,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"bernstein","static":false,"returns":{"types":["number"],"help":""},"help":"","line":983,"public":true,"protected":false,"private":false,"parameters":[{"name":"n","type":["number"],"help":"","optional":false,"default":null},{"name":"i","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"bezierInterpolation","static":false,"returns":{"types":["number"],"help":""},"help":"A Bezier Interpolation Method, mostly used by Phaser.Tween.","line":910,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["array"],"help":"","optional":false,"default":null},{"name":"k","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"catmullRom","static":false,"returns":{"types":["number"],"help":""},"help":"Calculates a callmum rom value.","line":1020,"public":true,"protected":false,"private":false,"parameters":[{"name":"p0","type":["number"],"help":"","optional":false,"default":null},{"name":"p1","type":["number"],"help":"","optional":false,"default":null},{"name":"p2","type":["number"],"help":"","optional":false,"default":null},{"name":"p3","type":["number"],"help":"","optional":false,"default":null},{"name":"t","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"catmullRomInterpolation","static":false,"returns":{"types":["number"],"help":""},"help":"A Catmull Rom Interpolation Method, mostly used by Phaser.Tween.","line":931,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["array"],"help":"","optional":false,"default":null},{"name":"k","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"ceil","static":false,"returns":{"types":["number"],"help":"The rounded value of that number."},"help":"Round up to the next whole number. E.g. ceil(1.3) == 2, and ceil(-2.3) == -3.","line":1130,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"Any number.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"ceilTo","static":false,"returns":{"types":["number"],"help":""},"help":"","line":306,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The value to round.","optional":false,"default":null},{"name":"place","type":["number"],"help":"The place to round to.","optional":false,"default":null},{"name":"base","type":["number"],"help":"The base to round in... default is 10 for decimal.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"chanceRoll","static":false,"returns":{"types":["boolean"],"help":"True if the roll passed, or false otherwise."},"help":"Generate a random bool result based on the chance value.\\n

\\nReturns true or false based on the chance value (default 50%). For example if you wanted a player to have a 30% chance\\nof getting a bonus, call chanceRoll(30) - true means the chance passed, false means it failed.\\n<\/p>","line":441,"public":true,"protected":false,"private":false,"parameters":[{"name":"chance","type":["number"],"help":"The chance of receiving the value. A number between 0 and 100 (effectively 0% to 100%).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clamp","static":false,"returns":{"types":["number"],"help":""},"help":"Force a value within the boundaries of two values.\\nClamp value to range ","line":1276,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null},{"name":"a","type":["number"],"help":"","optional":false,"default":null},{"name":"b","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clampBottom","static":false,"returns":{"types":["number"],"help":""},"help":"Clamp value to range b+ε"},"help":"a is fuzzyGreaterThan b if it is more than b - ε.","line":54,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["number"],"help":"","optional":false,"default":null},{"name":"b","type":["number"],"help":"","optional":false,"default":null},{"name":"epsilon","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fuzzyLessThan","static":false,"returns":{"types":["boolean"],"help":"True if a to range ","line":1322,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":" the value to map","optional":false,"default":null},{"name":"a1","type":["number"],"help":" first endpoint of the range ","optional":false,"default":null},{"name":"a2","type":["number"],"help":" final endpoint of the range ","optional":false,"default":null},{"name":"b1","type":["number"],"help":" first endpoint of the range ","optional":false,"default":null},{"name":"b2","type":["number"],"help":" final endpoint of the range ","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"max","static":false,"returns":{"types":["number"],"help":"The largest value from those given."},"help":"Updated version of Math.max that can be passed either an array of numbers or the numbers as parameters.","line":752,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"maxAdd","static":false,"returns":{"types":["number"],"help":""},"help":"Adds the given amount to the value, but never lets the value go over the specified maximum.","line":569,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The value to add the amount to.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to add to the value.","optional":false,"default":null},{"name":"max-","type":["number"],"help":" The maximum the value is allowed to be.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"maxProperty","static":false,"returns":{"types":["number"],"help":"The largest value from those given."},"help":"Updated version of Math.max that can be passed a property and either an array of objects or the objects as parameters.\\nIt will find the largest matching property value from the given objects.","line":812,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"min","static":false,"returns":{"types":["number"],"help":"The lowest value from those given."},"help":"Updated version of Math.min that can be passed either an array of numbers or the numbers as parameters.\\nSee http:\/\/jsperf.com\/math-s-min-max-vs-homemade\/5","line":723,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"minProperty","static":false,"returns":{"types":["number"],"help":"The lowest value from those given."},"help":"Updated version of Math.min that can be passed a property and either an array of objects or the objects as parameters.\\nIt will find the lowest matching property value from the given objects.","line":782,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"minSub","static":false,"returns":{"types":["number"],"help":"The new value."},"help":"Subtracts the given amount from the value, but never lets the value go below the specified minimum.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The base value.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the base value.","optional":false,"default":null},{"name":"min","type":["number"],"help":"The minimum the value is allowed to be.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normalizeAngle","static":false,"returns":{"types":["number"],"help":"Returns the angle, fit within the [0,2pi] range, in radians."},"help":"Normalizes an angle to the [0,2pi) range.","line":396,"public":true,"protected":false,"private":false,"parameters":[{"name":"angleRad","type":["number"],"help":"The angle to normalize, in radians.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normalizeLatitude","static":false,"returns":{"types":["number"],"help":"Returns the latitude, fit within the [-90,90] range."},"help":"Normalizes a latitude to the [-90,90] range. Latitudes above 90 or below -90 are capped, not wrapped.","line":409,"public":true,"protected":false,"private":false,"parameters":[{"name":"lat","type":["number"],"help":"The latitude to normalize, in degrees.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normalizeLongitude","static":false,"returns":{"types":["number"],"help":"Returns the longitude, fit within the [-180,180] range."},"help":"Normalizes a longitude to the [-180,180] range. Longitudes above 180 or below -180 are wrapped.","line":419,"public":true,"protected":false,"private":false,"parameters":[{"name":"lng","type":["number"],"help":"The longitude to normalize, in degrees.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"numberArray","static":false,"returns":{"types":["array"],"help":"The array of number values."},"help":"Returns an Array containing the numbers from min to max and inclusive of both values.\\nIf you need exclusive of max then see Phaser.Math.numberArrayEx.","line":476,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value the array starts with.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value the array contains.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"numberArrayStep","static":true,"returns":null,"help":"Creates an array of numbers (positive and\/or negative) progressing from\\n`start` up to but not including `end`. If `start` is less than `stop` a\\nzero-length range is created unless a negative `step` is specified.\\n\\n\\nPhaser.Math.numberArrayStep(4);\\n\/\/ => [0, 1, 2, 3]\\n\\nPhaser.Math.numberArrayStep(1, 5);\\n\/\/ => [1, 2, 3, 4]\\n\\nPhaser.Math.numberArrayStep(0, 20, 5);\\n\/\/ => [0, 5, 10, 15]\\n\\nPhaser.Math.numberArrayStep(0, -4, -1);\\n\/\/ => [0, -1, -2, -3]\\n\\nPhaser.Math.numberArrayStep(1, 4, 0);\\n\/\/ => [1, 1, 1]\\n\\nPhaser.Math.numberArrayStep(0);\\n\/\/ => []","line":520,"public":true,"protected":false,"private":false,"parameters":[{"name":"start","type":["number"],"help":"The start of the range.","optional":true,"default":"0"},{"name":"end","type":["number"],"help":"The end of the range.","optional":false,"default":null},{"name":"step","type":["number"],"help":"The value to increment or decrement by.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"percent","static":false,"returns":{"types":["number"],"help":"The percentage a is of b, between 0 and 1."},"help":"Work out what percentage value a is of value b using the given base.","line":1383,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["number"],"help":"The value to work out the percentage for.","optional":false,"default":null},{"name":"b","type":["number"],"help":"The value you wish to get the percentage of.","optional":false,"default":null},{"name":"base","type":["number"],"help":"The base value.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"radToDeg","static":false,"returns":{"types":["function"],"help":""},"help":"Convert degrees to radians.","line":1426,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"randomSign","static":false,"returns":{"types":["number"],"help":" 1 or -1"},"help":"Randomly returns either a 1 or -1.","line":677,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeRandom","static":false,"returns":{"types":["object"],"help":"The random object that was removed."},"help":"Removes a random object from the given array and returns it.\\nWill return null if random selection is missing, or array has no entries.","line":1082,"public":true,"protected":false,"private":false,"parameters":[{"name":"objects","type":["array"],"help":"An array of objects.","optional":false,"default":null},{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reverseAngle","static":false,"returns":{"types":["number"],"help":"Returns the reverse angle, in radians."},"help":"Reverses an angle.","line":386,"public":true,"protected":false,"private":false,"parameters":[{"name":"angleRad","type":["number"],"help":"The angle to reverse, in radians.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"roundTo","static":false,"returns":{"types":["number"],"help":""},"help":"Round to some place comparative to a 'base', default is 10 for decimal place.\\n\\n'place' is represented by the power applied to 'base' to get that place\\ne.g.\\n2000\/7 ~= 285.714285714285714285714 ~= (bin)100011101.1011011011011011\\n\\nroundTo(2000\/7,3) === 0\\nroundTo(2000\/7,2) == 300\\nroundTo(2000\/7,1) == 290\\nroundTo(2000\/7,0) == 286\\nroundTo(2000\/7,-1) == 285.7\\nroundTo(2000\/7,-2) == 285.71\\nroundTo(2000\/7,-3) == 285.714\\nroundTo(2000\/7,-4) == 285.7143\\nroundTo(2000\/7,-5) == 285.71429\\n\\nroundTo(2000\/7,3,2) == 288 -- 100100000\\nroundTo(2000\/7,2,2) == 284 -- 100011100\\nroundTo(2000\/7,1,2) == 286 -- 100011110\\nroundTo(2000\/7,0,2) == 286 -- 100011110\\nroundTo(2000\/7,-1,2) == 285.5 -- 100011101.1\\nroundTo(2000\/7,-2,2) == 285.75 -- 100011101.11\\nroundTo(2000\/7,-3,2) == 285.75 -- 100011101.11\\nroundTo(2000\/7,-4,2) == 285.6875 -- 100011101.1011\\nroundTo(2000\/7,-5,2) == 285.71875 -- 100011101.10111\\n\\nNote what occurs when we round to the 3rd space (8ths place), 100100000, this is to be assumed\\nbecause we are rounding 100011.1011011011011011 which rounds up.","line":270,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The value to round.","optional":false,"default":null},{"name":"place","type":["number"],"help":"The place to round to.","optional":false,"default":null},{"name":"base","type":["number"],"help":"The base to round in... default is 10 for decimal.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shear","static":false,"returns":{"types":["number"],"help":"n mod 1"},"help":"","line":118,"public":true,"protected":false,"private":false,"parameters":[{"name":"n","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shift","static":false,"returns":{"types":["any"],"help":"The shifted value."},"help":"Removes the top element from the stack and re-inserts it onto the bottom, then returns it.\\nThe original stack is modified in the process. This effectively moves the position of the data from the start to the end of the table.","line":1183,"public":true,"protected":false,"private":false,"parameters":[{"name":"stack","type":["array"],"help":"The array to shift.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shuffleArray","static":false,"returns":{"types":["array"],"help":"The array"},"help":"Shuffles the data in the given array into a new order","line":1198,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to shuffle","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"sign","static":false,"returns":{"types":["number"],"help":""},"help":"A value representing the sign of the value.\\n-1 for negative, +1 for positive, 0 if value is 0","line":1368,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"sinCosGenerator","static":false,"returns":{"types":["array"],"help":"Returns the sine table"},"help":"Generate a sine and cosine table simultaneously and extremely quickly. Based on research by Franky of scene.at\\n

\\nThe parameters allow you to specify the length, amplitude and frequency of the wave. Once you have called this function\\nyou should get the results via getSinTable() and getCosTable(). This generator is fast enough to be used in real-time.\\n<\/p>","line":1148,"public":true,"protected":false,"private":false,"parameters":[{"name":"length","type":["number"],"help":"The length of the wave","optional":false,"default":null},{"name":"sinAmplitude","type":["number"],"help":"The amplitude to apply to the sine table (default 1.0) if you need values between say -+ 125 then give 125 as the value","optional":false,"default":null},{"name":"cosAmplitude","type":["number"],"help":"The amplitude to apply to the cosine table (default 1.0) if you need values between say -+ 125 then give 125 as the value","optional":false,"default":null},{"name":"frequency","type":["number"],"help":" - The frequency of the sine and cosine table data","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"smootherstep","static":false,"returns":{"types":["number"],"help":""},"help":"Smootherstep function as detailed at http:\/\/en.wikipedia.org\/wiki\/Smoothstep","line":1353,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null},{"name":"min","type":["number"],"help":"","optional":false,"default":null},{"name":"max","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"smoothstep","static":false,"returns":{"types":["number"],"help":""},"help":"Smoothstep function as detailed at http:\/\/en.wikipedia.org\/wiki\/Smoothstep","line":1337,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"","optional":false,"default":null},{"name":"min","type":["number"],"help":"","optional":false,"default":null},{"name":"max","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"snapTo","static":false,"returns":{"types":["number"],"help":""},"help":"Snap a value to nearest grid slice, using rounding.\\n\\nExample: if you have an interval gap of 5 and a position of 12... you will snap to 10 whereas 14 will snap to 15.","line":133,"public":true,"protected":false,"private":false,"parameters":[{"name":"input","type":["number"],"help":"The value to snap.","optional":false,"default":null},{"name":"gap","type":["number"],"help":"The interval gap of the grid.","optional":false,"default":null},{"name":"start","type":["number"],"help":"Optional starting offset for gap.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"snapToCeil","static":false,"returns":{"types":["number"],"help":""},"help":"Snap a value to nearest grid slice, using ceil.\\n\\nExample: if you have an interval gap of 5 and a position of 12... you will snap to 15. As will 14 will snap to 15... but 16 will snap to 20.","line":185,"public":true,"protected":false,"private":false,"parameters":[{"name":"input","type":["number"],"help":"The value to snap.","optional":false,"default":null},{"name":"gap","type":["number"],"help":"The interval gap of the grid.","optional":false,"default":null},{"name":"start","type":["number"],"help":"Optional starting offset for gap.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"snapToFloor","static":false,"returns":{"types":["number"],"help":""},"help":"Snap a value to nearest grid slice, using floor.\\n\\nExample: if you have an interval gap of 5 and a position of 12... you will snap to 10. As will 14 snap to 10... but 16 will snap to 15","line":159,"public":true,"protected":false,"private":false,"parameters":[{"name":"input","type":["number"],"help":"The value to snap.","optional":false,"default":null},{"name":"gap","type":["number"],"help":"The interval gap of the grid.","optional":false,"default":null},{"name":"start","type":["number"],"help":"Optional starting offset for gap.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"snapToInArray","static":false,"returns":{"types":["number"],"help":""},"help":"Snaps a value to the nearest value in an array.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"input","type":["number"],"help":"","optional":false,"default":null},{"name":"arr","type":["array"],"help":"","optional":false,"default":null},{"name":"sort","type":["boolean"],"help":"True if the array needs to be sorted.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"truncate","static":false,"returns":{"types":["number"],"help":""},"help":"","line":109,"public":true,"protected":false,"private":false,"parameters":[{"name":"n","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"within","static":false,"returns":{"types":["boolean"],"help":"True if a is <= tolerance of b."},"help":"Checks if two values are within the given tolerance of each other.","line":1305,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["number"],"help":"The first number to check","optional":false,"default":null},{"name":"b","type":["number"],"help":"The second number to check","optional":false,"default":null},{"name":"tolerance","type":["number"],"help":"The tolerance. Anything equal to or less than this is considered within the range.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"wrap","static":false,"returns":{"types":["number"],"help":"The wrapped value."},"help":"Ensures that the value always stays between min and max, by wrapping the value around.\\nmax should be larger than min, or the function will return 0.","line":614,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The value to wrap.","optional":false,"default":null},{"name":"min","type":["number"],"help":"The minimum the value is allowed to be.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum the value is allowed to be.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"wrapAngle","static":false,"returns":{"types":["number"],"help":"The new angle value, returns the same as the input angle if it was within bounds."},"help":"Keeps an angle value between -180 and +180.","line":843,"public":true,"protected":false,"private":false,"parameters":[{"name":"angle","type":["number"],"help":"The angle value to check","optional":false,"default":null},{"name":"radians","type":["boolean"],"help":"Set to `true` if the angle is given in radians, otherwise degrees is expected.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"wrapValue","static":false,"returns":{"types":["number"],"help":"The wrapped value."},"help":"Adds value to amount and ensures that the result always stays between 0 and max, by wrapping the value around.\\nValues must be positive integers, and are passed through Math.abs.","line":644,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["number"],"help":"The value to add the amount to.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to add to the value.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum the value is allowed to be.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Mouse.json b/docgen/output/Phaser.Mouse.json deleted file mode 100644 index c50cafc24..000000000 --- a/docgen/output/Phaser.Mouse.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Mouse","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Mouse is responsible for handling all aspects of mouse interaction with the browser.\\nIt captures and processes mouse events that happen on the game canvas object. It also adds a single `mouseup` listener to `window` which\\nis used to capture the mouse being released when not over the game."},"consts":[{"name":"LEFT_BUTTON","type":"number","help":"","line":152},{"name":"MIDDLE_BUTTON","type":"number","help":"","line":158},{"name":"NO_BUTTON","type":"number","help":"","line":146},{"name":"RIGHT_BUTTON","type":"number","help":"","line":164},{"name":"WHEEL_DOWN","type":"number","help":"","line":176},{"name":"WHEEL_UP","type":"number","help":"","line":170}],"methods":{"public":[{"name":"onMouseDown","static":false,"returns":null,"help":"The internal method that handles the mouse down event from the browser.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseMove","static":false,"returns":null,"help":"The internal method that handles the mouse move event from the browser.","line":280,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOut","static":false,"returns":null,"help":"The internal method that handles the mouse out event from the browser.","line":367,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOver","static":false,"returns":null,"help":"The internal method that handles the mouse over event from the browser.","line":428,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUp","static":false,"returns":null,"help":"The internal method that handles the mouse up event from the browser.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUpGlobal","static":false,"returns":null,"help":"The internal method that handles the mouse up event from the window.","line":343,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseWheel","static":false,"returns":null,"help":"The internal method that handles the mouse wheel event from the browser.","line":403,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerLockChange","static":false,"returns":null,"help":"Internal pointerLockChange handler.","line":486,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"releasePointerLock","static":false,"returns":null,"help":"Internal release pointer lock handler.","line":509,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"requestPointerLock","static":false,"returns":null,"help":"If the browser supports it you can request that the pointer be locked to the browser window.\\nThis is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key.\\nIf the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.","line":457,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the event listeners running.","line":184,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop the event listeners.","line":525,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"button-","type":["number"],"help":"","inlineHelp":" The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.","line":67,"default":"-1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which callbacks are called.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"capture","type":["boolean"],"help":"","inlineHelp":"If true the DOM mouse events will have event.preventDefault applied to them, if false they will propogate fully.","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"","inlineHelp":"You can disable all Input by setting disabled = true. While set all new input related events will be ignored.","line":78,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["MouseEvent"],"help":"","inlineHelp":"The browser mouse DOM event. Will be set to null if no mouse event has ever been received.","line":102,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"locked","type":["boolean"],"help":"","inlineHelp":"If the mouse has been Pointer Locked successfully this will be set to true.","line":84,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseDownCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is pressed down.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseMoveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is moved while pressed down.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOutCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is no longer over the game canvas.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOverCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse enters the game canvas (usually after a mouseout).","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseUpCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is released from a pressed down state.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseWheelCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mousewheel is used.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointerLock","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the browser enters or leaves pointer lock state.","line":96,"default":"new Phaser.Signal()","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stopOnGameOut","type":["boolean"],"help":"","inlineHelp":"If true Pointer.stop will be called if the mouse leaves the game canvas.","line":90,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"wheelDelta","type":["number"],"help":"","inlineHelp":"The direction of the mousewheel usage 1 for up -1 for down","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onMouseDown","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":108,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseMove","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":114,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseOut","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":126,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseOver","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":132,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseUp","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":120,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseWheel","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":138,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Net.json b/docgen/output/Phaser.Net.json deleted file mode 100644 index 44f109474..000000000 --- a/docgen/output/Phaser.Net.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Net","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Net handles browser URL related tasks such as checking host names, domain names and query string manipulation."},"consts":[],"methods":{"public":[{"name":"checkDomainName","static":false,"returns":{"types":["boolean"],"help":"true if the given domain fragment can be found in the window.location.hostname"},"help":"Compares the given domain name against the hostname of the browser containing the game.\\nIf the domain name is found it returns true.\\nYou can specify a part of a domain, for example 'google' would match 'google.com', 'google.co.uk', etc.\\nDo not include 'http:\/\/' at the start.","line":48,"public":true,"protected":false,"private":false,"parameters":[{"name":"domain","type":["string"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"decodeURI","static":false,"returns":{"types":["string"],"help":"The decoded value."},"help":"Returns the Query String as an object.\\nIf you specify a parameter it will return just the value of that parameter, should it exist.","line":160,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["string"],"help":"The URI component to be decoded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getHostName","static":false,"returns":{"types":["string"],"help":""},"help":"Returns the hostname given by the browser.","line":28,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getQueryString","static":false,"returns":{"types":["string","object"],"help":"An object containing the key value pairs found in the query string or just the value if a parameter was given."},"help":"Returns the Query String as an object.\\nIf you specify a parameter it will return just the value of that parameter, should it exist.","line":124,"public":true,"protected":false,"private":false,"parameters":[{"name":"parameter","type":["string"],"help":"If specified this will return just the value for that key.","optional":true,"default":"''"}],"inherited":false,"inheritedFrom":""},{"name":"updateQueryString","static":false,"returns":{"types":["string"],"help":"If redirect is false then the modified url and query string is returned."},"help":"Updates a value on the Query String and returns it in full.\\nIf the value doesn't already exist it is set.\\nIf the value exists it is replaced with the new value given. If you don't provide a new value it is removed from the query string.\\nOptionally you can redirect to the new url, or just return it as a string.","line":65,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The querystring key to update.","optional":false,"default":null},{"name":"value","type":["string"],"help":"The new value to be set. If it already exists it will be replaced.","optional":false,"default":null},{"name":"redirect","type":["boolean"],"help":"If true the browser will issue a redirect to the url with the new querystring.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The URL to modify. If none is given it uses window.location.href.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Particle.json b/docgen/output/Phaser.Particle.json deleted file mode 100644 index 28da11a62..000000000 --- a/docgen/output/Phaser.Particle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Particle","extends":"Phaser.Sprite","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Particle at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Particle at.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Particle during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Particle is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"help":"Create a new `Particle` object. Particles are extended Sprites that are emitted by a particle emitter such as Phaser.Particles.Arcade.Emitter."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"bringToTop","static":false,"returns":{"types":[],"help":[]},"help":"Brings the Sprite to the top of the display list it is a child of. Sprites that are members of a Phaser.Group are only\\nbought to the top of that Group, not the entire display list.","line":797,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"crop","static":false,"returns":null,"help":"Crop allows you to crop the texture used to display this Sprite.\\nThis modifies the core Sprite texture frame, so the Sprite width\/height properties will adjust accordingly.\\n\\nCropping takes place from the top-left of the Sprite and can be modified in real-time by either providing an updated rectangle object to Sprite.crop,\\nor by modifying Sprite.cropRect (or a reference to it) and then calling Sprite.updateCrop.\\n\\nThe rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.\\nA reference to the rectangle is stored in Sprite.cropRect unless the `copy` parameter is `true` in which case the values are duplicated to a local object.","line":512,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.","optional":false,"default":null},{"name":"copy","type":["boolean"],"help":"If false Sprite.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Sprite.cropRect object.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"damage","static":false,"returns":{"types":[],"help":[]},"help":"Damages the Sprite, this removes the given amount from the Sprites health property.\\nIf health is then taken below or is equal to zero `Sprite.kill` is called.","line":735,"public":true,"protected":false,"private":false,"parameters":[{"name":"amount","type":["number"],"help":"The amount to subtract from the Sprite.health value.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the Sprite. This removes it from its parent group, destroys the input, event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":642,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"kill","static":false,"returns":{"types":[],"help":[]},"help":"Kills a Sprite. A killed Sprite has its alive, exists and visible properties all set to false.\\nIt will dispatch the onKilled event, you can listen to Sprite.events.onKilled for the signal.\\nNote that killing a Sprite is a way for you to quickly recycle it in a Sprite pool, it doesn't free it up from memory.\\nIf you don't need this Sprite any more you should call Sprite.destroy instead.","line":619,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the Sprite is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":359,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":true,"default":null},{"name":"stopAnimation","type":["boolean"],"help":"If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"onEmit","static":false,"returns":null,"help":"Called by the Emitter when this particle is emitted. Left empty for you to over-ride as required.","line":108,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"overlap","static":false,"returns":{"types":["boolean"],"help":"True if the bounds of this Sprite intersects at any point with the bounds of the given display object."},"help":"Checks to see if the bounds of this Sprite overlaps with the bounds of the given Display Object, which can be a Sprite, Image, TileSprite or anything that extends those such as a Button.\\nThis check ignores the Sprites hitArea property and runs a Sprite.getBounds comparison on both objects to determine the result.\\nTherefore it's relatively expensive to use in large quantities (i.e. with lots of Sprites at a high frequency), but should be fine for low-volume testing where physics isn't required.","line":839,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.TileSprite","Phaser.Button","PIXI.DisplayObject"],"help":"The display object to check against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"A reference to playing Animation instance."},"help":"Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()\\nIf the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.","line":820,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be played, e.g. \"fire\", \"walk\", \"jump\".","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":322,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"preUpdate","static":false,"returns":{"types":["boolean"],"help":"True if the Sprite was rendered, otherwise false."},"help":"Automatically called by World.preUpdate.","line":204,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":[],"help":[]},"help":"Resets the Particle. This places the Particle at the given x\/y world coordinates and then\\nsets alive, exists, visible and renderable all to true. Also resets the outOfBounds state and health values.\\nIf the Particle has a physics body that too is reset.","line":153,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Particle at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Particle at.","optional":false,"default":null},{"name":"health","type":["number"],"help":"The health to give the Particle.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"resetFrame","static":false,"returns":null,"help":"Resets the Texture frame dimensions that the Sprite uses for rendering.","line":488,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"revive","static":false,"returns":{"types":[],"help":[]},"help":"Brings a 'dead' Sprite back to life, optionally giving it the health value specified.\\nA resurrected Sprite has its alive, exists and visible properties all set to true.\\nIt will dispatch the onRevived event, you can listen to Sprite.events.onRevived for the signal.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"health","type":["number"],"help":"The health to give the Sprite.","optional":true,"default":"1"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setAlphaData","static":false,"returns":null,"help":"Called by the Emitter if autoAlpha has been enabled. Passes over the alpha ease data and resets the alpha counter.","line":117,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the Sprite uses for rendering.\\nThis is primarily an internal method used by Sprite.loadTexture, although you may call it directly.","line":435,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the Sprite texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"setScaleData","static":false,"returns":null,"help":"Called by the Emitter if autoScale has been enabled. Passes over the scale ease data and resets the scale counter.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Updates the Particle scale or alpha if autoScale and autoAlpha are set.","line":70,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCrop","static":false,"returns":null,"help":"If you have set a crop rectangle on this Sprite via Sprite.crop and since modified the Sprite.cropRect property (or the rectangle it references)\\nthen you need to update the crop frame by calling this method.","line":550,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"A useful boolean to control if the Sprite is alive or dead (in terms of your gameplay, it doesn't effect rendering). Also linked to Sprite.health and Sprite.damage.","line":108,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Sprite in degrees.","line":853,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Sprite be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Sprite should be automatically camera culled or not.","line":84,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"body","type":["Phaser.Physics.Arcade.Body","Phaser.Physics.P2.Body","Phaser.Physics.Ninja.Body","null"],"help":"By default Sprites won't add themselves to any physics system and their physics body will be `null`.\\nTo enable them for physics you need to call `game.physics.enable(sprite, system)` where `sprite` is this object\\nand `system` is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via `Sprite.body`.\\n\\nImportant: Enabling a Sprite for P2 or Ninja physics will automatically set `Sprite.anchor` to 0.5 so the physics body is centered on the Sprite.\\nIf you need a different result then adjust or re-create the Body shape offsets manually, and\/or reset the anchor after enabling physics.","inlineHelp":"","line":102,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":147,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkWorldBounds","type":["boolean"],"help":"If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds\\nand optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its\\nbounds every frame to support it, and not all games need it. Enable it by setting the value to true.","inlineHelp":"","line":130,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"cropRect","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.","line":153,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"Handy flag to use with Game.enableStep","line":142,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaX","type":["number"],"help":"Returns the delta x value. The difference between world.x now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was to the right, negative if to the left.","line":876,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaY","type":["number"],"help":"Returns the delta y value. The difference between world.y now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was downwards, negative if upwards.","line":893,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaZ","type":["number"],"help":"Returns the delta z value. The difference between rotation now and in the previous step.","inlineHelp":"The delta value.","line":910,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":1212,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"Sprite.exists controls if the core game loop and physics update this Sprite or not.\\nWhen you set Sprite.exists to false it will remove its Body from the physics world (if it has one) and also set Sprite.visible to false.\\nSetting Sprite.exists to true will re-add the Body to the physics world (if it has a body) and set Sprite.visible to true.","inlineHelp":"If the Sprite is processed by the core game update and physics.","line":1050,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Sprite that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Sprite.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Sprite was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Sprite to the Camera at its current world coordinates.","line":1097,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":958,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame name and updates the Texture Cache for display.","line":974,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"health","type":["number"],"help":"","inlineHelp":"Health value. Used in combination with damage() to allow for quick killing of Sprites.","line":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inCamera","type":["boolean"],"help":"Checks if the Sprite bounds are within the game camera, otherwise false if fully outside of it.","inlineHelp":"True if the Sprite bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.","line":944,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"inWorld","type":["boolean"],"help":"Checks if the Sprite bounds are within the game world, otherwise false if fully outside of it.","inlineHelp":"True if the Sprite bounds is within the game world, even if only partially. Otherwise false if fully outside of it.","line":927,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Sprite won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":1008,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lifespan","type":["number"],"help":"If you would like the Sprite to have a lifespan once 'born' you can set this to a positive value. Handy for particles, bullets, etc.\\nThe lifespan is decremented by game.time.elapsed each update, once it reaches zero the kill() function is called.","inlineHelp":"The lifespan of the Sprite (in ms) before it will be killed.","line":121,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Sprite.","line":39,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"outOfBoundsKill","type":["boolean"],"help":"","inlineHelp":"If true Sprite.kill is called as soon as Sprite.inWorld returns false, as long as Sprite.checkWorldBounds is true.","line":136,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderOrderID","type":["number"],"help":"","inlineHelp":"The render order ID, reset every frame.","line":991,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"Enable or disable texture smoothing for this Sprite. Only works for bitmap\/image textures. Smoothing is enabled by default.","inlineHelp":"Set to true to smooth the texture of this Sprite, or false to disable smoothing (great for pixel art)","line":1126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the Sprite on the x axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Sprite on the x axis relative to the local coordinates of the parent.","line":1160,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the Sprite on the y axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Sprite on the y axis relative to the local coordinates of the parent.","line":1187,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"alphaData","type":["array"],"help":"","inlineHelp":"A reference to the alphaData array owned by the Emitter that emitted this Particle.","line":51,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"autoAlpha","type":["boolean"],"help":"","inlineHelp":"If this Particle automatically changes alpha this is set to true by Particle.setAlphaData.","line":45,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"autoScale","type":["boolean"],"help":"","inlineHelp":"If this Particle automatically scales this is set to true by Particle.setScaleData.","line":27,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"scaleData","type":["array"],"help":"","inlineHelp":"A reference to the scaleData array owned by the Emitter that emitted this Particle.","line":33,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_a","type":["number"],"help":"","inlineHelp":"Internal cache var for tracking auto alpha.","line":57,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_s","type":["number"],"help":"","inlineHelp":"Internal cache var for tracking auto scale.","line":39,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Particles.Arcade.Emitter.json b/docgen/output/Phaser.Particles.Arcade.Emitter.json deleted file mode 100644 index 0d01f55dd..000000000 --- a/docgen/output/Phaser.Particles.Arcade.Emitter.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Particles.Arcade.Emitter","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"maxParticles","type":["number"],"help":"The total number of particles in this emitter.","optional":true,"default":"50"}],"help":"Emitter is a lightweight particle emitter that uses Arcade Physics.\\nIt can be used for one-time explosions or for continuous effects like rain and fire.\\nAll it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"at","static":false,"returns":null,"help":"Change the emitters center to match the center of any object with a `center` property, such as a Sprite.\\nIf the object doesn't have a center property it will be set to object.x + object.width \/ 2","line":705,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","Phaser.Sprite","Phaser.Image","Phaser.TileSprite","Phaser.Text","PIXI.DisplayObject"],"help":"The object that you wish to match the center with.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"emitParticle","static":false,"returns":null,"help":"This function can be used both internally and externally to emit the next particle in the queue.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"explode","static":false,"returns":null,"help":"Call this function to emit the given quantity of particles at all once (an explosion)","line":400,"public":true,"protected":false,"private":false,"parameters":[{"name":"lifespan","type":["number"],"help":"How long each particle lives once emitted in ms. 0 = forever.","optional":true,"default":"0"},{"name":"quantity","type":["number"],"help":"How many particles to launch.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"flow","static":false,"returns":null,"help":"Call this function to start emitting a flow of particles at the given frequency.","line":414,"public":true,"protected":false,"private":false,"parameters":[{"name":"lifespan","type":["number"],"help":"How long each particle lives once emitted in ms. 0 = forever.","optional":true,"default":"0"},{"name":"frequency","type":["number"],"help":"Frequency is how often to emit a particle, given in ms.","optional":true,"default":"250"},{"name":"quantity","type":["number"],"help":"How many particles to launch.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"kill","static":false,"returns":null,"help":"Call this function to turn off all the particles and the emitter.","line":373,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"makeParticles","static":false,"returns":{"types":["Phaser.Particles.Arcade.Emitter"],"help":"This Emitter instance."},"help":"This function generates a new set of particles for use by this emitter.\\nThe particles are stored internally waiting to be emitted via Emitter.start.","line":314,"public":true,"protected":false,"private":false,"parameters":[{"name":"keys","type":["array","string"],"help":"A string or an array of strings that the particle sprites will use as their texture. If an array one is picked at random.","optional":false,"default":null},{"name":"frames","type":["array","number"],"help":"A frame number, or array of frames that the sprite will use. If an array one is picked at random.","optional":true,"default":"0"},{"name":"quantity","type":["number"],"help":"The number of particles to generate. If not given it will use the value of Emitter.maxParticles.","optional":true,"default":null},{"name":"collide","type":["boolean"],"help":"If you want the particles to be able to collide with other Arcade Physics bodies then set this to true.","optional":true,"default":"false"},{"name":"collideWorldBounds","type":["boolean"],"help":"A particle can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"revive","static":false,"returns":null,"help":"Handy for bringing game objects \"back to life\". Just sets alive and exists back to true.","line":386,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAlpha","static":false,"returns":null,"help":"A more compact way of setting the alpha constraints of the particles.\\nThe rate parameter, if set to a value above zero, lets you set the speed at which the Particle change in alpha from min to max.\\nIf rate is zero, which is the default, the particle won't change alpha - instead it will pick a random alpha between min and max on emit.","line":623,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value for this range.","optional":true,"default":"1"},{"name":"max","type":["number"],"help":"The maximum value for this range.","optional":true,"default":"1"},{"name":"rate","type":["number"],"help":"The rate (in ms) at which the particles will change in alpha from min to max, or set to zero to pick a random alpha between the two.","optional":true,"default":"0"},{"name":"ease","type":["number"],"help":"If you've set a rate > 0 this is the easing formula applied between the min and max values.","optional":true,"default":"Phaser.Easing.Linear.None"},{"name":"yoyo","type":["boolean"],"help":"If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setRotation","static":false,"returns":null,"help":"A more compact way of setting the angular velocity constraints of the particles.","line":601,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value for this range.","optional":true,"default":"0"},{"name":"max","type":["number"],"help":"The maximum value for this range.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setScale","static":false,"returns":null,"help":"A more compact way of setting the scale constraints of the particles.\\nThe rate parameter, if set to a value above zero, lets you set the speed and ease which the Particle uses to change in scale from min to max across both axis.\\nIf rate is zero, which is the default, the particle won't change scale during update, instead it will pick a random scale between min and max on emit.","line":664,"public":true,"protected":false,"private":false,"parameters":[{"name":"minX","type":["number"],"help":"The minimum value of Particle.scale.x.","optional":true,"default":"1"},{"name":"maxX","type":["number"],"help":"The maximum value of Particle.scale.x.","optional":true,"default":"1"},{"name":"minY","type":["number"],"help":"The minimum value of Particle.scale.y.","optional":true,"default":"1"},{"name":"maxY","type":["number"],"help":"The maximum value of Particle.scale.y.","optional":true,"default":"1"},{"name":"rate","type":["number"],"help":"The rate (in ms) at which the particles will change in scale from min to max, or set to zero to pick a random size between the two.","optional":true,"default":"0"},{"name":"ease","type":["number"],"help":"If you've set a rate > 0 this is the easing formula applied between the min and max values.","optional":true,"default":"Phaser.Easing.Linear.None"},{"name":"yoyo","type":["boolean"],"help":"If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values)","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"A more compact way of setting the width and height of the emitter.","line":555,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The desired width of the emitter (particles are spawned randomly within these dimensions).","optional":false,"default":null},{"name":"height","type":["number"],"help":"The desired height of the emitter.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setXSpeed","static":false,"returns":null,"help":"A more compact way of setting the X velocity range of the emitter.","line":568,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value for this range.","optional":true,"default":"0"},{"name":"max","type":["number"],"help":"The maximum value for this range.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setYSpeed","static":false,"returns":null,"help":"A more compact way of setting the Y velocity range of the emitter.","line":584,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value for this range.","optional":true,"default":"0"},{"name":"max","type":["number"],"help":"The maximum value for this range.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"start","static":false,"returns":null,"help":"Call this function to start emitting particles.","line":430,"public":true,"protected":false,"private":false,"parameters":[{"name":"explode","type":["boolean"],"help":"Whether the particles should all burst out at once (true) or at the frequency given (false).","optional":true,"default":"true"},{"name":"lifespan","type":["number"],"help":"How long each particle lives once emitted in ms. 0 = forever.","optional":true,"default":"0"},{"name":"frequency","type":["number"],"help":"Ignored if Explode is set to true. Frequency is how often to emit 1 particle. Value given in ms.","optional":true,"default":"250"},{"name":"quantity","type":["number"],"help":"How many particles to launch. 0 = \"all of the particles\".","optional":true,"default":"0"},{"name":"forceQuantity","type":["number"],"help":"If true and creating a particle flow, the quantity emitted will be forced to the be quantity given in this call.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Called automatically by the game loop, decides when to launch particles and when to \"die\".","line":252,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"alphaData","type":["array"],"help":"","inlineHelp":"An array of the calculated alpha easing data applied to particles with alphaRates > 0.","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularDrag","type":["number"],"help":"","inlineHelp":"The angular drag component of particles launched from the emitter if they are rotating.","line":126,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"area","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The area of the emitter. Particles can be randomly generated from anywhere within this rectangle.","line":45,"default":"new Phaser.Rectangle(x, y, 1, 1)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoAlpha","type":["boolean"],"help":"","inlineHelp":"When a new Particle is emitted this controls if it will automatically change alpha. Use Emitter.setAlpha to configure.","line":187,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoScale","type":["boolean"],"help":"","inlineHelp":"When a new Particle is emitted this controls if it will automatically scale in size. Use Emitter.setScale to configure.","line":182,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"","inlineHelp":"The blendMode as set on the particle when emitted from the Emitter. Defaults to NORMAL. Needs browser capable of supporting canvas blend-modes (most not available in WebGL)","line":161,"default":"Phaser.blendModes.NORMAL","public":true,"protected":false,"private":false,"readOnly":false},{"name":"bottom","type":["number"],"help":"","inlineHelp":"Gets the bottom position of the Emitter.","line":828,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bounce","type":["Phaser.Point"],"help":"","inlineHelp":"How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.","line":143,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"emitX","type":["number"],"help":"The point the particles are emitted from.\\nEmitter.x and Emitter.y control the containers location, which updates all current particles\\nEmitter.emitX and Emitter.emitY control the emission location relative to the x\/y position.","inlineHelp":"","line":169,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"emitY","type":["number"],"help":"The point the particles are emitted from.\\nEmitter.x and Emitter.y control the containers location, which updates all current particles\\nEmitter.emitX and Emitter.emitY control the emission location relative to the x\/y position.","inlineHelp":"","line":177,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frequency","type":["boolean"],"help":"","inlineHelp":"How often a particle is emitted in ms (if emitter is started with Explode === false).","line":132,"default":"100","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["number"],"help":"","inlineHelp":"Sets the `body.gravity.y` of each particle sprite to this value on launch.","line":109,"default":"100","public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Gets or sets the height of the Emitter. This is the region in which a particle can be emitted.","line":740,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"left","type":["number"],"help":"","inlineHelp":"Gets the left position of the Emitter.","line":789,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"lifespan","type":["number"],"help":"","inlineHelp":"How long each particle lives once it is emitted in ms. Default is 2 seconds. Set lifespan to 'zero' for particles to live forever.","line":138,"default":"2000","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxParticleAlpha","type":["number"],"help":"","inlineHelp":"The maximum possible alpha value of a particle.","line":98,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxParticleScale","type":["number"],"help":"","inlineHelp":"The maximum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see maxParticleScaleX.","line":69,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxParticleSpeed","type":["Phaser.Point"],"help":"","inlineHelp":"The maximum possible velocity of a particle.","line":57,"default":"new Phaser.Point(100, 100)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxParticles","type":["number"],"help":"","inlineHelp":"The total number of particles in this emitter.","line":26,"default":"maxParticles || 50","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxRotation","type":["number"],"help":"","inlineHelp":"The maximum possible angular velocity of a particle.","line":86,"default":"360","public":true,"protected":false,"private":false,"readOnly":false},{"name":"minParticleAlpha","type":["number"],"help":"","inlineHelp":"The minimum possible alpha value of a particle.","line":92,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"minParticleScale","type":["number"],"help":"","inlineHelp":"The minimum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see minParticleScaleX.","line":63,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"minParticleSpeed","type":["Phaser.Point"],"help":"","inlineHelp":"The minimum possible velocity of a particle.","line":51,"default":"new Phaser.Point(-100, -100)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"minRotation","type":["number"],"help":"","inlineHelp":"The minimum possible angular velocity of a particle.","line":80,"default":"-360","public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A handy string name for this emitter. Can be set to anything.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"on","type":["boolean"],"help":"","inlineHelp":"Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.","line":149,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"particleAnchor","type":["Phaser.Point"],"help":"","inlineHelp":"When a particle is created its anchor will be set to match this Point object (defaults to x\/y: 0.5 to aid in rotation)","line":155,"default":"new Phaser.Point(0.5, 0.5)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"particleBringToTop","type":["boolean"],"help":"","inlineHelp":"If this is `true` then when the Particle is emitted it will be bought to the top of the Emitters display list.","line":193,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"particleClass","type":["any"],"help":"","inlineHelp":"For emitting your own particle class types. They must extend Phaser.Particle.","line":115,"default":"Phaser.Particle","public":true,"protected":false,"private":false,"readOnly":false},{"name":"particleDrag","type":["Phaser.Point"],"help":"","inlineHelp":"The X and Y drag component of particles launched from the emitter.","line":120,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"particleSendToBack","type":["boolean"],"help":"","inlineHelp":"If this is `true` then when the Particle is emitted it will be sent to the back of the Emitters display list.","line":199,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"Gets the right position of the Emitter.","line":802,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the Group container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleData","type":["array"],"help":"","inlineHelp":"An array of the calculated scale easing data applied to particles with scaleRates > 0.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"top","type":["number"],"help":"","inlineHelp":"Gets the top position of the Emitter.","line":815,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"Gets or sets the width of the Emitter. This is the region in which a particle can be emitted.","line":724,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"Gets or sets the x position of the Emitter.","line":756,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"Gets or sets the y position of the Emitter.","line":772,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"type","type":["number"],"help":"","inlineHelp":"Internal Phaser Type value.","line":39,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_counter","type":["number"],"help":"","inlineHelp":"Internal counter for figuring out how many particles to launch.","line":229,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_explode","type":["boolean"],"help":"","inlineHelp":"Internal helper for the style of particle emission (all at once, or one at a time).","line":235,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frames","type":["any"],"help":"","inlineHelp":"Internal helper for the particle frame.","line":241,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_maxParticleScale","type":["Phaser.Point"],"help":"","inlineHelp":"Internal particle scale var.","line":211,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_minParticleScale","type":["Phaser.Point"],"help":"","inlineHelp":"Internal particle scale var.","line":205,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_quantity","type":["number"],"help":"","inlineHelp":"Internal helper for deciding how many particles to launch.","line":217,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_timer","type":["number"],"help":"","inlineHelp":"Internal helper for deciding when to launch particles or kill them.","line":223,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Particles.Arcade.json b/docgen/output/Phaser.Particles.Arcade.json deleted file mode 100644 index 9cecf332c..000000000 --- a/docgen/output/Phaser.Particles.Arcade.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Particles.Arcade","extends":"","static":true,"constructor":false,"parameters":[],"help":"Arcade Particles is a Particle System integrated with Arcade Physics."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Particles.json b/docgen/output/Phaser.Particles.json deleted file mode 100644 index 08231cf1b..000000000 --- a/docgen/output/Phaser.Particles.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Particles","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Particles is the Particle Manager for the game. It is called during the game update loop and in turn updates any Emitters attached to it."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Emitter"],"help":"The emitter that was added."},"help":"Adds a new Particle Emitter to the Particle Manager.","line":42,"public":true,"protected":false,"private":false,"parameters":[{"name":"emitter","type":["Phaser.Emitter"],"help":"The emitter to be added to the particle manager.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Removes an existing Particle Emitter from the Particle Manager.","line":55,"public":true,"protected":false,"private":false,"parameters":[{"name":"emitter","type":["Phaser.Emitter"],"help":"The emitter to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"update","static":false,"returns":null,"help":"Called by the core game loop. Updates all Emitters who have their exists value set to true.","line":66,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"ID","type":["number"],"help":"","inlineHelp":"","line":30,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"emitters","type":["object"],"help":"","inlineHelp":"Internal emitters store.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Arcade.Body.json b/docgen/output/Phaser.Physics.Arcade.Body.json deleted file mode 100644 index b9218d492..000000000 --- a/docgen/output/Phaser.Physics.Arcade.Body.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Arcade.Body","extends":"","static":false,"constructor":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite object this physics body belongs to.","optional":false,"default":null}],"help":"The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than\\nthe Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body."},"consts":[],"methods":{"public":[{"name":"deltaAbsX","static":false,"returns":{"types":["number"],"help":"The absolute delta value."},"help":"Returns the absolute delta x value.","line":675,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaAbsY","static":false,"returns":{"types":["number"],"help":"The absolute delta value."},"help":"Returns the absolute delta y value.","line":685,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaX","static":false,"returns":{"types":["number"],"help":"The delta value. Positive if the motion was to the right, negative if to the left."},"help":"Returns the delta x value. The difference between Body.x now and in the previous step.","line":695,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaY","static":false,"returns":{"types":["number"],"help":"The delta value. Positive if the motion was downwards, negative if upwards."},"help":"Returns the delta y value. The difference between Body.y now and in the previous step.","line":705,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaZ","static":false,"returns":{"types":["number"],"help":"The delta value. Positive if the motion was clockwise, negative if anti-clockwise."},"help":"Returns the delta z value. The difference between Body.rotation now and in the previous step.","line":715,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Removes this bodies reference to its parent sprite, freeing it up for gc.","line":533,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"hitTest","static":false,"returns":{"types":["boolean"],"help":"True if the given coordinates are inside this Body, otherwise false."},"help":"Tests if a world point lies within this Body.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The world x coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The world y coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onFloor","static":false,"returns":{"types":["boolean"],"help":"True if in contact with either the world bounds or a tile."},"help":"Returns true if the bottom of this Body is in contact with either the world bounds or a tile.","line":655,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onWall","static":false,"returns":{"types":["boolean"],"help":"True if in contact with either the world bounds or a tile."},"help":"Returns true if either side of this Body is in contact with either the world bounds or a tile.","line":665,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render Sprite Body.","line":791,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context to render to.","optional":false,"default":null},{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body to render the info of.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgba(0,255,0,0.4)'"},{"name":"filled","type":["boolean"],"help":"Render the objected as a filled (default, true) or a stroked (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"renderBodyInfo","static":false,"returns":null,"help":"Render Sprite Body Physics Data as text.","line":819,"public":true,"protected":false,"private":false,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body to render the info of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets all Body values (velocity, acceleration, rotation, etc)","line":611,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The new x position of the Body.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the Body.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"You can modify the size of the physics Body to be any dimension you need.\\nSo it could be smaller or larger than the parent Sprite. You can also control the x and y offset, which\\nis the position of the Body relative to the top-left of the Sprite.","line":587,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the Body.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the Body.","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"The X offset of the Body from the Sprite position.","optional":true,"default":null},{"name":"offsetY","type":["number"],"help":"The Y offset of the Body from the Sprite position.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"checkWorldBounds","static":false,"returns":null,"help":"Internal method.","line":546,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"Internal method.","line":450,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Internal method.","line":370,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateBounds","static":false,"returns":null,"help":"Internal method.","line":344,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"acceleration","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity in pixels per second sq. of the Body.","line":128,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"allowGravity","type":["boolean"],"help":"","inlineHelp":"Allow this Body to be influenced by gravity? Either world or local.","line":139,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"allowRotation","type":["boolean"],"help":"","inlineHelp":"Allow this Body to be rotated? (via angularVelocity, etc)","line":59,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"","inlineHelp":"The angle of the Body in radians as calculated by its velocity, rather than its visual angle.","line":191,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"angularAcceleration","type":["number"],"help":"","inlineHelp":"The angular acceleration in pixels per second sq. of the Body.","line":167,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularDrag","type":["number"],"help":"","inlineHelp":"The angular drag applied to the rotation of the Body.","line":173,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularVelocity","type":["number"],"help":"","inlineHelp":"The angular velocity in pixels per second sq. of the Body.","line":161,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blocked","type":["object"],"help":"This object is populated with boolean values when the Body collides with the World bounds or a Tile.\\nFor example if blocked.up is true then the Body cannot move up.","inlineHelp":"An object containing on which faces this Body is blocked from moving, if any.","line":285,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bottom","type":["number"],"help":"","inlineHelp":"The bottom value of this Body (same as Body.y + Body.height)","line":726,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bounce","type":["Phaser.Point"],"help":"","inlineHelp":"The elasticitiy of the Body when colliding. bounce.x\/y = 1 means full rebound, bounce.x\/y = 0.5 means 50% rebound velocity.","line":149,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cache","type":[],"help":"","inlineHelp":"","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"center","type":["Phaser.Point"],"help":"","inlineHelp":"The center coordinate of the Physics Body.","line":107,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkCollision","type":["object"],"help":"Set the checkCollision properties to control which directions collision is processed for this Body.\\nFor example checkCollision.up = false means it won't collide when the collision happened while moving up.","inlineHelp":"An object containing allowed collision.","line":265,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideWorldBounds","type":["boolean"],"help":"A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.","inlineHelp":"Should the Body collide with the World bounds?","line":258,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"customSeparateX","type":["boolean"],"help":"This flag allows you to disable the custom x separation that takes place by Physics.Arcade.separate.\\nUsed in combination with your own collision processHandler you can create whatever type of collision response you need.","inlineHelp":"Use a custom separation system or the built-in one?","line":226,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"customSeparateY","type":["boolean"],"help":"This flag allows you to disable the custom y separation that takes place by Physics.Arcade.separate.\\nUsed in combination with your own collision processHandler you can create whatever type of collision response you need.","inlineHelp":"Use a custom separation system or the built-in one?","line":234,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaMax","type":["Phaser.Point"],"help":"","inlineHelp":"The Sprite position is updated based on the delta x\/y values. You can set a cap on those (both +-) using deltaMax.","line":123,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"drag","type":["Phaser.Point"],"help":"","inlineHelp":"The drag applied to the motion of the Body.","line":133,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"embedded","type":["boolean"],"help":"If a body is overlapping with another body, but neither of them are moving (maybe they spawned on-top of each other?) this is set to true.","inlineHelp":"Body embed value.","line":252,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enable","type":["boolean"],"help":"","inlineHelp":"A disabled body won't be checked for any form of collision or overlap or have its pre\/post updates run.","line":36,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"facing","type":["number"],"help":"","inlineHelp":"A const reference to the direction the Body is traveling or facing.","line":203,"default":"Phaser.NONE","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["Phaser.Point"],"help":"","inlineHelp":"A local gravity applied to this Body. If non-zero this over rides any world gravity, unless Body.allowGravity is set to false.","line":144,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"halfHeight","type":["number"],"help":"","inlineHelp":"The calculated height \/ 2 of the physics body.","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"halfWidth","type":["number"],"help":"","inlineHelp":"The calculated width \/ 2 of the physics body.","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"immovable","type":["boolean"],"help":"","inlineHelp":"An immovable Body will not receive any impacts from other bodies.","line":209,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mass","type":["number"],"help":"","inlineHelp":"The mass of the Body.","line":185,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxAngular","type":["number"],"help":"","inlineHelp":"The maximum angular velocity in pixels per second sq. that the Body can reach.","line":179,"default":"1000","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxVelocity","type":["Phaser.Point"],"help":"","inlineHelp":"The maximum velocity in pixels per second sq. that the Body can reach.","line":155,"default":"new Phaser.Point(10000, 10000)","public":true,"protected":false,"private":false,"readOnly":false},{"name":"moves","type":["boolean"],"help":"If you have a Body that is being moved around the world via a tween or a Group motion, but its local x\/y position never\\nactually changes, then you should set Body.moves = false. Otherwise it will most likely fly off the screen.\\nIf you want the physics system to move the body around, then set moves to true.","inlineHelp":"Set to true to allow the Physics system to move this Body, other false to move it manually.","line":218,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"newVelocity","type":["Phaser.Point"],"help":"","inlineHelp":"New velocity.","line":118,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"offset","type":["Phaser.Point"],"help":"","inlineHelp":"The offset of the Physics Body from the Sprite x\/y position.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"overlapX","type":["number"],"help":"When this body collides with another, the amount of overlap is stored here.","inlineHelp":"The amount of horizontal overlap during the collision.","line":240,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"overlapY","type":["number"],"help":"When this body collides with another, the amount of overlap is stored here.","inlineHelp":"The amount of vertical overlap during the collision.","line":246,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"phaser","type":["number"],"help":"","inlineHelp":"Is this Body in a preUpdate (1) or postUpdate (2) state?","line":297,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"The position of the physics body.","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"preRotation","type":["number"],"help":"","inlineHelp":"The previous rotation of the physics body.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"prev","type":["Phaser.Point"],"help":"","inlineHelp":"The previous position of the physics body.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"right","type":["number"],"help":"","inlineHelp":"The right value of this Body (same as Body.x + Body.width)","line":739,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"rotation","type":["number"],"help":"","inlineHelp":"The amount the Body is rotated.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"skipQuadTree","type":["boolean"],"help":"","inlineHelp":"If true and you collide this Sprite against a Group, it will disable the collision check from using a QuadTree.","line":302,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceHeight","type":["number"],"help":"","inlineHelp":"The un-scaled original size.","line":82,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"sourceWidth","type":["number"],"help":"","inlineHelp":"The un-scaled original size.","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"speed","type":["number"],"help":"","inlineHelp":"The speed of the Body as calculated by its velocity.","line":197,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"sprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"Reference to the parent Sprite.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tilePadding","type":["Phaser.Point"],"help":"If this is an especially small or fast moving object then it can sometimes skip over tilemap collisions if it moves through a tile in a step.\\nSet this padding value to add extra padding to its bounds. tilePadding.x applied to its width, y to its height.","inlineHelp":"Extra padding to be added to this sprites dimensions when checking for tile collision.","line":292,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touching","type":["object"],"help":"This object is populated with boolean values when the Body collides with another.\\ntouching.up = true means the collision happened to the top of this Body for example.","inlineHelp":"An object containing touching results.","line":272,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The type of physics system this body belongs to.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity in pixels per second sq. of the Body.","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wasTouching","type":["object"],"help":"This object is populated with previous touching values from the bodies previous collision.","inlineHelp":"An object containing previous touching results.","line":278,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The calculated width of the physics body.","line":87,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x position.","line":751,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y position.","line":768,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_dx","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":326,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_dy","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":332,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_reset","type":["boolean"],"help":"","inlineHelp":"Internal cache var.","line":308,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sx","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":314,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sy","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":320,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Arcade.json b/docgen/output/Phaser.Physics.Arcade.json deleted file mode 100644 index cb7145b40..000000000 --- a/docgen/output/Phaser.Physics.Arcade.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Arcade","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"reference to the current game instance.","optional":false,"default":null}],"help":"The Arcade Physics world. Contains Arcade Physics related collision, overlap and motion methods."},"consts":[],"methods":{"public":[{"name":"accelerateToObject","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new trajectory."},"help":"Sets the acceleration.x\/y property on the display object so it will move towards the target at the given speed (in pixels per second sq.)\\nYou must give a maximum speed value, beyond which the display object won't go any faster.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.","line":1615,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"destination","type":["any"],"help":"The display object to move towards. Can be any object but must have visible x\/y properties.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will accelerate in pixels per second.","optional":true,"default":"60"},{"name":"xSpeedMax","type":["number"],"help":"The maximum x velocity the display object can reach.","optional":true,"default":"500"},{"name":"ySpeedMax","type":["number"],"help":"The maximum y velocity the display object can reach.","optional":true,"default":"500"}],"inherited":false,"inheritedFrom":""},{"name":"accelerateToPointer","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new trajectory."},"help":"Sets the acceleration.x\/y property on the display object so it will move towards the target at the given speed (in pixels per second sq.)\\nYou must give a maximum speed value, beyond which the display object won't go any faster.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.","line":1644,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The pointer to move towards. Defaults to Phaser.Input.activePointer.","optional":true,"default":null},{"name":"speed","type":["number"],"help":"The speed it will accelerate in pixels per second.","optional":true,"default":"60"},{"name":"xSpeedMax","type":["number"],"help":"The maximum x velocity the display object can reach.","optional":true,"default":"500"},{"name":"ySpeedMax","type":["number"],"help":"The maximum y velocity the display object can reach.","optional":true,"default":"500"}],"inherited":false,"inheritedFrom":""},{"name":"accelerateToXY","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new trajectory."},"help":"Sets the acceleration.x\/y property on the display object so it will move towards the x\/y coordinates at the given speed (in pixels per second sq.)\\nYou must give a maximum speed value, beyond which the display object won't go any faster.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.","line":1675,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to accelerate towards.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to accelerate towards.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will accelerate in pixels per second.","optional":true,"default":"60"},{"name":"xSpeedMax","type":["number"],"help":"The maximum x velocity the display object can reach.","optional":true,"default":"500"},{"name":"ySpeedMax","type":["number"],"help":"The maximum y velocity the display object can reach.","optional":true,"default":"500"}],"inherited":false,"inheritedFrom":""},{"name":"accelerationFromRotation","static":false,"returns":{"types":["Phaser.Point"],"help":"- A Point where point.x contains the acceleration x value and point.y contains the acceleration y value."},"help":"Given the rotation (in radians) and speed calculate the acceleration and return it as a Point object, or set it to the given point object.\\nOne way to use this is: accelerationFromRotation(rotation, 200, sprite.acceleration) which will set the values directly to the sprites acceleration and not create a new Point object.","line":1592,"public":true,"protected":false,"private":false,"parameters":[{"name":"rotation","type":["number"],"help":"The angle in radians.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second sq.","optional":true,"default":"60"},{"name":"point","type":["Phaser.Point","object"],"help":"The Point object in which the x and y properties will be set to the calculated acceleration.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleBetween","static":false,"returns":{"types":["number"],"help":"The angle in radians between the source and target display objects."},"help":"Find the angle in radians between two display objects (like Sprites).","line":1756,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"target","type":["any"],"help":"The Display Object to test to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleToPointer","static":false,"returns":{"types":["number"],"help":"The angle in radians between displayObject.x\/y to Pointer.x\/y"},"help":"Find the angle in radians between a display object (like a Sprite) and a Pointer, taking their x\/y and center into account.","line":1791,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Phaser.Pointer to test to. If none is given then Input.activePointer is used.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleToXY","static":false,"returns":{"types":["number"],"help":"The angle in radians between displayObject.x\/y to Pointer.x\/y"},"help":"Find the angle in radians between a display object (like a Sprite) and the given x\/y coordinate.","line":1774,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to get the angle to.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to get the angle to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collide","static":false,"returns":{"types":["boolean"],"help":"True if a collision occured otherwise false."},"help":"Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.\\nBoth the first and second parameter can be arrays of objects, of differing types.\\nIf two arrays are passed, the contents of the first parameter will be tested against all contents of the 2nd parameter.\\nThe objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead.\\nAn optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place,\\ngiving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped.\\nThe collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.\\nNOTE: This function is not recursive, and will not test against children of objects passed (i.e. Groups or Tilemaps within other Groups).","line":414,"public":true,"protected":false,"private":false,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer","array"],"help":"The first object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer","array"],"help":"The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them, unless you are colliding Group vs. Sprite, in which case Sprite will always be the first parameter.","optional":true,"default":"null"},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"computeVelocity","static":false,"returns":{"types":["number"],"help":"The altered Velocity value."},"help":"A tween-like function that takes a starting velocity and some other factors and returns an altered velocity.\\nBased on a function in Flixel by @ADAMATOMIC","line":290,"public":true,"protected":false,"private":false,"parameters":[{"name":"axis","type":["number"],"help":"0 for nothing, 1 for horizontal, 2 for vertical.","optional":false,"default":null},{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to be updated.","optional":false,"default":null},{"name":"velocity","type":["number"],"help":"Any component of velocity (e.g. 20).","optional":false,"default":null},{"name":"acceleration","type":["number"],"help":"Rate at which the velocity is changing.","optional":false,"default":null},{"name":"drag","type":["number"],"help":"Really kind of a deceleration, this is how much the velocity changes if Acceleration is not set.","optional":false,"default":null},{"name":"max","type":["number"],"help":"An absolute value cap for the velocity.","optional":true,"default":"10000"}],"inherited":false,"inheritedFrom":""},{"name":"distanceBetween","static":false,"returns":{"types":["number"],"help":"The distance between the source and target objects."},"help":"Find the distance between two display objects (like Sprites).","line":1698,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"target","type":["any"],"help":"The Display Object to test to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"distanceToPointer","static":false,"returns":{"types":["number"],"help":"The distance between the object and the Pointer."},"help":"Find the distance between a display object (like a Sprite) and a Pointer. If no Pointer is given the Input.activePointer is used.\\nThe calculation is made from the display objects x\/y coordinate. This may be the top-left if its anchor hasn't been changed.\\nIf you need to calculate from the center of a display object instead use the method distanceBetweenCenters()","line":1737,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The Phaser.Pointer to test to. If none is given then Input.activePointer is used.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"distanceToXY","static":false,"returns":{"types":["number"],"help":"The distance between the object and the x\/y coordinates."},"help":"Find the distance between a display object (like a Sprite) and the given x\/y coordinates.\\nThe calculation is made from the display objects x\/y coordinate. This may be the top-left if its anchor hasn't been changed.\\nIf you need to calculate from the center of a display object instead use the method distanceBetweenCenters()","line":1718,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The Display Object to test from.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to move towards.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to move towards.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"enable","static":false,"returns":null,"help":"This will create an Arcade Physics body on the given game object or array of game objects.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"enableBody","static":false,"returns":null,"help":"Creates an Arcade Physics body on the given game object.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The game object to create the physics body on. A body will only be created if this object has a null `body` property.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getObjectsUnderPointer","static":false,"returns":{"types":["array"],"help":"An array of the Sprites from the Group that overlapped the Pointer coordinates."},"help":"Given a Group and a Pointer this will check to see which Group children overlap with the Pointer coordinates.\\nEach child will be sent to the given callback for further processing.\\nNote that the children are not checked for depth order, but simply if they overlap the Pointer or not.","line":1403,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer to check.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"The Group to check.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"A callback function that is called if the object overlaps with the Pointer. The callback will be sent two parameters: the Pointer and the Object that overlapped with it.","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callback.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":{"types":["boolean"],"help":"True if they intersect, otherwise false."},"help":"Check for intersection against two bodies.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"body1","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to check.","optional":false,"default":null},{"name":"body2","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveToObject","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new velocity."},"help":"Move the given display object towards the destination object at a steady velocity.\\nIf you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.\\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","line":1453,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"destination","type":["any"],"help":"The display object to move towards. Can be any object but must have visible x\/y properties.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second (default is 60 pixels\/sec)","optional":true,"default":"60"},{"name":"maxTime","type":["number"],"help":"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.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"moveToPointer","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new velocity."},"help":"Move the given display object towards the pointer at a steady velocity. If no pointer is given it will use Phaser.Input.activePointer.\\nIf you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.","line":1487,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second (default is 60 pixels\/sec)","optional":true,"default":"60"},{"name":"pointer","type":["Phaser.Pointer"],"help":"The pointer to move towards. Defaults to Phaser.Input.activePointer.","optional":true,"default":null},{"name":"maxTime","type":["number"],"help":"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.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"moveToXY","static":false,"returns":{"types":["number"],"help":"The angle (in radians) that the object should be visually set to in order to match its new velocity."},"help":"Move the given display object towards the x\/y coordinates at a steady velocity.\\nIf you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.\\nTimings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.\\nNote: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.\\nNote: The display object doesn't stop moving once it reaches the destination coordinates.\\nNote: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)","line":1524,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["any"],"help":"The display object to move.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to move towards.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to move towards.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second (default is 60 pixels\/sec)","optional":true,"default":"60"},{"name":"maxTime","type":["number"],"help":"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.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"overlap","static":false,"returns":{"types":["boolean"],"help":"True if an overlap occurred otherwise false."},"help":"Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.\\nYou can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.\\nUnlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.\\nBoth the first and second parameter can be arrays of objects, of differing types.\\nIf two arrays are passed, the contents of the first parameter will be tested against all contents of the 2nd parameter.\\nNOTE: This function is not recursive, and will not test against children of objects passed (i.e. Groups within Groups).","line":354,"public":true,"protected":false,"private":false,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","array"],"help":"The first object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","array"],"help":"The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.","optional":false,"default":null},{"name":"overlapCallback","type":["function"],"help":"An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.","optional":true,"default":"null"},{"name":"processCallback","type":["function"],"help":"A 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 processCallback returns true.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setBounds","static":false,"returns":null,"help":"Updates the size of this physics world.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"width","type":["number"],"help":"New width of the world. Can never be smaller than the Game.width.","optional":false,"default":null},{"name":"height","type":["number"],"help":"New height of the world. Can never be smaller than the Game.height.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setBoundsToWorld","static":false,"returns":null,"help":"Updates the size of this physics world to match the size of the game world.","line":182,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateMotion","static":false,"returns":null,"help":"Called automatically by a Physics body, it updates all motion related values on the Body.","line":266,"public":true,"protected":false,"private":false,"parameters":[{"name":"The","type":["Phaser.Physics.Arcade.Body"],"help":" Body object to be updated.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"velocityFromAngle","static":false,"returns":{"types":["Phaser.Point"],"help":"- A Point where point.x contains the velocity x value and point.y contains the velocity y value."},"help":"Given the angle (in degrees) and speed calculate the velocity and return it as a Point object, or set it to the given point object.\\nOne way to use this is: velocityFromAngle(angle, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.","line":1554,"public":true,"protected":false,"private":false,"parameters":[{"name":"angle","type":["number"],"help":"The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second sq.","optional":true,"default":"60"},{"name":"point","type":["Phaser.Point","object"],"help":"The Point object in which the x and y properties will be set to the calculated velocity.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"velocityFromRotation","static":false,"returns":{"types":["Phaser.Point"],"help":"- A Point where point.x contains the velocity x value and point.y contains the velocity y value."},"help":"Given the rotation (in radians) and speed calculate the velocity and return it as a Point object, or set it to the given point object.\\nOne way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.","line":1573,"public":true,"protected":false,"private":false,"parameters":[{"name":"rotation","type":["number"],"help":"The angle in radians.","optional":false,"default":null},{"name":"speed","type":["number"],"help":"The speed it will move, in pixels per second sq.","optional":true,"default":"60"},{"name":"point","type":["Phaser.Point","object"],"help":"The Point object in which the x and y properties will be set to the calculated velocity.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"collideGroupVsGroup","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":680,"public":false,"protected":false,"private":true,"parameters":[{"name":"group1","type":["Phaser.Group"],"help":"The first Group to check.","optional":false,"default":null},{"name":"group2","type":["Phaser.Group"],"help":"The second Group to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideGroupVsSelf","static":false,"returns":{"types":["boolean"],"help":"True if there was a collision, otherwise false."},"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":646,"public":false,"protected":false,"private":true,"parameters":[{"name":"group","type":["Phaser.Group"],"help":"The Group to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideGroupVsTilemapLayer","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":780,"public":false,"protected":false,"private":true,"parameters":[{"name":"group","type":["Phaser.Group"],"help":"The Group to check.","optional":false,"default":null},{"name":"tilemapLayer","type":["Phaser.TilemapLayer"],"help":"The layer to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideHandler","static":false,"returns":null,"help":"Internal collision handler.","line":468,"public":false,"protected":false,"private":true,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer"],"help":"The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer"],"help":"The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer. Can also be an array of objects to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideSpriteVsGroup","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":589,"public":false,"protected":false,"private":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The sprite to check.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"The Group to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideSpriteVsSprite","static":false,"returns":{"types":["boolean"],"help":"True if there was a collision, otherwise false."},"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":556,"public":false,"protected":false,"private":true,"parameters":[{"name":"sprite1","type":["Phaser.Sprite"],"help":"The first sprite to check.","optional":false,"default":null},{"name":"sprite2","type":["Phaser.Sprite"],"help":"The second sprite to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideSpriteVsTilemapLayer","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Arcade.collide instead.","line":716,"public":false,"protected":false,"private":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The sprite to check.","optional":false,"default":null},{"name":"tilemapLayer","type":["Phaser.TilemapLayer"],"help":"The layer to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processTileSeparationX","static":false,"returns":{"types":["boolean"],"help":"Returns true as a pass-thru to the separateTile method."},"help":"Internal function to process the separation of a physics body from a tile.","line":1335,"public":false,"protected":false,"private":true,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x separation amount.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processTileSeparationY","static":false,"returns":null,"help":"Internal function to process the separation of a physics body from a tile.","line":1367,"public":false,"protected":false,"private":true,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y separation amount.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"separate","static":false,"returns":{"types":["boolean"],"help":"Returns true if the bodies collided, otherwise false."},"help":"The core separation function to separate two physics bodies.","line":809,"public":false,"protected":false,"private":true,"parameters":[{"name":"body1","type":["Phaser.Physics.Arcade.Body"],"help":"The first Body object to separate.","optional":false,"default":null},{"name":"body2","type":["Phaser.Physics.Arcade.Body"],"help":"The second Body object to separate.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this function is set then the sprites will only be collided if it returns true.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which to run the process callback.","optional":true,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"separateTile","static":false,"returns":{"types":["boolean"],"help":"Returns true if the body was separated, otherwise false."},"help":"The core separation function to separate a physics body and a tile.","line":1134,"public":false,"protected":false,"private":true,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"tile","type":["Phaser.Tile"],"help":"The tile to collide against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"separateX","static":false,"returns":{"types":["boolean"],"help":"Returns true if the bodies were separated, otherwise false."},"help":"The core separation function to separate two physics bodies on the x axis.","line":890,"public":false,"protected":false,"private":true,"parameters":[{"name":"body1","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"body2","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"If true the bodies will only have their overlap data set, no separation or exchange of velocity will take place.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"separateY","static":false,"returns":{"types":["boolean"],"help":"Returns true if the bodies were separated, otherwise false."},"help":"The core separation function to separate two physics bodies on the y axis.","line":1006,"public":false,"protected":false,"private":true,"parameters":[{"name":"body1","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"body2","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"If true the bodies will only have their overlap data set, no separation or exchange of velocity will take place.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tileCheckX","static":false,"returns":{"types":["number"],"help":"The amount of separation that occured."},"help":"Check the body against the given tile on the X axis.","line":1237,"public":false,"protected":false,"private":true,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"tile","type":["Phaser.Tile"],"help":"The tile to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tileCheckY","static":false,"returns":{"types":["number"],"help":"The amount of separation that occured."},"help":"Check the body against the given tile on the Y axis.","line":1286,"public":false,"protected":false,"private":true,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"tile","type":["Phaser.Tile"],"help":"The tile to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"OVERLAP_BIAS","type":["number"],"help":"","inlineHelp":"A value added to the delta values during collision checks.","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"TILE_BIAS","type":["number"],"help":"","inlineHelp":"A value added to the delta values during collision with tiles. Adjust this if you get tunnelling.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bounds","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The bounds inside of which the physics world exists. Defaults to match the world bounds.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkCollision","type":["object"],"help":"Set the checkCollision properties to control for which bounds collision is processed.\\nFor example checkCollision.down = false means Bodies cannot collide with the World.bounds.bottom.","inlineHelp":"An object containing allowed collision flags.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"forceX","type":["boolean"],"help":"","inlineHelp":"If true World.separate will always separate on the X axis before Y. Otherwise it will check gravity totals first.","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["Phaser.Point"],"help":"","inlineHelp":"The World gravity setting. Defaults to x: 0, y: 0, or no gravity.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxLevels","type":["number"],"help":"","inlineHelp":"Used by the QuadTree to set the maximum number of iteration levels.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxObjects","type":["number"],"help":"","inlineHelp":"Used by the QuadTree to set the maximum number of objects per quad.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"quadTree","type":["Phaser.QuadTree"],"help":"","inlineHelp":"The world QuadTree.","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"skipQuadTree","type":["boolean"],"help":"","inlineHelp":"If true a QuadTree will never be used for any collision. Handy for tightly packed games. See also Body.skipQuadTree.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_angle","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":139,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_average","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":115,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_dx","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":145,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_dy","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":151,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_mapData","type":["array"],"help":"","inlineHelp":"Internal cache var.","line":121,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_maxOverlap","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":85,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_newVelocity1","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":103,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_newVelocity2","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":109,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_overlap","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":79,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_result","type":["boolean"],"help":"","inlineHelp":"Internal cache var.","line":127,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_total","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":133,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_velocity1","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":91,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_velocity2","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":97,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Ninja.AABB.json b/docgen/output/Phaser.Physics.Ninja.AABB.json deleted file mode 100644 index 295466a42..000000000 --- a/docgen/output/Phaser.Physics.Ninja.AABB.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Ninja.AABB","extends":"","static":false,"constructor":true,"parameters":[{"name":"body","type":["Phaser.Physics.Ninja.Body"],"help":"The body that owns this shape.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to create this shape at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to create this shape at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of this AABB.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of this AABB.","optional":false,"default":null}],"help":"Ninja Physics AABB constructor.\\nNote: This class could be massively optimised and reduced in size. I leave that challenge up to you."},"consts":[],"methods":{"public":[{"name":"collideAABBVsAABB","static":false,"returns":null,"help":"Collides this AABB against a AABB.","line":346,"public":true,"protected":false,"private":false,"parameters":[{"name":"aabb","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB to collide against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideAABBVsTile","static":false,"returns":null,"help":"Collides this AABB against a Tile.","line":418,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile to collide against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideWorldBounds","static":false,"returns":null,"help":"Collides this AABB against the world bounds.","line":304,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this AABB's reference to Body and System","line":1002,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integrate","static":false,"returns":null,"help":"Updates this AABBs position.","line":113,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"projAABB_22DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":716,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_22DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":636,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_45Deg","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 45 Degree tile collision.","line":583,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_67DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":848,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_67DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":769,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_Concave","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Concave tile collision.","line":949,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_Convex","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Convex tile collision.","line":899,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_Full","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Full tile collision.","line":505,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projAABB_Half","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Half tile collision.","line":524,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render this AABB for debugging purposes.","line":1017,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context to render to.","optional":false,"default":null},{"name":"xOffset","type":["number"],"help":"X offset from AABB's position to render at.","optional":false,"default":null},{"name":"yOffset","type":["number"],"help":"Y offset from AABB's position to render at.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug shape to be rendered. (format is css color string).","optional":false,"default":null},{"name":"filled","type":["boolean"],"help":"Render the shape as solid (true) or hollow (false).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsBody","static":false,"returns":null,"help":"Process a body collision and apply the resulting forces. Still very much WIP and doesn't work fully. Feel free to fix!","line":242,"public":true,"protected":false,"private":false,"parameters":[{"name":"px","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"py","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"dx","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"obj","type":["number"],"help":"Object this AABB collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsWorld","static":false,"returns":null,"help":"Process a world collision and apply the resulting forces.","line":138,"public":true,"protected":false,"private":false,"parameters":[{"name":"px","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"py","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"dx","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"obj","type":["number"],"help":"Object this AABB collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resolveTile","static":false,"returns":{"types":["boolean"],"help":"True if the collision was processed, otherwise false."},"help":"Resolves tile collision.","line":481,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"body","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"tile","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"aabbTileProjections","type":["object"],"help":"","inlineHelp":"All of the collision response handlers.","line":86,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"oldpos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object in the previous update.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"system","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"A reference to the physics system.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity of this object.","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"xw","type":["number"],"help":"","inlineHelp":"Half the height.","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"oH","type":["number"],"help":"","inlineHelp":"Internal var.","line":70,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"oV","type":["number"],"help":"","inlineHelp":"Internal var.","line":76,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Ninja.Body.json b/docgen/output/Phaser.Physics.Ninja.Body.json deleted file mode 100644 index 55ced6573..000000000 --- a/docgen/output/Phaser.Physics.Ninja.Body.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Ninja.Body","extends":"","static":false,"constructor":true,"parameters":[{"name":"system","type":["Phaser.Physics.Ninja"],"help":"The physics system this Body belongs to.","optional":false,"default":null},{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite object this physics body belongs to.","optional":false,"default":null},{"name":"type","type":["number"],"help":"The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile.","optional":true,"default":"1"},{"name":"id","type":["number"],"help":"If this body is using a Tile shape, you can set the Tile id here, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc.","optional":true,"default":"1"},{"name":"radius","type":["number"],"help":"If this body is using a Circle shape this controls the radius.","optional":true,"default":"16"},{"name":"x","type":["number"],"help":"The x coordinate of this Body. This is only used if a sprite is not provided.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of this Body. This is only used if a sprite is not provided.","optional":true,"default":"0"},{"name":"width","type":["number"],"help":"The width of this Body. This is only used if a sprite is not provided.","optional":true,"default":"0"},{"name":"height","type":["number"],"help":"The height of this Body. This is only used if a sprite is not provided.","optional":true,"default":"0"}],"help":"The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than\\nthe Sprite itself. For example you can set the velocity, bounce values etc all on the Body."},"consts":[],"methods":{"public":[{"name":"deltaAbsX","static":false,"returns":{"types":["number"],"help":"The absolute delta value."},"help":"Returns the absolute delta x value.","line":387,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaAbsY","static":false,"returns":{"types":["number"],"help":"The absolute delta value."},"help":"Returns the absolute delta y value.","line":397,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaX","static":false,"returns":{"types":["number"],"help":"The delta value. Positive if the motion was to the right, negative if to the left."},"help":"Returns the delta x value. The difference between Body.x now and in the previous step.","line":407,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"deltaY","static":false,"returns":{"types":["number"],"help":"The delta value. Positive if the motion was downwards, negative if upwards."},"help":"Returns the delta y value. The difference between Body.y now and in the previous step.","line":417,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this body's reference to the sprite and system, and destroys its shape.","line":426,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"moveBackward","static":false,"returns":null,"help":"Moves the Body backwards based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":295,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move backwards.","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The angle in which it should move, given in degrees.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveDown","static":false,"returns":null,"help":"If this Body is dynamic then this will move it down by setting its y velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":357,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move down, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveLeft","static":false,"returns":null,"help":"If this Body is dynamic then this will move it to the left by setting its x velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":312,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move to the left, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveRight","static":false,"returns":null,"help":"If this Body is dynamic then this will move it to the right by setting its x velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":327,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move to the right, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveTo","static":false,"returns":null,"help":"Moves the Body forwards based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":277,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move forwards.","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The angle in which it should move, given in degrees.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveUp","static":false,"returns":null,"help":"If this Body is dynamic then this will move it up by setting its y velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":342,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move up, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render Sprite's Body.","line":557,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context to render to.","optional":false,"default":null},{"name":"body","type":["Phaser.Physics.Ninja.Body"],"help":"The Body to render.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug shape to be rendered. (format is css color string).","optional":true,"default":"'rgba(0,255,0,0.4)'"},{"name":"filled","type":["boolean"],"help":"Render the shape as a filled (default, true) or a stroked (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets all Body values and repositions on the Sprite.","line":370,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setZeroVelocity","static":false,"returns":null,"help":"Stops all movement of this body.","line":262,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"postUpdate","static":false,"returns":null,"help":"Internal method.","line":220,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Internal method.","line":190,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"aabb","type":["Phaser.Physics.Ninja.AABB"],"help":"","inlineHelp":"The AABB object this body is using for collision.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"","inlineHelp":"The angle of this Body","line":540,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bottom","type":["number"],"help":"","inlineHelp":"The bottom value of this Body (same as Body.y + Body.height)","line":501,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bounce","type":["number"],"help":"","inlineHelp":"The bounciness of this object when it collides. A value between 0 and 1. We recommend setting it to 0.999 to avoid jittering.","line":95,"default":"0.3","public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkCollision","type":["object"],"help":"Set the checkCollision properties to control which directions collision is processed for this Body.\\nFor example checkCollision.up = false means it won't collide when the collision happened while moving up.","inlineHelp":"An object containing allowed collision.","line":125,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"circle","type":["Phaser.Physics.Ninja.Circle"],"help":"","inlineHelp":"The Circle object this body is using for collision.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideWorldBounds","type":["boolean"],"help":"A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.","inlineHelp":"Should the Body collide with the World bounds?","line":118,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"drag","type":["number"],"help":"","inlineHelp":"The drag applied to this object as it moves.","line":77,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"facing","type":["number"],"help":"","inlineHelp":"A const reference to the direction the Body is traveling or facing.","line":106,"default":"Phaser.NONE","public":true,"protected":false,"private":false,"readOnly":false},{"name":"friction","type":["number"],"help":"","inlineHelp":"The friction applied to this object as it moves.","line":83,"default":"0.05","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravityScale","type":["number"],"help":"","inlineHelp":"How much of the world gravity should be applied to this object? 1 = all of it, 0.5 = 50%, etc.","line":89,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of this Body","line":488,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"immovable","type":["boolean"],"help":"","inlineHelp":"An immovable Body will not receive any impacts from other bodies. Not fully implemented.","line":112,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxSpeed","type":["number"],"help":"","inlineHelp":"The maximum speed this body can travel at (taking drag and friction into account)","line":144,"default":"8","public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The right value of this Body (same as Body.x + Body.width)","line":514,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"shape","type":["object"],"help":"","inlineHelp":"A local reference to the body shape.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"speed","type":["number"],"help":"","inlineHelp":"The speed of this Body","line":527,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"sprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"Reference to the parent Sprite.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"system","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"The parent physics system.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tile","type":["Phaser.Physics.Ninja.Tile"],"help":"","inlineHelp":"The Tile object this body is using for collision.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touching","type":["object"],"help":"This object is populated with boolean values when the Body collides with another.\\ntouching.up = true means the collision happened to the top of this Body for example.","inlineHelp":"An object containing touching results.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The type of physics system this body belongs to.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity in pixels per second sq. of the Body.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wasTouching","type":["object"],"help":"This object is populated with previous touching values from the bodies previous collision.","inlineHelp":"An object containing previous touching results.","line":138,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of this Body","line":475,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"x","type":["number"],"help":"","inlineHelp":"The x position.","line":442,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y position.","line":458,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Ninja.Circle.json b/docgen/output/Phaser.Physics.Ninja.Circle.json deleted file mode 100644 index b64235ed7..000000000 --- a/docgen/output/Phaser.Physics.Ninja.Circle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Ninja.Circle","extends":"","static":false,"constructor":true,"parameters":[{"name":"body","type":["Phaser.Physics.Ninja.Body"],"help":"The body that owns this shape.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to create this shape at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to create this shape at.","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of this Circle.","optional":false,"default":null}],"help":"Ninja Physics Circle constructor.\\nNote: This class could be massively optimised and reduced in size. I leave that challenge up to you."},"consts":[],"methods":{"public":[{"name":"collideCircleVsTile","static":false,"returns":{"types":["boolean"],"help":"True if they collide, otherwise false."},"help":"Collides this Circle with a Tile.","line":255,"public":true,"protected":false,"private":false,"parameters":[{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideWorldBounds","static":false,"returns":null,"help":"Collides this Circle against the world bounds.","line":212,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Circle's reference to Body and System","line":2617,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integrate","static":false,"returns":null,"help":"Updates this Circles position.","line":117,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"projCircle_22DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":1731,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_22DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":1439,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_45Deg","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 45 Degree tile collision.","line":459,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_67DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":2319,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_67DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":2034,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Concave","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Concave tile collision.","line":729,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Convex","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Convex tile collision.","line":963,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Full","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Full tile collision.","line":347,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Half","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Half tile collision.","line":1205,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render this circle for debugging purposes.","line":2632,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context to render to.","optional":false,"default":null},{"name":"xOffset","type":["number"],"help":"X offset from circle's position to render at.","optional":false,"default":null},{"name":"yOffset","type":["number"],"help":"Y offset from circle's position to render at.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug shape to be rendered. (format is css color string).","optional":false,"default":null},{"name":"filled","type":["boolean"],"help":"Render the shape as solid (true) or hollow (false).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsWorld","static":false,"returns":null,"help":"Process a world collision and apply the resulting forces.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"px","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"py","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"dx","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"obj","type":["number"],"help":"Object this Circle collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resolveCircleTile","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves tile collision.","line":322,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"circleTileProjections","type":["object"],"help":"","inlineHelp":"All of the collision response handlers.","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"oldpos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object in the previous update.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"radius","type":["number"],"help":"","inlineHelp":"The radius of this circle shape.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"system","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"A reference to the physics system.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity of this object.","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width.","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"xw","type":["number"],"help":"","inlineHelp":"Half the height.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"oH","type":["number"],"help":"","inlineHelp":"Internal var.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"oV","type":["number"],"help":"","inlineHelp":"Internal var.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Ninja.Tile.json b/docgen/output/Phaser.Physics.Ninja.Tile.json deleted file mode 100644 index a45f616a8..000000000 --- a/docgen/output/Phaser.Physics.Ninja.Tile.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Ninja.Tile","extends":"","static":false,"constructor":true,"parameters":[{"name":"body","type":["Phaser.Physics.Ninja.Body"],"help":"The body that owns this shape.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to create this shape at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to create this shape at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of this AABB.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of this AABB.","optional":false,"default":null},{"name":"type","type":["number"],"help":"The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile.","optional":true,"default":"1"}],"help":"Ninja Physics Tile constructor.\\nA Tile is defined by its width, height and type. It's type can include slope data, such as 45 degree slopes, or convex slopes.\\nUnderstand that for any type including a slope (types 2 to 29) the Tile must be SQUARE, i.e. have an equal width and height.\\nAlso note that as Tiles are primarily used for levels they have gravity disabled and world bounds collision disabled by default.\\n\\nNote: This class could be massively optimised and reduced in size. I leave that challenge up to you."},"consts":[],"methods":{"public":[{"name":"clear","static":false,"returns":null,"help":"Sets this tile to be empty.","line":295,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"collideWorldBounds","static":false,"returns":null,"help":"Tiles cannot collide with the world bounds, it's up to you to keep them where you want them. But we need this API stub to satisfy the Body.","line":158,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Tiles reference to Body and System.","line":307,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integrate","static":false,"returns":null,"help":"Updates this objects position.","line":140,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsWorld","static":false,"returns":null,"help":"Process a world collision and apply the resulting forces.","line":204,"public":true,"protected":false,"private":false,"parameters":[{"name":"px","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"py","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"dx","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"obj","type":["number"],"help":"Object this Tile collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setType","static":false,"returns":null,"help":"Tiles cannot collide with the world bounds, it's up to you to keep them where you want them. But we need this API stub to satisfy the Body.","line":274,"public":true,"protected":false,"private":false,"parameters":[{"name":"id","type":["number"],"help":"The type of Tile this will use, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"updateType","static":false,"returns":null,"help":"This converts a tile from implicitly-defined (via id), to explicit (via properties).\\nDon't call directly, instead of setType.","line":321,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"","inlineHelp":"The bottom value of this Body (same as Body.y + Body.height)","line":706,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"height","type":["number"],"help":"","inlineHelp":"The height.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"id","type":["number"],"help":"","inlineHelp":"The ID of this Tile.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"oldpos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object in the previous update.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The right value of this Body (same as Body.x + Body.width)","line":719,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"system","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"A reference to the physics system.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The type of this Tile.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity of this object.","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width.","line":83,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"x","type":["number"],"help":"","inlineHelp":"The x position.","line":673,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"xw","type":["number"],"help":"","inlineHelp":"Half the height.","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"y","type":["number"],"help":"","inlineHelp":"The y position.","line":689,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"signx","type":["number"],"help":"","inlineHelp":"Internal var.","line":100,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"signy","type":["number"],"help":"","inlineHelp":"Internal var.","line":106,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"sx","type":["number"],"help":"","inlineHelp":"Internal var.","line":112,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"sy","type":["number"],"help":"","inlineHelp":"Internal var.","line":118,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.Ninja.json b/docgen/output/Phaser.Physics.Ninja.json deleted file mode 100644 index 48787ebec..000000000 --- a/docgen/output/Phaser.Physics.Ninja.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.Ninja","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"reference to the current game instance.","optional":false,"default":null}],"help":"Ninja Physics. The Ninja Physics system was created in Flash by Metanet Software and ported to JavaScript by Richard Davey.\\n\\nIt allows for AABB and Circle to Tile collision. Tiles can be any of 34 different types, including slopes, convex and concave shapes.\\n\\nIt does what it does very well, but is ripe for expansion and optimisation. Here are some features that I'd love to see the community add:\\n\\n* AABB to AABB collision\\n* AABB to Circle collision\\n* AABB and Circle 'immovable' property support\\n* n-way collision, so an AABB\/Circle could pass through a tile from below and land upon it.\\n* QuadTree or spatial grid for faster Body vs. Tile Group look-ups.\\n* Optimise the internal vector math and reduce the quantity of temporary vars created.\\n* Expand Gravity and Bounce to allow for separate x\/y axis values.\\n* Support Bodies linked to Sprites that don't have anchor set to 0.5\\n\\nFeel free to attempt any of the above and submit a Pull Request with your code! Be sure to include test cases proving they work."},"consts":[],"methods":{"public":[{"name":"clearTilemapLayerBodies","static":false,"returns":null,"help":"Clears all physics bodies from the given TilemapLayer that were created with `World.convertTilemap`.","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"map","type":["Phaser.Tilemap"],"help":"The Tilemap to get the map data from.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to map.currentLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collide","static":false,"returns":null,"help":"Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.\\nThe second parameter can be an array of objects, of differing types.\\nThe objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead.\\nAn optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place,\\ngiving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped.\\nThe collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.","line":346,"public":true,"protected":false,"private":false,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer"],"help":"The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer","array"],"help":"The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":true,"default":"null"},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"convertTilemap","static":false,"returns":{"types":["array"],"help":"An array of the Phaser.Physics.Ninja.Tile objects that were created."},"help":"Goes through all tiles in the given Tilemap and TilemapLayer and converts those set to collide into physics tiles.\\nOnly call this *after* you have specified all of the tiles you wish to collide with calls like Tilemap.setCollisionBetween, etc.\\nEvery time you call this method it will destroy any previously created bodies and remove them from the world.\\nTherefore understand it's a very expensive operation and not to be done in a core game update loop.\\n\\nIn Ninja the Tiles have an ID from 0 to 33, where 0 is 'empty', 1 is a full tile, 2 is a 45-degree slope, etc. You can find the ID\\nlist either at the very bottom of `Tile.js`, or in a handy visual reference in the `resources\/Ninja Physics Debug Tiles` folder in the repository.\\nThe slopeMap parameter is an array that controls how the indexes of the tiles in your tilemap data will map to the Ninja Tile IDs.\\nFor example if you had 6 tiles in your tileset: Imagine the first 4 should be converted into fully solid Tiles and the other 2 are 45-degree slopes.\\nYour slopeMap array would look like this: `[ 1, 1, 1, 1, 2, 3 ]`.\\nWhere each element of the array is a tile in your tilemap and the resulting Ninja Tile it should create.","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"map","type":["Phaser.Tilemap"],"help":"The Tilemap to get the map data from.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to map.currentLayer.","optional":true,"default":null},{"name":"slopeMap","type":["object"],"help":"The tilemap index to Tile ID map.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"enable","static":false,"returns":null,"help":"This will create a Ninja Physics body on the given game object or array of game objects.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.","line":132,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"type","type":["number"],"help":"The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile.","optional":true,"default":"1"},{"name":"id","type":["number"],"help":"If this body is using a Tile shape, you can set the Tile id here, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc.","optional":true,"default":"1"},{"name":"radius","type":["number"],"help":"If this body is using a Circle shape this controls the radius.","optional":true,"default":"0"},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"enableAABB","static":false,"returns":null,"help":"This will create a Ninja Physics AABB body on the given game object. Its dimensions will match the width and height of the object at the point it is created.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.","line":83,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"enableBody","static":false,"returns":null,"help":"Creates a Ninja Physics body on the given game object.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.","line":188,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The game object to create the physics body on. A body will only be created if this object has a null `body` property.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"enableCircle","static":false,"returns":null,"help":"This will create a Ninja Physics Circle body on the given game object.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.","line":98,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the Circle.","optional":false,"default":null},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"enableTile","static":false,"returns":null,"help":"This will create a Ninja Physics Tile body on the given game object. There are 34 different types of tile you can create, including 45 degree slopes,\\nconvex and concave circles and more. The id parameter controls which Tile type is created, but you can also change it at run-time.\\nNote that for all degree based tile types they need to have an equal width and height. If the given object doesn't have equal width and height it will use the width.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.","line":115,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"id","type":["number"],"help":"The type of Tile this will use, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc.","optional":true,"default":"1"},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"overlap","static":false,"returns":null,"help":"Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.\\nYou can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.\\nUnlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.\\nThe second parameter can be an array of objects, of differing types.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter"],"help":"The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","array"],"help":"The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.","optional":false,"default":null},{"name":"overlapCallback","type":["function"],"help":"An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.","optional":true,"default":"null"},{"name":"processCallback","type":["function"],"help":"A 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 processCallback returns true.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"separate","static":false,"returns":null,"help":"The core separation function to separate two physics bodies.","line":574,"public":true,"protected":false,"private":false,"parameters":[{"name":"body1","type":["Phaser.Physics.Ninja.Body"],"help":"The Body object to separate.","optional":false,"default":null},{"name":"body2","type":["Phaser.Physics.Ninja.Body"],"help":"The Body object to separate.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setBounds","static":false,"returns":null,"help":"Updates the size of this physics world.","line":207,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"width","type":["number"],"help":"New width of the world. Can never be smaller than the Game.width.","optional":false,"default":null},{"name":"height","type":["number"],"help":"New height of the world. Can never be smaller than the Game.height.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setBoundsToWorld","static":false,"returns":null,"help":"Updates the size of this physics world to match the size of the game world.","line":218,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"collideGroupVsGroup","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Ninja.collide instead.","line":550,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"collideGroupVsSelf","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Ninja.collide instead.","line":522,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"collideHandler","static":false,"returns":null,"help":"Internal collision handler.","line":383,"public":false,"protected":false,"private":true,"parameters":[{"name":"object1","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer"],"help":"The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.","optional":false,"default":null},{"name":"object2","type":["Phaser.Sprite","Phaser.Group","Phaser.Particles.Emitter","Phaser.TilemapLayer"],"help":"The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer. Can also be an array of objects to check.","optional":false,"default":null},{"name":"collideCallback","type":["function"],"help":"An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"processCallback","type":["function"],"help":"A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to run the callbacks.","optional":false,"default":null},{"name":"overlapOnly","type":["boolean"],"help":"Just run an overlap or a full collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideSpriteVsGroup","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Ninja.collide instead.","line":484,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"collideSpriteVsSprite","static":false,"returns":null,"help":"An internal function. Use Phaser.Physics.Ninja.collide instead.","line":464,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"bounds","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The bounds inside of which the physics world exists. Defaults to match the world bounds.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["number"],"help":"","inlineHelp":"The World gravity setting.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxLevels","type":["number"],"help":"","inlineHelp":"Used by the QuadTree to set the maximum number of iteration levels.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxObjects","type":["number"],"help":"","inlineHelp":"Used by the QuadTree to set the maximum number of objects per quad.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"quadTree","type":["Phaser.QuadTree"],"help":"","inlineHelp":"The world QuadTree.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"time","type":["Phaser.Time"],"help":"","inlineHelp":"Local reference to game.time.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.Body.json b/docgen/output/Phaser.Physics.P2.Body.json deleted file mode 100644 index 3c2a5d991..000000000 --- a/docgen/output/Phaser.Physics.P2.Body.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.Body","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite object this physics body belongs to.","optional":true,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of this Body.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate of this Body.","optional":true,"default":"0"},{"name":"mass","type":["number"],"help":"The default mass of this Body (0 = static).","optional":true,"default":"1"}],"help":"The Physics Body is typically linked to a single Sprite and defines properties that determine how the physics body is simulated.\\nThese properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene.\\nIn most cases, the properties are used to simulate physical effects. Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.\\nBy default a single Rectangle shape is added to the Body that matches the dimensions of the parent Sprite. See addShape, removeShape, clearShapes to add extra shapes around the Body.\\nNote: When bound to a Sprite to avoid single-pixel jitters on mobile devices we strongly recommend using Sprite sizes that are even on both axis, i.e. 128x128 not 127x127.\\nNote: When a game object is given a P2 body it has its anchor x\/y set to 0.5, so it becomes centered."},"consts":[],"methods":{"public":[{"name":"addCapsule","static":false,"returns":{"types":["p2.Capsule"],"help":"The Capsule shape that was added to the Body."},"help":"Adds a Capsule shape to this Body.\\nYou can control the offset from the center of the body and the rotation.","line":926,"public":true,"protected":false,"private":false,"parameters":[{"name":"length","type":["number"],"help":"The distance between the end points in pixels.","optional":false,"default":null},{"name":"radius","type":["number"],"help":"Radius of the capsule in pixels.","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addCircle","static":false,"returns":{"types":["p2.Circle"],"help":"The Circle shape that was added to the Body."},"help":"Adds a Circle shape to this Body. You can control the offset from the center of the body and the rotation.","line":833,"public":true,"protected":false,"private":false,"parameters":[{"name":"radius","type":["number"],"help":"The radius of this circle (in pixels)","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addFixture","static":false,"returns":{"types":["array"],"help":"An array containing the generated shapes for the given polygon."},"help":"Add a polygon fixture. This is used during #loadPolygon.","line":1157,"public":true,"protected":false,"private":false,"parameters":[{"name":"fixtureData","type":["string"],"help":"The data for the fixture. It contains: isSensor, filter (collision) and the actual polygon shapes.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addLine","static":false,"returns":{"types":["p2.Line"],"help":"The Line shape that was added to the Body."},"help":"Adds a Line shape to this Body.\\nThe line shape is along the x direction, and stretches from [-length\/2, 0] to [length\/2,0].\\nYou can control the offset from the center of the body and the rotation.","line":906,"public":true,"protected":false,"private":false,"parameters":[{"name":"length","type":["number"],"help":"The length of this line (in pixels)","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addParticle","static":false,"returns":{"types":["p2.Particle"],"help":"The Particle shape that was added to the Body."},"help":"Adds a Particle shape to this Body. You can control the offset from the center of the body and the rotation.","line":886,"public":true,"protected":false,"private":false,"parameters":[{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addPhaserPolygon","static":false,"returns":null,"help":"Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.\\nThe shape data format is based on the custom phaser export in.","line":1121,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the Physics Data file as stored in Game.Cache.","optional":false,"default":null},{"name":"object","type":["string"],"help":"The key of the object within the Physics data file that you wish to load the shape data from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addPlane","static":false,"returns":{"types":["p2.Plane"],"help":"The Plane shape that was added to the Body."},"help":"Adds a Plane shape to this Body. The plane is facing in the Y direction. You can control the offset from the center of the body and the rotation.","line":869,"public":true,"protected":false,"private":false,"parameters":[{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addPolygon","static":false,"returns":{"types":["boolean"],"help":"True on success, else false."},"help":"Reads a polygon shape path, and assembles convex shapes from that and puts them at proper offset points. The shape must be simple and without holes.\\nThis function expects the x.y values to be given in pixels. If you want to provide them at p2 world scales then call Body.data.fromPolygon directly.\\n\\nEither [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],\\nor the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.","line":948,"public":true,"protected":false,"private":false,"parameters":[{"name":"options","type":["object"],"help":"An object containing the build options:","optional":false,"default":null},{"name":"options.optimalDecomp","type":["boolean"],"help":"Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices.","optional":true,"default":"false"},{"name":"options.skipSimpleCheck","type":["boolean"],"help":"Set to true if you already know that the path is not intersecting itself.","optional":true,"default":"false"},{"name":"options.removeCollinearPoints","type":["boolean","number"],"help":"Set to a number (angle threshold value) to remove collinear points, or false to keep all points.","optional":true,"default":"false"},{"name":"points","type":["array number","number"],"help":"An array of 2d vectors that form the convex or concave polygon.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addRectangle","static":false,"returns":{"types":["p2.Rectangle"],"help":"The Rectangle shape that was added to the Body."},"help":"Adds a Rectangle shape to this Body. You can control the offset from the center of the body and the rotation.","line":852,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the rectangle in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle in pixels.","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addShape","static":false,"returns":{"types":["p2.Shape"],"help":"The shape that was added to the body."},"help":"Add a shape to the body. You can pass a local transform when adding a shape, so that the shape gets an offset and an angle relative to the body center of mass.\\nWill automatically update the mass properties and bounding radius.","line":810,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["p2.Shape"],"help":"The shape to add to the body.","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addToWorld","static":false,"returns":null,"help":"Adds this physics body to the world.","line":720,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"adjustCenterOfMass","static":false,"returns":null,"help":"Moves the shape offsets so their center of mass becomes the body center of mass.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"applyDamping","static":false,"returns":null,"help":"Apply damping, see http:\/\/code.google.com\/p\/bullet\/issues\/detail?id=74 for details.","line":412,"public":true,"protected":false,"private":false,"parameters":[{"name":"dt","type":["number"],"help":"Current time step.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"applyForce","static":false,"returns":null,"help":"Apply force to a world point. This could for example be a point on the RigidBody surface. Applying force this way will add to Body.force and Body.angularForce.","line":426,"public":true,"protected":false,"private":false,"parameters":[{"name":"force","type":["Float32Array","array"],"help":"The force vector to add.","optional":false,"default":null},{"name":"worldX","type":["number"],"help":"The world x point to apply the force on.","optional":false,"default":null},{"name":"worldY","type":["number"],"help":"The world y point to apply the force on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearCollision","static":false,"returns":null,"help":"Clears the collision data from the shapes in this Body. Optionally clears Group and\/or Mask.","line":303,"public":true,"protected":false,"private":false,"parameters":[{"name":"clearGroup","type":["boolean"],"help":"Clear the collisionGroup value from the shape\/s?","optional":true,"default":"true"},{"name":"clearMask","type":["boolean"],"help":"Clear the collisionMask value from the shape\/s?","optional":true,"default":"true"},{"name":"shape","type":["p2.Shape"],"help":"An optional Shape. If not provided the collision data will be cleared from all Shapes in this Body.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearShapes","static":false,"returns":null,"help":"Removes all Shapes from this Body.","line":786,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"collides","static":false,"returns":null,"help":"Adds the given CollisionGroup, or array of CollisionGroups, to the list of groups that this body will collide with and updates the collision masks.","line":349,"public":true,"protected":false,"private":false,"parameters":[{"name":"group","type":["Phaser.Physics.CollisionGroup","array"],"help":"The Collision Group or Array of Collision Groups that this Bodies shapes will collide with.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional callback that will be triggered when this Body impacts with the given Group.","optional":true,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback will be called.","optional":true,"default":null},{"name":"shape","type":["p2.Shape"],"help":"An optional Shape. If not provided the collision mask will be added to all Shapes in this Body.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createBodyCallback","static":false,"returns":null,"help":"Sets a callback to be fired any time a shape in this Body impacts with a shape in the given Body. The impact test is performed against body.id values.\\nThe callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.\\nNote that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.\\nIt also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.","line":163,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["Phaser.Sprite","Phaser.TileSprite","Phaser.Physics.P2.Body","p2.Body"],"help":"The object to send impact events for.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback to fire on impact. Set to null to clear a previously set callback.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback will fire.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createGroupCallback","static":false,"returns":null,"help":"Sets a callback to be fired any time this Body impacts with the given Group. The impact test is performed against shape.collisionGroup values.\\nThe callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.\\nThis callback will only fire if this Body has been assigned a collision group.\\nNote that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.\\nIt also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.","line":204,"public":true,"protected":false,"private":false,"parameters":[{"name":"group","type":["Phaser.Physics.CollisionGroup"],"help":"The Group to send impact events for.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback to fire on impact. Set to null to clear a previously set callback.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback will fire.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Body and all references it holds to other objects.","line":759,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getCollisionMask","static":false,"returns":{"types":["number"],"help":"The bitmask."},"help":"Gets the collision bitmask from the groups this body collides with.","line":225,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadPolygon","static":false,"returns":{"types":["boolean"],"help":"True on success, else false."},"help":"Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.","line":1230,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the Physics Data file as stored in Game.Cache.","optional":false,"default":null},{"name":"object","type":["string"],"help":"The key of the object within the Physics data file that you wish to load the shape data from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveBackward","static":false,"returns":null,"help":"Moves the Body backwards based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":552,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move backwards.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveDown","static":false,"returns":null,"help":"If this Body is dynamic then this will move it down by setting its y velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":642,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move down, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveForward","static":false,"returns":null,"help":"Moves the Body forwards based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":535,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move forwards.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveLeft","static":false,"returns":null,"help":"If this Body is dynamic then this will move it to the left by setting its x velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":603,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move to the left, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveRight","static":false,"returns":null,"help":"If this Body is dynamic then this will move it to the right by setting its x velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":616,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move to the right, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"moveUp","static":false,"returns":null,"help":"If this Body is dynamic then this will move it up by setting its y velocity to the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should move up, in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeFromWorld","static":false,"returns":null,"help":"Removes this physics body from the world.","line":745,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeShape","static":false,"returns":{"types":["boolean"],"help":"True if the shape was found and removed, else false."},"help":"Remove a shape from the body. Will automatically update the mass properties and bounding radius.","line":1007,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["p2.Circle","p2.Rectangle","p2.Plane","p2.Line","p2.Particle"],"help":"The shape to remove from the body.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the Body force, velocity (linear and angular) and rotation. Optionally resets damping and mass.","line":691,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The new x position of the Body.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new x position of the Body.","optional":false,"default":null},{"name":"resetDamping","type":["boolean"],"help":"Resets the linear and angular damping.","optional":true,"default":"false"},{"name":"resetMass","type":["boolean"],"help":"Sets the Body mass back to 1.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"reverse","static":false,"returns":null,"help":"Applies a force to the Body that causes it to 'thrust' backwards (in reverse), based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":586,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should reverse.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rotateLeft","static":false,"returns":null,"help":"This will rotate the Body by the given speed to the left (counter-clockwise).","line":510,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should rotate.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rotateRight","static":false,"returns":null,"help":"This will rotate the Body by the given speed to the left (clockwise).","line":522,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should rotate.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setCircle","static":false,"returns":null,"help":"Clears any previously set shapes. Then creates a new Circle shape and adds it to this Body.","line":1025,"public":true,"protected":false,"private":false,"parameters":[{"name":"radius","type":["number"],"help":"The radius of this circle (in pixels)","optional":false,"default":null},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionGroup","static":false,"returns":null,"help":"Sets the given CollisionGroup to be the collision group for all shapes in this Body, unless a shape is specified.\\nThis also resets the collisionMask.","line":275,"public":true,"protected":false,"private":false,"parameters":[{"name":"group","type":["Phaser.Physics.CollisionGroup"],"help":"The Collision Group that this Bodies shapes will use.","optional":false,"default":null},{"name":"shape","type":["p2.Shape"],"help":"An optional Shape. If not provided the collision group will be added to all Shapes in this Body.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMaterial","static":false,"returns":null,"help":"Adds the given Material to all Shapes that belong to this Body.\\nIf you only wish to apply it to a specific Shape in this Body then provide that as the 2nd parameter.","line":1083,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["Phaser.Physics.P2.Material"],"help":"The Material that will be applied.","optional":false,"default":null},{"name":"shape","type":["p2.Shape"],"help":"An optional Shape. If not provided the Material will be added to all Shapes in this Body.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setRectangle","static":false,"returns":{"types":["p2.Rectangle"],"help":"The Rectangle shape that was added to the Body."},"help":"Clears any previously set shapes. The creates a new Rectangle shape at the given size and offset, and adds it to this Body.\\nIf you wish to create a Rectangle to match the size of a Sprite or Image see Body.setRectangleFromSprite.","line":1045,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width of the rectangle in pixels.","optional":true,"default":"16"},{"name":"height","type":["number"],"help":"The height of the rectangle in pixels.","optional":true,"default":"16"},{"name":"offsetX","type":["number"],"help":"Local horizontal offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"offsetY","type":["number"],"help":"Local vertical offset of the shape relative to the body center of mass.","optional":true,"default":"0"},{"name":"rotation","type":["number"],"help":"Local rotation of the shape relative to the body center of mass, specified in radians.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setRectangleFromSprite","static":false,"returns":{"types":["p2.Rectangle"],"help":"The Rectangle shape that was added to the Body."},"help":"Clears any previously set shapes.\\nThen creates a Rectangle shape sized to match the dimensions and orientation of the Sprite given.\\nIf no Sprite is given it defaults to using the parent of this Body.","line":1065,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image"],"help":"The Sprite on which the Rectangle will get its dimensions.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setZeroDamping","static":false,"returns":null,"help":"Sets the Body damping and angularDamping to zero.","line":471,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setZeroForce","static":false,"returns":null,"help":"Sets the force on the body to zero.","line":437,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setZeroRotation","static":false,"returns":null,"help":"If this Body is dynamic then this will zero its angular velocity.","line":448,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setZeroVelocity","static":false,"returns":null,"help":"If this Body is dynamic then this will zero its velocity on both axis.","line":459,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"shapeChanged","static":false,"returns":null,"help":"Updates the debug draw if any body shapes change.","line":1104,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"thrust","static":false,"returns":null,"help":"Applies a force to the Body that causes it to 'thrust' forwards, based on its current angle and the given speed.\\nThe speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).","line":569,"public":true,"protected":false,"private":false,"parameters":[{"name":"speed","type":["number"],"help":"The speed at which it should thrust.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toLocalFrame","static":false,"returns":null,"help":"Transform a world point to local body frame.","line":485,"public":true,"protected":false,"private":false,"parameters":[{"name":"out","type":["Float32Array","array"],"help":"The vector to store the result in.","optional":false,"default":null},{"name":"worldPoint","type":["Float32Array","array"],"help":"The input world vector.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toWorldFrame","static":false,"returns":null,"help":"Transform a local point to world frame.","line":498,"public":true,"protected":false,"private":false,"parameters":[{"name":"out","type":["array"],"help":"The vector to store the result in.","optional":false,"default":null},{"name":"localPoint","type":["array"],"help":"The input local vector.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateCollisionMask","static":false,"returns":null,"help":"Updates the collisionMask.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["p2.Shape"],"help":"An optional Shape. If not provided the collision group will be added to all Shapes in this Body.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"postUpdate","static":false,"returns":null,"help":"Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.","line":670,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.","line":654,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"DYNAMIC","type":["number"],"help":"Dynamic body. Dynamic bodies body can move and respond to collisions and forces.","inlineHelp":"","line":1284,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"KINEMATIC","type":["number"],"help":"Kinematic body. Kinematic bodies only moves according to its .velocity, and does not respond to collisions or force.","inlineHelp":"","line":1300,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"STATIC","type":["number"],"help":"Static body. Static bodies do not move, and they do not respond to forces or collision.","inlineHelp":"","line":1292,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"allowSleep","type":["boolean"],"help":"","inlineHelp":"","line":1401,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of the Body in degrees from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement Body.angle = 450 is the same as Body.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Body.rotation instead. Working in radians is faster as it doesn't have to convert values.","inlineHelp":"The angle of this Body in degrees.","line":1428,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularDamping","type":["number"],"help":"Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second.","inlineHelp":"The angular damping acting acting on the body.","line":1449,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularForce","type":["number"],"help":"","inlineHelp":"The angular force acting on the body.","line":1469,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angularVelocity","type":["number"],"help":"","inlineHelp":"The angular velocity of the body.","line":1489,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideWorldBounds","type":["boolean"],"help":"A Body can be set to collide against the World bounds automatically if this is set to true. Otherwise it will leave the World.\\nNote that this only applies if your World has bounds! The response to the collision should be managed via CollisionMaterials.\\nAlso note that when you set this it will only effect Body shapes that already exist. If you then add further shapes to your Body\\nafter setting this it will *not* proactively set them to collide with the bounds.","inlineHelp":"Should the Body collide with the World bounds?","line":1752,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collidesWith","type":["array"],"help":"","inlineHelp":"Array of CollisionGroups that this Bodies shapes collide with.","line":95,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"damping","type":["number"],"help":"Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second.","inlineHelp":"The linear damping acting on the body in the velocity direction.","line":1510,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"Enable or disable debug drawing of this body","line":1718,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugBody","type":["Phaser.Physics.P2.BodyDebug"],"help":"","inlineHelp":"Reference to the debug body.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dynamic","type":["boolean"],"help":"","inlineHelp":"Returns true if the Body is dynamic. Setting Body.dynamic to 'false' will make it static.","line":1339,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedRotation","type":["boolean"],"help":"","inlineHelp":"","line":1530,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"force","type":["Phaser.Physics.P2.InversePointProxy"],"help":"","inlineHelp":"The force applied to the body.","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["Phaser.Point"],"help":"","inlineHelp":"A locally applied gravity force to the Body. Applied directly before the world step. NOTE: Not currently implemented.","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"id","type":["number"],"help":"","inlineHelp":"The Body ID. Each Body that has been added to the World has a unique ID.","line":1704,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"inertia","type":["number"],"help":"","inlineHelp":"The inertia of the body around the Z axis..","line":1553,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"kinematic","type":["boolean"],"help":"","inlineHelp":"Returns true if the Body is kinematic. Setting Body.kinematic to 'false' will make it static.","line":1372,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mass","type":["number"],"help":"","inlineHelp":"","line":1573,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"motionState","type":["number"],"help":"","inlineHelp":"The type of motion this body has. Should be one of: Body.STATIC (the body does not move), Body.DYNAMIC (body can move and respond to collisions) and Body.KINEMATIC (only moves according to its .velocity).","line":1597,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"","inlineHelp":"The offset of the Physics Body from the Sprite x\/y position.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onBeginContact","type":["Phaser.Signal"],"help":"Dispatched when a first contact is created between shapes in two bodies. This event is fired during the step, so collision has already taken place.\\nThe event will be sent 4 parameters: The body it is in contact with, the shape from this body that caused the contact, the shape from the contact body and the contact equation data array.","inlineHelp":"","line":83,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onEndContact","type":["Phaser.Signal"],"help":"Dispatched when contact ends between shapes in two bodies. This event is fired during the step, so collision has already taken place.\\nThe event will be sent 3 parameters: The body it is in contact with, the shape from this body that caused the contact and the shape from the contact body.","inlineHelp":"","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"removeNextStep","type":["boolean"],"help":"","inlineHelp":"To avoid deleting this body during a physics step, and causing all kinds of problems, set removeNextStep to true to have it removed in the next preUpdate.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of the Body in radians.\\nIf you wish to work in degrees instead of radians use the Body.angle property instead. Working in radians is faster as it doesn't have to convert values.","inlineHelp":"The angle of this Body in radians.","line":1623,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sleepSpeedLimit","type":["number"],"help":"","inlineHelp":".","line":1643,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sprite","type":["Phaser.Sprite"],"help":"","inlineHelp":"Reference to the parent Sprite.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"static","type":["boolean"],"help":"","inlineHelp":"Returns true if the Body is static. Setting Body.static to 'false' will make it dynamic.","line":1306,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The type of physics system this body belongs to.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Physics.P2.InversePointProxy"],"help":"","inlineHelp":"The velocity of the body. Set velocity.x to a negative value to move to the left, position to the right. velocity.y negative values move up, positive move down.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to the P2 World.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x coordinate of this Body.","line":1663,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y coordinate of this Body.","line":1683,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"data","type":["p2.Body"],"help":"","inlineHelp":"The p2 Body data.","line":59,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_bodyCallbackContext","type":["object"],"help":"","inlineHelp":"Array of Grouo callback contexts.","line":135,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_bodyCallbacks","type":["object"],"help":"","inlineHelp":"Array of Body callbacks.","line":117,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_collideWorldBounds","type":["boolean"],"help":"","inlineHelp":"Internal var that determines if this Body collides with the world bounds or not.","line":111,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_groupCallbacks","type":["object"],"help":"","inlineHelp":"Array of Group callbacks.","line":129,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.BodyDebug.json b/docgen/output/Phaser.Physics.P2.BodyDebug.json deleted file mode 100644 index 37639af78..000000000 --- a/docgen/output/Phaser.Physics.P2.BodyDebug.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.BodyDebug","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"The P2 Body to display debug data for.","optional":false,"default":null},{"name":"settings","type":["object"],"help":"Settings object.","optional":false,"default":null}],"help":"Draws a P2 Body to a Graphics instance for visual debugging.\\nNeedless to say, for every body you enable debug drawing on, you are adding processor and graphical overhead.\\nSo use sparingly and rarely (if ever) in production code."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"componentToHex","static":false,"returns":null,"help":"Component to hex conversion.","line":410,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"draw","static":false,"returns":null,"help":"Draws the P2 shapes to the Graphics object.","line":162,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"drawCircle","static":false,"returns":null,"help":"Draws a P2 Line shape.","line":196,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"drawConvex","static":false,"returns":null,"help":"Draws a P2 Convex shape.","line":212,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"drawPath","static":false,"returns":null,"help":"Draws a P2 Path.","line":282,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"drawPlane","static":false,"returns":null,"help":"Draws a P2 Plane shape.","line":352,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"randomPastelHex","static":false,"returns":null,"help":"Picks a random pastel color.","line":379,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"rgbToHex","static":false,"returns":null,"help":"Converts from RGB to Hex.","line":401,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Core update.","line":71,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateSpriteTransform","static":false,"returns":null,"help":"Core update.","line":82,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"","inlineHelp":"The P2 Body to display debug data for.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["Phaser.Graphics"],"help":"","inlineHelp":"The canvas to render the debug info to.","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A name for this Group. Not used internally but useful for debugging.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ppu","type":["number"],"help":"","inlineHelp":"Pixels per Length Unit.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the Group container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The x coordinate of the Group container.","line":1865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The y coordinate of the Group container.","line":1872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"defaultSettings","type":["object"],"help":"","inlineHelp":"Default debug settings.","line":28,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.CollisionGroup.json b/docgen/output/Phaser.Physics.P2.CollisionGroup.json deleted file mode 100644 index 1905ce791..000000000 --- a/docgen/output/Phaser.Physics.P2.CollisionGroup.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.CollisionGroup","extends":"","static":false,"constructor":true,"parameters":[{"name":"bitmask","type":["number"],"help":"The CollisionGroup bitmask.","optional":false,"default":null}],"help":"Collision Group"},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"mask","type":["number"],"help":"","inlineHelp":"The CollisionGroup bitmask.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.ContactMaterial.json b/docgen/output/Phaser.Physics.P2.ContactMaterial.json deleted file mode 100644 index d099bc79a..000000000 --- a/docgen/output/Phaser.Physics.P2.ContactMaterial.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.ContactMaterial","extends":"","static":false,"constructor":true,"parameters":[{"name":"materialA","type":["Phaser.Physics.P2.Material"],"help":"First material participating in the contact material.","optional":false,"default":null},{"name":"materialB","type":["Phaser.Physics.P2.Material"],"help":"Second material participating in the contact material.","optional":false,"default":null},{"name":"options","type":["object"],"help":"Additional configuration options.","optional":true,"default":null}],"help":"Defines a physics material"},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"[friction=0.3]","type":["number"],"help":"","inlineHelp":"Friction to use in the contact of these two materials.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[frictionRelaxation=3]","type":["number"],"help":"","inlineHelp":"Relaxation of the resulting FrictionEquation that this ContactMaterial generate.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[frictionStiffness=1e7]","type":["number"],"help":"","inlineHelp":"Stiffness of the resulting FrictionEquation that this ContactMaterial generate.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[relaxation=3]","type":["number"],"help":"","inlineHelp":"Relaxation of the resulting ContactEquation that this ContactMaterial generate.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[restitution=0.0]","type":["number"],"help":"","inlineHelp":"Restitution to use in the contact of these two materials.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[stiffness=1e7]","type":["number"],"help":"","inlineHelp":"Stiffness of the resulting ContactEquation that this ContactMaterial generate.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"[surfaceVelocity=0]","type":["number"],"help":"","inlineHelp":"Will add surface velocity to this material. If bodyA rests on top if bodyB, and the surface velocity is positive, bodyA will slide to the right.","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"id","type":["number"],"help":"","inlineHelp":"The contact material identifier.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"materialA","type":["Phaser.Physics.P2.Material"],"help":"","inlineHelp":"First material participating in the contact material.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"materialB","type":["Phaser.Physics.P2.Material"],"help":"","inlineHelp":"Second material participating in the contact material.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.DistanceConstraint.json b/docgen/output/Phaser.Physics.P2.DistanceConstraint.json deleted file mode 100644 index 57d78d345..000000000 --- a/docgen/output/Phaser.Physics.P2.DistanceConstraint.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.DistanceConstraint","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"distance","type":["number"],"help":"The distance to keep between the bodies.","optional":false,"default":null},{"name":"localAnchorA","type":["array"],"help":"The anchor point for bodyA, defined locally in bodyA frame. Defaults to [0,0].","optional":true,"default":null},{"name":"localAnchorB","type":["array"],"help":"The anchor point for bodyB, defined locally in bodyB frame. Defaults to [0,0].","optional":true,"default":null},{"name":"maxForce","type":["object"],"help":"Maximum force to apply.","optional":true,"default":"Number.MAX_VALUE"}],"help":"A constraint that tries to keep the distance between two bodies constant."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.FixtureList.json b/docgen/output/Phaser.Physics.P2.FixtureList.json deleted file mode 100644 index fe8748d6c..000000000 --- a/docgen/output/Phaser.Physics.P2.FixtureList.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.FixtureList","extends":"","static":false,"constructor":true,"parameters":[{"name":"list","type":["array"],"help":"A list of fixtures (from Phaser.Physics.P2.Body#addPhaserPolygon)","optional":false,"default":null}],"help":"Allow to access a list of created fixture (coming from Body#addPhaserPolygon)\\nwhich itself parse the input from PhysicsEditor with the custom phaser exporter.\\nYou can access fixtures of a Body by a group index or even by providing a fixture Key.\\n\\nYou can set the fixture key and also the group index for a fixture in PhysicsEditor.\\nThis gives you the power to create a complex body built of many fixtures and modify them\\nduring runtime (to remove parts, set masks, categories & sensor properties)"},"consts":[],"methods":{"public":[{"name":"flatten","static":false,"returns":null,"help":"A helper to flatten arrays. This is very useful as the fixtures are nested from time to time due to the way P2 creates and splits polygons.","line":218,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to flatten. Notice: This will happen recursive not shallow.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFixtureByKey","static":false,"returns":null,"help":"Accessor to get either a single fixture by its key.","line":164,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the fixture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFixtures","static":false,"returns":null,"help":"Accessor to get either a list of specified fixtures by key or the whole fixture list","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"keys","type":["array"],"help":"A list of fixture keys","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getGroup","static":false,"returns":null,"help":"Accessor to get a group of fixtures by its group index.","line":176,"public":true,"protected":false,"private":false,"parameters":[{"name":"groupID","type":["number"],"help":"The group index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"","line":41,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"parse","static":false,"returns":null,"help":"Parser for the output of Phaser.Physics.P2.Body#addPhaserPolygon","line":187,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setCategory","static":false,"returns":null,"help":"","line":68,"public":true,"protected":false,"private":false,"parameters":[{"name":"bit","type":["number"],"help":"The bit to set as the collision group.","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMask","static":false,"returns":null,"help":"","line":83,"public":true,"protected":false,"private":false,"parameters":[{"name":"bit","type":["number"],"help":"The bit to set as the collision mask","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMaterial","static":false,"returns":null,"help":"","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["object"],"help":"The contact material for a fixture","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSensor","static":false,"returns":null,"help":"","line":98,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["boolean"],"help":"sensor true or false","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[{"name":"allFixtures","type":["array"],"help":"","inlineHelp":"This is a list of everything in this collection","line":59,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"groupedFixtures","type":["array"],"help":"","inlineHelp":"Collect all given fixtures per group index. Notice: Every fixture with a key also belongs to a group","line":53,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"namedFixtures","type":["object"],"help":"","inlineHelp":"Collect all fixtures with a key","line":47,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.GearConstraint.json b/docgen/output/Phaser.Physics.P2.GearConstraint.json deleted file mode 100644 index 729f4cc7e..000000000 --- a/docgen/output/Phaser.Physics.P2.GearConstraint.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.GearConstraint","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The relative angle","optional":true,"default":"0"},{"name":"ratio","type":["number"],"help":"The gear ratio.","optional":true,"default":"1"}],"help":"Connects two bodies at given offset points, letting them rotate relative to each other around this point."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.InversePointProxy.json b/docgen/output/Phaser.Physics.P2.InversePointProxy.json deleted file mode 100644 index f639209f9..000000000 --- a/docgen/output/Phaser.Physics.P2.InversePointProxy.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.InversePointProxy","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"destination","type":["any"],"help":"The object to bind to.","optional":false,"default":null}],"help":"A InversePointProxy is an internal class that allows for direct getter\/setter style property access to Arrays and TypedArrays but inverses the values on set."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"mx","type":["number"],"help":"","inlineHelp":"The x property of this InversePointProxy get and set in meters.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"my","type":["number"],"help":"","inlineHelp":"The y property of this InversePointProxy get and set in meters.","line":88,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x property of this InversePointProxy get and set in pixels.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y property of this InversePointProxy get and set in pixels.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.LockConstraint.json b/docgen/output/Phaser.Physics.P2.LockConstraint.json deleted file mode 100644 index 9a1690a21..000000000 --- a/docgen/output/Phaser.Physics.P2.LockConstraint.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.LockConstraint","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"offset","type":["array"],"help":"The offset of bodyB in bodyA's frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"angle","type":["number"],"help":"The angle of bodyB in bodyA's frame.","optional":true,"default":"0"},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":null}],"help":"Locks the relative position between two bodies."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.Material.json b/docgen/output/Phaser.Physics.P2.Material.json deleted file mode 100644 index d693f49e8..000000000 --- a/docgen/output/Phaser.Physics.P2.Material.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.Material","extends":"","static":false,"constructor":true,"parameters":[{"name":"name","type":["string"],"help":"The user defined name given to this Material.","optional":false,"default":null}],"help":"A P2 Material.\\n\\n\\o\/ ~ \"Because I'm a Material girl\""},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Material.","line":22,"default":"name","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.PointProxy.json b/docgen/output/Phaser.Physics.P2.PointProxy.json deleted file mode 100644 index 4963029d6..000000000 --- a/docgen/output/Phaser.Physics.P2.PointProxy.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.PointProxy","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"destination","type":["any"],"help":"The object to bind to.","optional":false,"default":null}],"help":"A PointProxy is an internal class that allows for direct getter\/setter style property access to Arrays and TypedArrays."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"mx","type":["number"],"help":"","inlineHelp":"The x property of this PointProxy get and set in meters.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"my","type":["number"],"help":"","inlineHelp":"The x property of this PointProxy get and set in meters.","line":88,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x property of this PointProxy get and set in pixels.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y property of this PointProxy get and set in pixels.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.PrismaticConstraint.json b/docgen/output/Phaser.Physics.P2.PrismaticConstraint.json deleted file mode 100644 index 0270fb993..000000000 --- a/docgen/output/Phaser.Physics.P2.PrismaticConstraint.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.PrismaticConstraint","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"lockRotation","type":["boolean"],"help":"If set to false, bodyB will be free to rotate around its anchor point.","optional":true,"default":"true"},{"name":"anchorA","type":["array"],"help":"Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"anchorB","type":["array"],"help":"Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"axis","type":["array"],"help":"An axis, defined in body A frame, that body B's anchor point may slide along. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":null}],"help":"Connects two bodies at given offset points, letting them rotate relative to each other around this point."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.RevoluteConstraint.json b/docgen/output/Phaser.Physics.P2.RevoluteConstraint.json deleted file mode 100644 index 0d470cb7b..000000000 --- a/docgen/output/Phaser.Physics.P2.RevoluteConstraint.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.RevoluteConstraint","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"pivotA","type":["Float32Array"],"help":"The point relative to the center of mass of bodyA which bodyA is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"pivotB","type":["Float32Array"],"help":"The point relative to the center of mass of bodyB which bodyB is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":false,"default":null},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":"0"},{"name":"worldPivot","type":["Float32Array"],"help":"A pivot point given in world coordinates. If specified, localPivotA and localPivotB are automatically computed from this value.","optional":true,"default":"null"}],"help":"Connects two bodies at given offset points, letting them rotate relative to each other around this point.\\nThe pivot points are given in world (pixel) coordinates."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.RotationalSpring.json b/docgen/output/Phaser.Physics.P2.RotationalSpring.json deleted file mode 100644 index d7531d8ca..000000000 --- a/docgen/output/Phaser.Physics.P2.RotationalSpring.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.RotationalSpring","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"restAngle","type":["number"],"help":"The relative angle of bodies at which the spring is at rest. If not given, it's set to the current relative angle between the bodies.","optional":true,"default":null},{"name":"stiffness","type":["number"],"help":"Stiffness of the spring. A number >= 0.","optional":true,"default":"100"},{"name":"damping","type":["number"],"help":"Damping of the spring. A number >= 0.","optional":true,"default":"1"}],"help":"Creates a rotational spring, connecting two bodies. A spring can have a resting length, a stiffness and damping."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"data","type":["p2.RotationalSpring"],"help":"","inlineHelp":"The actual p2 spring object.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.Spring.json b/docgen/output/Phaser.Physics.P2.Spring.json deleted file mode 100644 index 3b0c8db81..000000000 --- a/docgen/output/Phaser.Physics.P2.Spring.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2.Spring","extends":"","static":false,"constructor":true,"parameters":[{"name":"world","type":["Phaser.Physics.P2"],"help":"A reference to the P2 World.","optional":false,"default":null},{"name":"bodyA","type":["p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"restLength","type":["number"],"help":"Rest length of the spring. A number > 0.","optional":true,"default":"1"},{"name":"stiffness","type":["number"],"help":"Stiffness of the spring. A number >= 0.","optional":true,"default":"100"},{"name":"damping","type":["number"],"help":"Damping of the spring. A number >= 0.","optional":true,"default":"1"},{"name":"worldA","type":["array"],"help":"Where to hook the spring to body A in world coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"worldB","type":["array"],"help":"Where to hook the spring to body B in world coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"localA","type":["array"],"help":"Where to hook the spring to body A in local body coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"localB","type":["array"],"help":"Where to hook the spring to body B in local body coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null}],"help":"Creates a linear spring, connecting two bodies. A spring can have a resting length, a stiffness and damping."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"data","type":["p2.LinearSpring"],"help":"","inlineHelp":"The actual p2 spring object.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"Local reference to P2 World.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.P2.json b/docgen/output/Phaser.Physics.P2.json deleted file mode 100644 index ffcac47f7..000000000 --- a/docgen/output/Phaser.Physics.P2.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics.P2","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Reference to the current game instance.","optional":false,"default":null},{"name":"config","type":["object"],"help":"Physics configuration object passed in from the game constructor.","optional":true,"default":null}],"help":"This is your main access to the P2 Physics World.\\nFrom here you can create materials, listen for events and add bodies into the physics simulation."},"consts":[],"methods":{"public":[{"name":"addBody","static":false,"returns":{"types":["boolean"],"help":"True if the Body was added successfully, otherwise false."},"help":"Add a body to the world.","line":734,"public":true,"protected":false,"private":false,"parameters":[{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"The Body to add to the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.Constraint"],"help":"The Constraint that was added."},"help":"Adds a Constraint to the world.","line":966,"public":true,"protected":false,"private":false,"parameters":[{"name":"constraint","type":["Phaser.Physics.P2.Constraint"],"help":"The Constraint to add to the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addContactMaterial","static":false,"returns":{"types":["Phaser.Physics.P2.ContactMaterial"],"help":"The Contact Material that was added."},"help":"Adds a Contact Material to the world.","line":1000,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["Phaser.Physics.P2.ContactMaterial"],"help":"The Contact Material to be added to the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addSpring","static":false,"returns":{"types":["Phaser.Physics.P2.Spring"],"help":"The Spring that was added."},"help":"Adds a Spring to the world.","line":778,"public":true,"protected":false,"private":false,"parameters":[{"name":"spring","type":["Phaser.Physics.P2.Spring","p2.LinearSpring","p2.RotationalSpring"],"help":"The Spring to add to the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"beginContactHandler","static":false,"returns":null,"help":"Handles a p2 begin contact event.","line":418,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clear","static":false,"returns":null,"help":"Clears all bodies from the simulation, resets callbacks and resets the collision bitmask.","line":696,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"clearTilemapLayerBodies","static":false,"returns":null,"help":"Clears all physics bodies from the given TilemapLayer that were created with `World.convertTilemap`.","line":1511,"public":true,"protected":false,"private":false,"parameters":[{"name":"map","type":["Phaser.Tilemap"],"help":"The Tilemap to get the map data from.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to map.currentLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"convertCollisionObjects","static":false,"returns":{"types":["array"],"help":"An array of the Phaser.Physics.Body objects that have been created."},"help":"Converts all of the polylines objects inside a Tiled ObjectGroup into physics bodies that are added to the world.\\nNote that the polylines must be created in such a way that they can withstand polygon decomposition.","line":1473,"public":true,"protected":false,"private":false,"parameters":[{"name":"map","type":["Phaser.Tilemap"],"help":"The Tilemap to get the map data from.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to map.currentLayer.","optional":true,"default":null},{"name":"addToWorld","type":["boolean"],"help":"If true it will automatically add each body to the world.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"convertTilemap","static":false,"returns":{"types":["array"],"help":"An array of the Phaser.Physics.P2.Body objects that were created."},"help":"Goes through all tiles in the given Tilemap and TilemapLayer and converts those set to collide into physics bodies.\\nOnly call this *after* you have specified all of the tiles you wish to collide with calls like Tilemap.setCollisionBetween, etc.\\nEvery time you call this method it will destroy any previously created bodies and remove them from the world.\\nTherefore understand it's a very expensive operation and not to be done in a core game update loop.","line":1539,"public":true,"protected":false,"private":false,"parameters":[{"name":"map","type":["Phaser.Tilemap"],"help":"The Tilemap to get the map data from.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to map.currentLayer.","optional":true,"default":null},{"name":"addToWorld","type":["boolean"],"help":"If true it will automatically add each body to the world, otherwise it's up to you to do so.","optional":true,"default":"true"},{"name":"optimize","type":["boolean"],"help":"If true adjacent colliding tiles will be combined into a single body to save processing. However it means you cannot perform specific Tile to Body collision responses.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"createBody","static":false,"returns":{"types":["Phaser.Physics.P2.Body"],"help":"The body"},"help":"Creates a new Body and adds it to the World.\\n\\nEither [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],\\nor the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.","line":1397,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of Body.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of Body.","optional":false,"default":null},{"name":"mass","type":["number"],"help":"The mass of the Body. A mass of 0 means a 'static' Body is created.","optional":false,"default":null},{"name":"addToWorld","type":["boolean"],"help":"Automatically add this Body to the world? (usually false as it won't have any shapes on construction).","optional":true,"default":"false"},{"name":"options","type":["object"],"help":"An object containing the build options:","optional":false,"default":null},{"name":"options.optimalDecomp","type":["boolean"],"help":"Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices.","optional":true,"default":"false"},{"name":"options.skipSimpleCheck","type":["boolean"],"help":"Set to true if you already know that the path is not intersecting itself.","optional":true,"default":"false"},{"name":"options.removeCollinearPoints","type":["boolean","number"],"help":"Set to a number (angle threshold value) to remove collinear points, or false to keep all points.","optional":true,"default":"false"},{"name":"points","type":["array number","number"],"help":"An array of 2d vectors that form the convex or concave polygon.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createCollisionGroup","static":false,"returns":null,"help":"Creates a new Collision Group and optionally applies it to the given object.\\nCollision Groups are handled using bitmasks, therefore you have a fixed limit you can create before you need to re-use older groups.","line":1256,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["Phaser.Group","Phaser.Sprite"],"help":"An optional Sprite or Group to apply the Collision Group to. If a Group is given it will be applied to all top-level children.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createContactMaterial","static":false,"returns":{"types":["Phaser.Physics.P2.ContactMaterial"],"help":"The Contact Material that was created."},"help":"Creates a Contact Material from the two given Materials. You can then edit the properties of the Contact Material directly.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"materialA","type":["Phaser.Physics.P2.Material"],"help":"The first Material to create the ContactMaterial from. If undefined it will create a new Material object first.","optional":true,"default":null},{"name":"materialB","type":["Phaser.Physics.P2.Material"],"help":"The second Material to create the ContactMaterial from. If undefined it will create a new Material object first.","optional":true,"default":null},{"name":"options","type":["object"],"help":"Material options object.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createDistanceConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.DistanceConstraint"],"help":"The constraint"},"help":"Creates a constraint that tries to keep the distance between two bodies constant.","line":831,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"distance","type":["number"],"help":"The distance to keep between the bodies.","optional":false,"default":null},{"name":"localAnchorA","type":["array"],"help":"The anchor point for bodyA, defined locally in bodyA frame. Defaults to [0,0].","optional":true,"default":null},{"name":"localAnchorB","type":["array"],"help":"The anchor point for bodyB, defined locally in bodyB frame. Defaults to [0,0].","optional":true,"default":null},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createGearConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.GearConstraint"],"help":"The constraint"},"help":"Creates a constraint that tries to keep the distance between two bodies constant.","line":857,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The relative angle","optional":true,"default":"0"},{"name":"ratio","type":["number"],"help":"The gear ratio.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"createLockConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.LockConstraint"],"help":"The constraint"},"help":"Locks the relative position between two bodies.","line":913,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"offset","type":["array"],"help":"The offset of bodyB in bodyA's frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"angle","type":["number"],"help":"The angle of bodyB in bodyA's frame.","optional":true,"default":"0"},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createMaterial","static":false,"returns":{"types":["Phaser.Physics.P2.Material"],"help":"The Material that was created. This is also stored in Phaser.Physics.P2.materials."},"help":"Creates a Material. Materials are applied to Shapes owned by a Body and can be set with Body.setMaterial().\\nMaterials are a way to control what happens when Shapes collide. Combine unique Materials together to create Contact Materials.\\nContact Materials have properties such as friction and restitution that allow for fine-grained collision control between different Materials.","line":1069,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"Optional name of the Material. Each Material has a unique ID but string names are handy for debugging.","optional":true,"default":null},{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"Optional Body. If given it will assign the newly created Material to the Body shapes.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createParticle","static":false,"returns":null,"help":"Creates a new Particle and adds it to the World.\\n\\nEither [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],\\nor the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.","line":1438,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of Body.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of Body.","optional":false,"default":null},{"name":"mass","type":["number"],"help":"The mass of the Body. A mass of 0 means a 'static' Body is created.","optional":false,"default":null},{"name":"addToWorld","type":["boolean"],"help":"Automatically add this Body to the world? (usually false as it won't have any shapes on construction).","optional":true,"default":"false"},{"name":"options","type":["object"],"help":"An object containing the build options:","optional":false,"default":null},{"name":"options.optimalDecomp","type":["boolean"],"help":"Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices.","optional":true,"default":"false"},{"name":"options.skipSimpleCheck","type":["boolean"],"help":"Set to true if you already know that the path is not intersecting itself.","optional":true,"default":"false"},{"name":"options.removeCollinearPoints","type":["boolean","number"],"help":"Set to a number (angle threshold value) to remove collinear points, or false to keep all points.","optional":true,"default":"false"},{"name":"points","type":["array number","number"],"help":"An array of 2d vectors that form the convex or concave polygon.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createPrismaticConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.PrismaticConstraint"],"help":"The constraint"},"help":"Constraint that only allows bodies to move along a line, relative to each other.\\nSee http:\/\/www.iforce2d.net\/b2dtut\/joints-prismatic","line":943,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"lockRotation","type":["boolean"],"help":"If set to false, bodyB will be free to rotate around its anchor point.","optional":true,"default":"true"},{"name":"anchorA","type":["array"],"help":"Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"anchorB","type":["array"],"help":"Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"axis","type":["array"],"help":"An axis, defined in body A frame, that body B's anchor point may slide along. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createRevoluteConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.RevoluteConstraint"],"help":"The constraint"},"help":"Connects two bodies at given offset points, letting them rotate relative to each other around this point.\\nThe pivot points are given in world (pixel) coordinates.","line":886,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"pivotA","type":["array"],"help":"The point relative to the center of mass of bodyA which bodyA is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"pivotB","type":["array"],"help":"The point relative to the center of mass of bodyB which bodyB is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].","optional":false,"default":null},{"name":"maxForce","type":["number"],"help":"The maximum force that should be applied to constrain the bodies.","optional":true,"default":"0"},{"name":"worldPivot","type":["Float32Array"],"help":"A pivot point given in world coordinates. If specified, localPivotA and localPivotB are automatically computed from this value.","optional":true,"default":"null"}],"inherited":false,"inheritedFrom":""},{"name":"createRotationalSpring","static":false,"returns":{"types":["Phaser.Physics.P2.RotationalSpring"],"help":"The spring"},"help":"Creates a rotational spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"restAngle","type":["number"],"help":"The relative angle of bodies at which the spring is at rest. If not given, it's set to the current relative angle between the bodies.","optional":true,"default":null},{"name":"stiffness","type":["number"],"help":"Stiffness of the spring. A number >= 0.","optional":true,"default":"100"},{"name":"damping","type":["number"],"help":"Damping of the spring. A number >= 0.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"createSpring","static":false,"returns":{"types":["Phaser.Physics.P2.Spring"],"help":"The spring"},"help":"Creates a linear spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.","line":1337,"public":true,"protected":false,"private":false,"parameters":[{"name":"bodyA","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"First connected body.","optional":false,"default":null},{"name":"bodyB","type":["Phaser.Sprite","Phaser.Physics.P2.Body","p2.Body"],"help":"Second connected body.","optional":false,"default":null},{"name":"restLength","type":["number"],"help":"Rest length of the spring. A number > 0.","optional":true,"default":"1"},{"name":"stiffness","type":["number"],"help":"Stiffness of the spring. A number >= 0.","optional":true,"default":"100"},{"name":"damping","type":["number"],"help":"Damping of the spring. A number >= 0.","optional":true,"default":"1"},{"name":"worldA","type":["array"],"help":"Where to hook the spring to body A in world coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"worldB","type":["array"],"help":"Where to hook the spring to body B in world coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"localA","type":["array"],"help":"Where to hook the spring to body A in local body coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].","optional":true,"default":null},{"name":"localB","type":["array"],"help":"Where to hook the spring to body B in local body coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clears all bodies from the simulation and unlinks World from Game. Should only be called on game shutdown. Call `clear` on a State change.","line":719,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"enable","static":false,"returns":null,"help":"This will create a P2 Physics body on the given game object or array of game objects.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.\\nNote: When the game object is enabled for P2 physics it has its anchor x\/y set to 0.5 so it becomes centered.","line":235,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array","Phaser.Group"],"help":"The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.","optional":false,"default":null},{"name":"debug","type":["boolean"],"help":"Create a debug object to go with this body?","optional":true,"default":"false"},{"name":"children","type":["boolean"],"help":"Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"enableBody","static":false,"returns":null,"help":"Creates a P2 Physics body on the given game object.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The game object to create the physics body on. A body will only be created if this object has a null `body` property.","optional":false,"default":null},{"name":"debug","type":["boolean"],"help":"Create a debug object to go with this body?","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"endContactHandler","static":false,"returns":null,"help":"Handles a p2 end contact event.","line":440,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBodies","static":false,"returns":{"types":["array Phaser.Physics.P2.Body"],"help":"An array containing all current Bodies in the world."},"help":"Populates and returns an array with references to of all current Bodies in the world.","line":1112,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getBody","static":false,"returns":{"types":["p2.Body"],"help":"The p2.Body, or null if not found."},"help":"Checks the given object to see if it has a p2.Body and if so returns it.","line":1133,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The object to check for a p2.Body on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getConstraints","static":false,"returns":{"types":["array Phaser.Physics.P2.Constraint"],"help":"An array containing all current Constraints in the world."},"help":"Populates and returns an array of all current Constraints in the world.","line":1181,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getContactMaterial","static":false,"returns":{"types":["Phaser.Physics.P2.ContactMaterial","boolean"],"help":"The Contact Material or false if none was found matching the Materials given."},"help":"Gets a Contact Material based on the two given Materials.","line":1035,"public":true,"protected":false,"private":false,"parameters":[{"name":"materialA","type":["Phaser.Physics.P2.Material"],"help":"The first Material to search for.","optional":false,"default":null},{"name":"materialB","type":["Phaser.Physics.P2.Material"],"help":"The second Material to search for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSprings","static":false,"returns":{"types":["array Phaser.Physics.P2.Spring"],"help":"An array containing all current Springs in the world."},"help":"Populates and returns an array of all current Springs in the world.","line":1161,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"hitTest","static":false,"returns":{"types":["array"],"help":"Array of bodies that overlap the point."},"help":"Test if a world point overlaps bodies. You will get an array of actual P2 bodies back. You can find out which Sprite a Body belongs to\\n(if any) by checking the Body.parent.sprite property. Body.parent is a Phaser.Physics.P2.Body property.","line":1206,"public":true,"protected":false,"private":false,"parameters":[{"name":"worldPoint","type":["Phaser.Point"],"help":"Point to use for intersection tests. The points values must be in world (pixel) coordinates.","optional":false,"default":null},{"name":"bodies","type":["array Phaser.Physics.P2.Bod","Phaser.Sprite","p2.Body>"],"help":"A list of objects to check for intersection. If not given it will check Phaser.Physics.P2.world.bodies (i.e. all world bodies)","optional":true,"default":null},{"name":"precision","type":["number"],"help":"Used for matching against particles and lines. Adds some margin to these infinitesimal objects.","optional":true,"default":"5"},{"name":"filterStatic","type":["boolean"],"help":"If true all Static objects will be removed from the results array.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"mpx","static":false,"returns":{"types":["number"],"help":"The scaled value."},"help":"Convert p2 physics value (meters) to pixel scale.\\nBy default Phaser uses a scale of 20px per meter.\\nIf you need to modify this you can over-ride these functions via the Physics Configuration object.","line":1624,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["number"],"help":"The value to convert.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mpxi","static":false,"returns":{"types":["number"],"help":"The scaled value."},"help":"Convert p2 physics value (meters) to pixel scale and inverses it.\\nBy default Phaser uses a scale of 20px per meter.\\nIf you need to modify this you can over-ride these functions via the Physics Configuration object.","line":1654,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["number"],"help":"The value to convert.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pause","static":false,"returns":null,"help":"Pauses the P2 World independent of the game pause state.","line":650,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Called at the start of the core update loop. Purges flagged bodies from the world.","line":212,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pxm","static":false,"returns":{"types":["number"],"help":"The scaled value."},"help":"Convert pixel value to p2 physics scale (meters).\\nBy default Phaser uses a scale of 20px per meter.\\nIf you need to modify this you can over-ride these functions via the Physics Configuration object.","line":1639,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["number"],"help":"The value to convert.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pxmi","static":false,"returns":{"types":["number"],"help":"The scaled value."},"help":"Convert pixel value to p2 physics scale (meters) and inverses it.\\nBy default Phaser uses a scale of 20px per meter.\\nIf you need to modify this you can over-ride these functions via the Physics Configuration object.","line":1669,"public":true,"protected":false,"private":false,"parameters":[{"name":"v","type":["number"],"help":"The value to convert.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBody","static":false,"returns":{"types":["Phaser.Physics.P2.Body"],"help":"The Body that was removed."},"help":"Removes a body from the world. This will silently fail if the body wasn't part of the world to begin with.","line":758,"public":true,"protected":false,"private":false,"parameters":[{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"The Body to remove from the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBodyNextStep","static":false,"returns":null,"help":"This will add a P2 Physics body into the removal list for the next step.","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"body","type":["Phaser.Physics.P2.Body"],"help":"The body to remove at the start of the next step.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeConstraint","static":false,"returns":{"types":["Phaser.Physics.P2.Constraint"],"help":"The Constraint that was removed."},"help":"Removes a Constraint from the world.","line":983,"public":true,"protected":false,"private":false,"parameters":[{"name":"constraint","type":["Phaser.Physics.P2.Constraint"],"help":"The Constraint to be removed from the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeContactMaterial","static":false,"returns":{"types":["Phaser.Physics.P2.ContactMaterial"],"help":"The Contact Material that was removed."},"help":"Removes a Contact Material from the world.","line":1017,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["Phaser.Physics.P2.ContactMaterial"],"help":"The Contact Material to be removed from the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeSpring","static":false,"returns":{"types":["Phaser.Physics.P2.Spring"],"help":"The Spring that was removed."},"help":"Removes a Spring from the world.","line":802,"public":true,"protected":false,"private":false,"parameters":[{"name":"spring","type":["Phaser.Physics.P2.Spring"],"help":"The Spring to remove from the World.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resume","static":false,"returns":null,"help":"Resumes a paused P2 World.","line":661,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setBounds","static":false,"returns":null,"help":"Sets the bounds of the Physics world to match the given world pixel dimensions.\\nYou can optionally set which 'walls' to create: left, right, top or bottom.","line":563,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the top-left corner of the bounds.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the top-left corner of the bounds.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the bounds.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the bounds.","optional":false,"default":null},{"name":"left","type":["boolean"],"help":"If true will create the left bounds wall.","optional":true,"default":"true"},{"name":"right","type":["boolean"],"help":"If true will create the right bounds wall.","optional":true,"default":"true"},{"name":"top","type":["boolean"],"help":"If true will create the top bounds wall.","optional":true,"default":"true"},{"name":"bottom","type":["boolean"],"help":"If true will create the bottom bounds wall.","optional":true,"default":"true"},{"name":"setCollisionGroup","type":["boolean"],"help":"If true the Bounds will be set to use its own Collision Group.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setBoundsToWorld","static":false,"returns":null,"help":"Sets the bounds of the Physics world to match the Game.World dimensions.\\nYou can optionally set which 'walls' to create: left, right, top or bottom.","line":467,"public":true,"protected":false,"private":false,"parameters":[{"name":"left","type":["boolean"],"help":"If true will create the left bounds wall.","optional":true,"default":"true"},{"name":"right","type":["boolean"],"help":"If true will create the right bounds wall.","optional":true,"default":"true"},{"name":"top","type":["boolean"],"help":"If true will create the top bounds wall.","optional":true,"default":"true"},{"name":"bottom","type":["boolean"],"help":"If true will create the bottom bounds wall.","optional":true,"default":"true"},{"name":"setCollisionGroup","type":["boolean"],"help":"If true the Bounds will be set to use its own Collision Group.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionGroup","static":false,"returns":null,"help":"Sets the given CollisionGroup to be the collision group for all shapes in this Body, unless a shape is specified.\\nNote that this resets the collisionMask and any previously set groups. See Body.collides() for appending them.","line":1303,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["Phaser.Group","Phaser.Sprite"],"help":"A Sprite or Group to apply the Collision Group to. If a Group is given it will be applied to all top-level children.","optional":false,"default":null},{"name":"group","type":["Phaser.Physics.CollisionGroup"],"help":"The Collision Group that this Bodies shapes will use.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setImpactEvents","static":false,"returns":null,"help":"Impact event handling is disabled by default. Enable it before any impact events will be dispatched.\\nIn a busy world hundreds of impact events can be generated every step, so only enable this if you cannot do what you need via beginContact or collision masks.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"Set to true to enable impact events, or false to disable.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMaterial","static":false,"returns":null,"help":"Sets the given Material against all Shapes owned by all the Bodies in the given array.","line":1048,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["Phaser.Physics.P2.Material"],"help":"The Material to be applied to the given Bodies.","optional":false,"default":null},{"name":"bodies","type":["array Phaser.Physics.P2.Body"],"help":"An Array of Body objects that the given Material will be set on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setPostBroadphaseCallback","static":false,"returns":null,"help":"Sets a callback to be fired after the Broadphase has collected collision pairs in the world.\\nJust because a pair exists it doesn't mean they *will* collide, just that they potentially could do.\\nIf your calback returns `false` the pair will be removed from the narrowphase. This will stop them testing for collision this step.\\nReturning `true` from the callback will ensure they are checked in the narrowphase.","line":333,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback that will receive the postBroadphase event data. It must return a boolean. Set to null to disable an existing callback.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The context under which the callback will be fired.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setWorldMaterial","static":false,"returns":null,"help":"Sets the given material against the 4 bounds of this World.","line":483,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["Phaser.Physics.P2.Material"],"help":"The material to set.","optional":false,"default":null},{"name":"left","type":["boolean"],"help":"If true will set the material on the left bounds wall.","optional":true,"default":"true"},{"name":"right","type":["boolean"],"help":"If true will set the material on the right bounds wall.","optional":true,"default":"true"},{"name":"top","type":["boolean"],"help":"If true will set the material on the top bounds wall.","optional":true,"default":"true"},{"name":"bottom","type":["boolean"],"help":"If true will set the material on the bottom bounds wall.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"toJSON","static":false,"returns":{"types":["object"],"help":"A JSON representation of the world."},"help":"Converts the current world into a JSON object.","line":1243,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Internal P2 update loop.","line":672,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateBoundsCollisionGroup","static":false,"returns":null,"help":"By default the World will be set to collide everything with everything. The bounds of the world is a Body with 4 shapes, one for each face.\\nIf you start to use your own collision groups then your objects will no longer collide with the bounds.\\nTo fix this you need to adjust the bounds to use its own collision group first BEFORE changing your Sprites collision group.","line":520,"public":true,"protected":false,"private":false,"parameters":[{"name":"setCollisionGroup","type":["boolean"],"help":"If true the Bounds will be set to use its own Collision Group.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"impactHandler","static":false,"returns":null,"help":"Handles a p2 impact event.","line":380,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["object"],"help":"The event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"postBroadphaseHandler","static":false,"returns":null,"help":"Internal handler for the postBroadphase event.","line":356,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["object"],"help":"The event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"applyDamping","type":["boolean"],"help":"","inlineHelp":"Enable to automatically apply body damping each step.","line":1761,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"applyGravity","type":["boolean"],"help":"","inlineHelp":"Enable to automatically apply gravity each step.","line":1781,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"applySpringForces","type":["boolean"],"help":"","inlineHelp":"Enable to automatically apply spring forces each step.","line":1741,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsCollidesWith","type":["array"],"help":"","inlineHelp":"An array of the bodies the world bounds collides with.","line":174,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsCollisionGroup","type":["Phaser.Physics.P2.CollisionGroup"],"help":"","inlineHelp":"A default collision group.","line":164,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which the callbacks are fired.","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collisionGroups","type":["array"],"help":"","inlineHelp":"An array containing the collision groups that have been defined in the World.","line":154,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"contactMaterial","type":["p2.ContactMaterial"],"help":"","inlineHelp":"The default Contact Material being used by the World.","line":1721,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"emitImpactEvent","type":["boolean"],"help":"","inlineHelp":"Set to true if you want to the world to emit the \"impact\" event. Turning this off could improve performance.","line":1836,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"everythingCollisionGroup","type":["Phaser.Physics.P2.CollisionGroup"],"help":"","inlineHelp":"A default collision group.","line":169,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameRate","type":["number"],"help":"","inlineHelp":"The frame rate the world will be stepped at. Defaults to 1 \/ 60, but you can change here. Also see useElapsedTime property.","line":48,"default":"1 \/ 60","public":true,"protected":false,"private":false,"readOnly":false},{"name":"friction","type":["number"],"help":"","inlineHelp":"Friction between colliding bodies. This value is used if no matching ContactMaterial is found for a Material pair.","line":1681,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gravity","type":["Phaser.Physics.P2.InversePointProxy"],"help":"","inlineHelp":"The gravity applied to all bodies each step.","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"nothingCollisionGroup","type":["Phaser.Physics.P2.CollisionGroup"],"help":"","inlineHelp":"A default collision group.","line":159,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onBeginContact","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a first contact is created between two bodies. This event is fired before the step has been done.","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onBodyAdded","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a new Body is added to the World.","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onBodyRemoved","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a Body is removed from the World.","line":86,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onConstraintAdded","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a new Constraint is added to the World.","line":101,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onConstraintRemoved","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a Constraint is removed from the World.","line":106,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onContactMaterialAdded","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a new ContactMaterial is added to the World.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onContactMaterialRemoved","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a ContactMaterial is removed from the World.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onEndContact","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when final contact occurs between two bodies. This event is fired before the step has been done.","line":136,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onSpringAdded","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a new Spring is added to the World.","line":91,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onSpringRemoved","type":["Phaser.Signal"],"help":"","inlineHelp":"Dispatched when a Spring is removed from the World.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"","inlineHelp":"The paused state of the P2 World.","line":60,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"postBroadphaseCallback","type":["function"],"help":"","inlineHelp":"A postBroadphase callback.","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"restitution","type":["number"],"help":"","inlineHelp":"Default coefficient of restitution between colliding bodies. This value is used if no matching ContactMaterial is found for a Material pair.","line":1701,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sleepMode","type":["number"],"help":"How to deactivate bodies during simulation. Possible modes are: World.NO_SLEEPING, World.BODY_SLEEPING and World.ISLAND_SLEEPING.\\nIf sleeping is enabled, you might need to wake up the bodies if they fall asleep when they shouldn't. If you want to enable sleeping in the world, but want to disable it for a particular body, see Body.allowSleep.","inlineHelp":"","line":1858,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"solveConstraints","type":["boolean"],"help":"","inlineHelp":"Enable\/disable constraint solving in each step.","line":1801,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"time","type":["boolean"],"help":"","inlineHelp":"The World time.","line":1822,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of bodies in the world.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"useElapsedTime","type":["boolean"],"help":"","inlineHelp":"If true the frameRate value will be ignored and instead p2 will step with the value of Game.Time.physicsElapsed, which is a delta time value.","line":54,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"walls","type":["object"],"help":"","inlineHelp":"An object containing the 4 wall bodies that bound the physics world.","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"config","type":["object"],"help":"","inlineHelp":"The p2 World configuration object.","line":36,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"materials","type":["array Phaser.Physics.P2.Material"],"help":"","inlineHelp":"A local array of all created Materials.","line":66,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"world","type":["p2.World"],"help":"","inlineHelp":"The p2 World in which the simulation is run.","line":42,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_collisionGroupID","type":["number"],"help":"","inlineHelp":"Internal var.","line":186,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_toRemove","type":["array"],"help":"","inlineHelp":"Internal var used to hold references to bodies to remove from the world on the next step.","line":180,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Physics.json b/docgen/output/Phaser.Physics.json deleted file mode 100644 index 1570a5f40..000000000 --- a/docgen/output/Phaser.Physics.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Physics","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"physicsConfig","type":["object"],"help":"A physics configuration object to pass to the Physics world on creation.","optional":true,"default":"null"}],"help":"The Physics Manager is responsible for looking after all of the running physics systems.\\nPhaser supports 3 physics systems: Arcade Physics, P2 and Ninja Physics (with Box2D and Chipmunk in development)\\nGame Objects can belong to only 1 physics system, but you can have multiple systems active in a single game.\\n\\nFor example you could have P2 managing a polygon-built terrain landscape that an vehicle drives over, while it could be firing bullets that use the\\nfaster (due to being much simpler) Arcade Physics system."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys all active physics systems. Usually only called on a Game Shutdown, not on a State swap.","line":304,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"enable","static":false,"returns":null,"help":"This will create a default physics body on the given game object or array of objects.\\nA game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.\\nIt can be for any of the physics systems that have been started:\\n\\nPhaser.Physics.Arcade - A light weight AABB based collision system with basic separation.\\nPhaser.Physics.P2JS - A full-body advanced physics system supporting multiple object shapes, polygon loading, contact materials, springs and constraints.\\nPhaser.Physics.NINJA - A port of Metanet Softwares N+ physics system. Advanced AABB and Circle vs. Tile collision.\\nPhaser.Physics.BOX2D - A port of https:\/\/code.google.com\/p\/box2d-html5\\nPhaser.Physics.CHIPMUNK is still in development.\\n\\nIf you require more control over what type of body is created, for example to create a Ninja Physics Circle instead of the default AABB, then see the\\nindividual physics systems `enable` methods instead of using this generic one.","line":181,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object","array"],"help":"The game object to create the physics body on. Can also be an array of objects, a body will be created on every object in the array.","optional":false,"default":null},{"name":"system","type":["number"],"help":"The physics system that will be used to create the body. Defaults to Arcade Physics.","optional":true,"default":"Phaser.Physics.ARCADE"},{"name":"debug","type":["boolean"],"help":"Enable the debug drawing for this body. Defaults to false.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"parseConfig","static":false,"returns":null,"help":"Parses the Physics Configuration object passed to the Game constructor and starts any physics systems specified within.","line":100,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"startSystem","static":false,"returns":null,"help":"This will create an instance of the requested physics simulation.\\nPhaser.Physics.Arcade is running by default, but all others need activating directly.\\nYou can start the following physics systems:\\nPhaser.Physics.P2JS - A full-body advanced physics system by Stefan Hedman.\\nPhaser.Physics.NINJA - A port of Metanet Softwares N+ physics system.\\nPhaser.Physics.BOX2D and Phaser.Physics.CHIPMUNK are still in development.","line":137,"public":true,"protected":false,"private":false,"parameters":[{"name":"The","type":["number"],"help":" physics system to start.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"clear","static":false,"returns":null,"help":"Clears down all active physics systems. This doesn't destroy them, it just clears them of objects and is called when the State changes.","line":285,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"preUpdate checks.","line":211,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setBoundsToWorld","static":false,"returns":null,"help":"Updates the physics bounds to match the world dimensions.","line":255,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates all running physics systems.","line":233,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"arcade","type":["Phaser.Physics.Arcade"],"help":"","inlineHelp":"The Arcade Physics system.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"box2d","type":["Phaser.Physics.Box2D"],"help":"","inlineHelp":"The Box2D Physics system (to be done).","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"chipmunk","type":["Phaser.Physics.Chipmunk"],"help":"","inlineHelp":"The Chipmunk Physics system (to be done).","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"config","type":["object"],"help":"","inlineHelp":"The physics configuration object as passed to the game on creation.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ninja","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"The N+ Ninja Physics System.","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"p2","type":["Phaser.Physics.P2"],"help":"","inlineHelp":"The P2.JS Physics system.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Plugin.json b/docgen/output/Phaser.Plugin.json deleted file mode 100644 index 6151f682d..000000000 --- a/docgen/output/Phaser.Plugin.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Plugin","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"parent","type":["any"],"help":"The object that owns this plugin, usually Phaser.PluginManager.","optional":false,"default":null}],"help":"This is a base Plugin template to use for any Phaser plugin development."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Clear down this Plugin and null out references","line":111,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postRender","static":false,"returns":null,"help":"Post-render is called after the Game Renderer and State.render have run.\\nIt is only called if visible is set to true.","line":104,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).\\nIt is only called if active is set to true.","line":80,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render is called right after the Game Renderer completes, but before the State.render.\\nIt is only called if visible is set to true.","line":96,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.\\nIt is only called if active is set to true.","line":88,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"","inlineHelp":"A Plugin with active=true has its preUpdate and update methods called by the parent, otherwise they are skipped.","line":33,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPostRender","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a postRender method.","line":69,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPostUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a postUpdate method.","line":57,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPreUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a preUpdate method.","line":45,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasRender","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a render method.","line":63,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has an update method.","line":51,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["any"],"help":"","inlineHelp":"The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"A Plugin with visible=true has its render and postRender methods called by the parent, otherwise they are skipped.","line":39,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.PluginManager.json b/docgen/output/Phaser.PluginManager.json deleted file mode 100644 index ca36b2f5e..000000000 --- a/docgen/output/Phaser.PluginManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.PluginManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Plugin"],"help":"The Plugin that was added to the manager."},"help":"Add a new Plugin into the PluginManager.\\nThe Plugin must have 2 properties: game and parent. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.","line":53,"public":true,"protected":false,"private":false,"parameters":[{"name":"plugin","type":["object","Phaser.Plugin"],"help":"The Plugin to add into the PluginManager. This can be a function or an existing object.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the Plugin.init method.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clear down this PluginManager, calls destroy on every plugin and nulls out references.","line":277,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postRender","static":false,"returns":null,"help":"Post-render is called after the Game Renderer and State.render have run.\\nIt only calls plugins who have visible=true.","line":258,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"PostUpdate is the last thing to be called before the world render.\\nIn particular, it is called after the world postUpdate, which means the camera has been adjusted.\\nIt only calls plugins who have active=true.","line":218,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).\\nIt only calls plugins who have active=true.","line":177,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Remove a Plugin from the PluginManager. It calls Plugin.destroy on the plugin before removing it from the manager.","line":135,"public":true,"protected":false,"private":false,"parameters":[{"name":"plugin","type":["Phaser.Plugin"],"help":"The plugin to be removed.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all Plugins from the PluginManager. It calls Plugin.destroy on every plugin before removing it from the manager.","line":157,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render is called right after the Game Renderer completes, but before the State.render.\\nIt only calls plugins who have visible=true.","line":238,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.\\nIt only calls plugins who have active=true.","line":197,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"plugins","type":["array"],"help":"","inlineHelp":"An array of all the plugins being managed by this PluginManager.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_i","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_len","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":32,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Point.json b/docgen/output/Phaser.Point.json deleted file mode 100644 index 00ab94338..000000000 --- a/docgen/output/Phaser.Point.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Point","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The horizontal position of this Point.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The vertical position of this Point.","optional":true,"default":"0"}],"help":"A Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.\\nThe following code creates a point at (0,0):\\n`var myPoint = new Phaser.Point();`\\nYou can also use them as 2D Vectors and you'll find different vector related methods in this class."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Adds the coordinates of two points together to create a new point.","line":483,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angle","static":false,"returns":{"types":["number"],"help":"The angle between the two Points."},"help":"Returns the angle between two Point objects.","line":576,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"angleSq","static":false,"returns":{"types":["number"],"help":"The angle squared between the two Points."},"help":"Returns the angle squared between two Point objects.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"centroid","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Calculates centroid (or midpoint) from an array of points. If only one point is provided, that point is returned.","line":834,"public":true,"protected":false,"private":false,"parameters":[{"name":"points","type":["array Phaser.Point"],"help":"The array of one or more points.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clamp","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Clamps this Point object values to be between the given min and max.","line":202,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value to clamp this Point to.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value to clamp this Point to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clampX","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Clamps the x value of this Point to be between the given min and max.","line":172,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value to clamp this Point to.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value to clamp this Point to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clampY","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Clamps the y value of this Point to be between the given min and max","line":187,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value to clamp this Point to.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value to clamp this Point to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clone","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Creates a copy of the given Point.","line":217,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Point"],"help":" Optional Point object. If given the values will be set into this object, otherwise a brand new Point object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyFrom","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Copies the x and y properties from any given object to this Point.","line":44,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyTo","static":false,"returns":{"types":["object"],"help":"The dest object."},"help":"Copies the x and y properties from this Point to any given object.","line":239,"public":true,"protected":false,"private":false,"parameters":[{"name":"dest","type":["any"],"help":"The object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"cross","static":false,"returns":{"types":["number"],"help":"The result."},"help":"The cross product of this and another Point object.","line":416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object to get the cross product combined with this Point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"distance","static":false,"returns":{"types":["number"],"help":"The distance between this Point object and the destination Point object."},"help":"Returns the distance of this Point object to the given object (can be a Circle, Point or anything with x\/y properties).","line":690,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The target object. Must have visible x and y properties that represent the center of the object.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The target object. Must have visible x and y properties that represent the center of the object.","optional":false,"default":null},{"name":"round","type":["boolean"],"help":"Round the distance to the nearest integer (default false).","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"divide","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Divides the coordinates of two points to create a new point.","line":543,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"dot","static":false,"returns":{"types":["number"],"help":"The result."},"help":"The dot product of this and another Point object.","line":403,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object to get the dot product combined with this Point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"equals","static":false,"returns":{"types":["boolean"],"help":"A value of true if the Points are equal, otherwise false."},"help":"Determines whether the two given Point objects are equal. They are considered equal if they have the same x and y values.","line":562,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getMagnitude","static":false,"returns":{"types":["number"],"help":"The length of the Point."},"help":"Calculates the length of the Point object.","line":334,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getMagnitudeSq","static":false,"returns":{"types":["number"],"help":"The length ^ 2 of the Point."},"help":"Calculates the length squared of the Point object.","line":346,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"interpolate","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Interpolates the two given Points, based on the `f` value (between 0 and 1) and returns a new Point.","line":641,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"f","type":["number"],"help":"The level of interpolation between the two points. Indicates where the new point will be, along the line between pt1 and pt2. If f=1, pt1 is returned; if f=0, pt2 is returned.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"invert","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Inverts the x and y values of this Point","line":56,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isZero","static":false,"returns":{"types":["boolean"],"help":"True if this Point is 0,0, otherwise false."},"help":"Determine if this point is at 0,0.","line":390,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"multiply","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Multiplies the coordinates of two points to create a new point.","line":523,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"multiplyAdd","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Adds two 2D Points together and multiplies the result by the given scalar.","line":623,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"s","type":["number"],"help":"The scaling value.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"negative","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Creates a negative Point.","line":605,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normalRightHand","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Right-hand normalize (make unit length) a Point.","line":761,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normalize","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Normalize (make unit length) a Point.","line":777,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"parse","static":true,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Parses an object for x and\/or y properties and returns a new Phaser.Point with matching values.\\nIf the object doesn't contain those properties a Point with x\/y of zero will be returned.","line":878,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to parse.","optional":false,"default":null},{"name":"xProp","type":["string"],"help":"The property used to set the Point.x value.","optional":true,"default":"'x'"},{"name":"yProp","type":["string"],"help":"The property used to set the Point.y value.","optional":true,"default":"'y'"}],"inherited":false,"inheritedFrom":""},{"name":"perp","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Return a perpendicular vector (90 degrees rotation)","line":657,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"project","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Project two Points onto another Point.","line":714,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projectUnit","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Project two Points onto a Point of unit length.","line":738,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rotate","static":false,"returns":{"types":["Phaser.Point"],"help":"The modified point object."},"help":"Rotates a Point around the x\/y coordinates given to the desired angle.","line":804,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object to rotate.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the anchor point","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the anchor point","optional":false,"default":null},{"name":"angle","type":["number"],"help":"The angle in radians (unless asDegrees is true) to rotate the Point to.","optional":false,"default":null},{"name":"asDegrees","type":["boolean"],"help":"Is the given rotation in radians (false) or degrees (true)?","optional":true,"default":"false"},{"name":"distance","type":["number"],"help":"An optional distance constraint between the Point and the anchor.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rperp","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Return a perpendicular vector (-90 degrees rotation)","line":673,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"set","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object. Useful for chaining method calls."},"help":"Sets the `x` and `y` values of this Point object to the given values.\\nIf you omit the `y` value then the `x` value will be applied to both, for example:\\n`Point.setTo(2)` is the same as `Point.setTo(2, 2)`","line":91,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The horizontal value of this point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The vertical value of this point. If not given the x value will be used in its place.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMagnitude","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object."},"help":"Alters the length of the Point without changing the direction.","line":359,"public":true,"protected":false,"private":false,"parameters":[{"name":"magnitude","type":["number"],"help":"The desired magnitude of the resulting Point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Point"],"help":"This Point object. Useful for chaining method calls."},"help":"Sets the `x` and `y` values of this Point object to the given values.\\nIf you omit the `y` value then the `x` value will be applied to both, for example:\\n`Point.setTo(2)` is the same as `Point.setTo(2, 2)`","line":72,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The horizontal value of this point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The vertical value of this point. If not given the x value will be used in its place.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"subtract","static":false,"returns":{"types":["Phaser.Point"],"help":"The new Point object."},"help":"Subtracts the coordinates of two points to create a new point.","line":503,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Point"],"help":"The first Point object.","optional":false,"default":null},{"name":"b","type":["Phaser.Point"],"help":"The second Point object.","optional":false,"default":null},{"name":"out","type":["Phaser.Point"],"help":"Optional Point to store the value in, if not supplied a new Point object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"A string representation of the instance."},"help":"Returns a string representation of this object.","line":464,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"x","type":["number"],"help":"","inlineHelp":"The x value of the point.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y value of the point.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Pointer.json b/docgen/output/Phaser.Pointer.json deleted file mode 100644 index ee27eb5d8..000000000 --- a/docgen/output/Phaser.Pointer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Pointer","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"id","type":["number"],"help":"The ID of the Pointer object within the game. Each game can have up to 10 active pointers.","optional":false,"default":null}],"help":"A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen."},"consts":[],"methods":{"public":[{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"true if the Pointer was pressed down within the duration given."},"help":"The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate.\\nNote that calling justPressed doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.\\nIf you wish to check if the Pointer was pressed down just once then see the Sprite.events.onInputDown event.","line":648,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time to check against. If none given it will use InputManager.justPressedRate.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":"true if the Pointer was released within the duration given."},"help":"The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate.\\nNote that calling justReleased doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.\\nIf you wish to check if the Pointer was released just once then see the Sprite.events.onInputUp event.","line":664,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time to check against. If none given it will use InputManager.justReleasedRate.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"leave","static":false,"returns":null,"help":"Called when the Pointer leaves the target area.","line":567,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passed up from the input handler.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"move","static":false,"returns":null,"help":"Called when the Pointer is moved.","line":375,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passed up from the input handler.","optional":false,"default":null},{"name":"fromClick","type":["boolean"],"help":"Was this called from the click event?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the Pointer properties. Called by InputManager.reset when you perform a State change.","line":676,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resetMovement","static":false,"returns":null,"help":"Resets the movementX and movementY properties. Use in your update handler after retrieving the values.","line":706,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Called when the Pointer is pressed onto the touchscreen.","line":261,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["any"],"help":"The DOM event from the browser.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Called when the Pointer leaves the touchscreen.","line":580,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passed up from the input handler.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Called by the Input Manager.","line":324,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"processInteractiveObjects","static":false,"returns":{"types":["boolean"],"help":"True if this method processes an object (i.e. a Sprite becomes the Pointers currentTarget), otherwise false."},"help":"Process all interactive objects to find out which ones were updated in the recent Pointer move.","line":464,"public":false,"protected":true,"private":false,"parameters":[{"name":"fromClick","type":["boolean"],"help":"Was this called from the click event?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"","inlineHelp":"An active pointer is one that is currently pressed down on the display. A Mouse is always active.","line":217,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"button","type":["any"],"help":"","inlineHelp":"The button property of the Pointer as set by the DOM event when this Pointer is started.","line":61,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"circle","type":["Phaser.Circle"],"help":"A Phaser.Circle that is centered on the x\/y coordinates of this pointer, useful for hit detection.\\nThe Circle size is 44px (Apples recommended \"finger tip\" size).","inlineHelp":"","line":245,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clientX","type":["number"],"help":"","inlineHelp":"The horizontal coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clientY","type":["number"],"help":"","inlineHelp":"The vertical coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).","line":101,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"A dirty pointer needs to re-poll any interactive objects it may have been over, regardless if it has moved or not.","line":223,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"duration","type":["number"],"help":"Gets the Y value of this Pointer in world coordinates based on the world camera.","inlineHelp":"The Y value of this Pointer in world coordinates based on the world camera.","line":760,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"A Pointer object that exists is allowed to be checked for physics collisions and overlaps.","line":37,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"id","type":["number"],"help":"","inlineHelp":"The ID of the Pointer object within the game. Each game can have up to 10 active pointers.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"identifier","type":["number"],"help":"","inlineHelp":"The identifier property of the Pointer as set by the DOM event when this Pointer is started.","line":43,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isDown","type":["boolean"],"help":"","inlineHelp":"If the Pointer is touching the touchscreen, or the mouse button is held down, isDown is set to true.","line":169,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isMouse","type":["boolean"],"help":"","inlineHelp":"If the Pointer is a mouse this is true, otherwise false.","line":163,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isUp","type":["boolean"],"help":"","inlineHelp":"If the Pointer is not touching the touchscreen, or the mouse button is up, isUp is set to true.","line":175,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"movementX","type":["number"],"help":"","inlineHelp":"The horizontal processed relative movement of the Pointer in pixels since last event.","line":139,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"movementY","type":["number"],"help":"","inlineHelp":"The vertical processed relative movement of the Pointer in pixels since last event.","line":145,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"msSinceLastClick","type":["number"],"help":"","inlineHelp":"The number of milliseconds since the last click or touch event.","line":205,"default":"Number.MAX_VALUE","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pageX","type":["number"],"help":"","inlineHelp":"The horizontal coordinate of the Pointer relative to whole document.","line":106,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pageY","type":["number"],"help":"","inlineHelp":"The vertical coordinate of the Pointer relative to whole document.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointerId","type":["number"],"help":"","inlineHelp":"The pointerId property of the Pointer as set by the DOM event when this Pointer is started. The browser can and will recycle this value.","line":49,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"A Phaser.Point object containing the current x\/y values of the pointer on the display.","line":228,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"positionDown","type":["Phaser.Point"],"help":"","inlineHelp":"A Phaser.Point object containing the x\/y values of the pointer when it was last in a down state on the display.","line":233,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"positionUp","type":["Phaser.Point"],"help":"","inlineHelp":"A Phaser.Point object containing the x\/y values of the pointer when it was last released.","line":238,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"previousTapTime","type":["number"],"help":"","inlineHelp":"A timestamp representing when the Pointer was last tapped or clicked.","line":193,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rawMovementX","type":["number"],"help":"","inlineHelp":"The horizontal raw relative movement of the Pointer in pixels since last event.","line":127,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rawMovementY","type":["number"],"help":"","inlineHelp":"The vertical raw relative movement of the Pointer in pixels since last event.","line":133,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"screenX","type":["number"],"help":"","inlineHelp":"The horizontal coordinate of the Pointer relative to the screen.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"screenY","type":["number"],"help":"","inlineHelp":"The vertical coordinate of the Pointer relative to the screen.","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"target","type":["any"],"help":"","inlineHelp":"The target property of the Pointer as set by the DOM event when this Pointer is started.","line":55,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"targetObject","type":["any"],"help":"","inlineHelp":"The Game Object this Pointer is currently over \/ touching \/ dragging.","line":211,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeDown","type":["number"],"help":"","inlineHelp":"A timestamp representing when the Pointer first touched the touchscreen.","line":181,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeUp","type":["number"],"help":"","inlineHelp":"A timestamp representing when the Pointer left the touchscreen.","line":187,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"totalTouches","type":["number"],"help":"","inlineHelp":"The total number of times this Pointer has been touched to the touchscreen.","line":199,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"withinGame","type":["boolean"],"help":"","inlineHelp":"true if the Pointer is over the game canvas, otherwise false.","line":91,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The horizontal coordinate of the Pointer. This value is automatically scaled based on the game scale.","line":151,"default":"-1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The vertical coordinate of the Pointer. This value is automatically scaled based on the game scale.","line":157,"default":"-1","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_history","type":["array"],"help":"","inlineHelp":"Local private variable storing the short-term history of pointer movements.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_holdSent","type":["boolean"],"help":"","inlineHelp":"Local private variable to store the status of dispatching a hold event.","line":68,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_nextDrop","type":["number"],"help":"","inlineHelp":"Local private variable storing the time at which the next history drop should occur.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_stateReset","type":["boolean"],"help":"","inlineHelp":"Monitor events outside of a state reset loop.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Polygon.json b/docgen/output/Phaser.Polygon.json deleted file mode 100644 index ef2c917cc..000000000 --- a/docgen/output/Phaser.Polygon.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Polygon","extends":"","static":false,"constructor":true,"parameters":[{"name":"points","type":["array Phaser.Point","array number"],"help":"The array of Points.","optional":false,"default":null}],"help":"Creates a new Polygon. You have to provide a list of points.\\nThis can be an array of Points that form the polygon, a flat array of numbers that will be interpreted as [x,y, x,y, ...],\\nor the arguments passed can be all the points of the polygon e.g. `new Phaser.Polygon(new Phaser.Point(), new Phaser.Point(), ...)`, or the\\narguments passed can be flat x,y values e.g. `new Phaser.Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are numbers."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Polygon"],"help":"The new Polygon object."},"help":"Creates a copy of the given Polygon.\\nThis is a deep clone, the resulting copy contains new Phaser.Point objects","line":40,"public":true,"protected":false,"private":false,"parameters":[{"name":"output","type":["Phaser.Polygon"],"help":" Optional Polygon object. If given the values will be set into this object, otherwise a brand new Polygon object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this polygon, otherwise false."},"help":"Checks whether the x and y coordinates are contained within this polygon.","line":70,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X value of the coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y value of the coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"type","type":["number"],"help":"","inlineHelp":"The base object type.","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.QuadTree.json b/docgen/output/Phaser.QuadTree.json deleted file mode 100644 index aa1db9617..000000000 --- a/docgen/output/Phaser.QuadTree.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.QuadTree","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The top left coordinate of the quadtree.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The top left coordinate of the quadtree.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the quadtree in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the quadtree in pixels.","optional":false,"default":null},{"name":"maxObjects","type":["number"],"help":"The maximum number of objects per node.","optional":true,"default":"10"},{"name":"maxLevels","type":["number"],"help":"The maximum number of levels to iterate to.","optional":true,"default":"4"},{"name":"level","type":["number"],"help":"Which level is this?","optional":true,"default":"0"}],"help":"A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.\\nHowever I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.\\nOriginal version at https:\/\/github.com\/timohausmann\/quadtree-js\/"},"consts":[],"methods":{"public":[{"name":"clear","static":false,"returns":null,"help":"Clear the quadtree.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"index - Index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node."},"help":"Determine which node the object belongs to.","line":210,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle","object"],"help":"The bounds in which to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"insert","static":false,"returns":null,"help":"Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.","line":157,"public":true,"protected":false,"private":false,"parameters":[{"name":"body","type":["Phaser.Physics.Arcade.Body","object"],"help":"The Body object to insert into the quadtree. Can be any object so long as it exposes x, y, right and bottom properties.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"populate","static":false,"returns":null,"help":"Populates this quadtree with the children of the given Group. In order to be added the child must exist and have a body property.","line":109,"public":true,"protected":false,"private":false,"parameters":[{"name":"group","type":["Phaser.Group"],"help":"The Group to add to the quadtree.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"populateHandler","static":false,"returns":null,"help":"Handler for the populate method.","line":121,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","object"],"help":"The Sprite to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the QuadTree.","line":81,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The top left coordinate of the quadtree.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The top left coordinate of the quadtree.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the quadtree in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the quadtree in pixels.","optional":false,"default":null},{"name":"maxObjects","type":["number"],"help":"The maximum number of objects per node.","optional":true,"default":"10"},{"name":"maxLevels","type":["number"],"help":"The maximum number of levels to iterate to.","optional":true,"default":"4"},{"name":"level","type":["number"],"help":"Which level is this?","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"retrieve","static":false,"returns":{"types":["array"],"help":"- Array with all detected objects."},"help":"Return all objects that could collide with the given Sprite or Rectangle.","line":254,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["Phaser.Sprite","Phaser.Rectangle"],"help":"The source object to check the QuadTree against. Either a Sprite or Rectangle.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"split","static":false,"returns":null,"help":"Split the node into 4 subnodes","line":135,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bounds","type":["object"],"help":"","inlineHelp":"Object that contains the quadtree bounds.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"level","type":["number"],"help":"","inlineHelp":"The current level.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxLevels","type":["number"],"help":"","inlineHelp":"The maximum number of levels to break down to.","line":35,"default":"4","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxObjects","type":["number"],"help":"","inlineHelp":"The maximum number of objects per node.","line":29,"default":"10","public":true,"protected":false,"private":false,"readOnly":false},{"name":"nodes","type":["array"],"help":"","inlineHelp":"Array of associated child nodes.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"objects","type":["array"],"help":"","inlineHelp":"Array of quadtree children.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_empty","type":["array"],"help":"","inlineHelp":"Internal empty array.","line":61,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.RandomDataGenerator.json b/docgen/output/Phaser.RandomDataGenerator.json deleted file mode 100644 index 5376e408e..000000000 --- a/docgen/output/Phaser.RandomDataGenerator.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.RandomDataGenerator","extends":"","static":false,"constructor":true,"parameters":[{"name":"seeds","type":["array"],"help":"An array of values to use as the seed.","optional":true,"default":null}],"help":"An extremely useful repeatable random data generator.\\nBased on Nonsense by Josh Faul https:\/\/github.com\/jocafa\/Nonsense.\\nRandom number generator from http:\/\/baagoe.org\/en\/wiki\/Better_random_numbers_for_javascript"},"consts":[],"methods":{"public":[{"name":"angle","static":false,"returns":{"types":["number"],"help":"A random number between -180 and 180."},"help":"Returns a random angle between -180 and 180.","line":285,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"between","static":false,"returns":{"types":["number"],"help":"A random number between min and max."},"help":"Returns a random integer between and including min and max.\\nThis method is an alias for RandomDataGenerator.integerInRange.","line":188,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value in the range.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value in the range.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"frac","static":false,"returns":{"types":["number"],"help":"A random real number between 0 and 1."},"help":"Returns a random real number between 0 and 1.","line":147,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integer","static":false,"returns":{"types":["number"],"help":"A random integer between 0 and 2^32."},"help":"Returns a random integer between 0 and 2^32.","line":135,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integerInRange","static":false,"returns":{"types":["number"],"help":"A random number between min and max."},"help":"Returns a random integer between and including min and max.","line":173,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value in the range.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value in the range.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"normal","static":false,"returns":{"types":["number"],"help":"A random real number between -1 and 1."},"help":"Returns a random real number between -1 and 1.","line":214,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pick","static":false,"returns":{"types":["any"],"help":"A random member of the array."},"help":"Returns a random member of `array`.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"ary","type":["array"],"help":"An Array to pick a random member of.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"real","static":false,"returns":{"types":["number"],"help":"A random real number between 0 and 2^32."},"help":"Returns a random real number between 0 and 2^32.","line":159,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"realInRange","static":false,"returns":{"types":["number"],"help":"A random number between min and max."},"help":"Returns a random real number between min and max.","line":202,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value in the range.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value in the range.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"sow","static":false,"returns":null,"help":"Reset the seed of the random data generator.","line":77,"public":true,"protected":false,"private":false,"parameters":[{"name":"seeds","type":["array"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"timestamp","static":false,"returns":{"types":["number"],"help":"A random timestamp between min and max."},"help":"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.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"min","type":["number"],"help":"The minimum value in the range.","optional":false,"default":null},{"name":"max","type":["number"],"help":"The maximum value in the range.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"uuid","static":false,"returns":{"types":["string"],"help":"A valid RFC4122 version4 ID hex string"},"help":"Returns a valid RFC4122 version4 ID hex string from https:\/\/gist.github.com\/1308368","line":226,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"weightedPick","static":false,"returns":{"types":["any"],"help":"A random member of the array."},"help":"Returns a random member of `array`, favoring the earlier entries.","line":259,"public":true,"protected":false,"private":false,"parameters":[{"name":"ary","type":["array"],"help":"An Array to pick a random member of.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"hash","static":false,"returns":{"types":["number"],"help":"hashed value."},"help":"Internal method that creates a seed hash.","line":108,"public":false,"protected":false,"private":true,"parameters":[{"name":"data","type":["any"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rnd","static":false,"returns":{"types":["number"],"help":""},"help":"Private random helper.","line":59,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[{"name":"c","type":["number"],"help":"","inlineHelp":"Internal var.","line":26,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"s0","type":["number"],"help":"","inlineHelp":"Internal var.","line":32,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"s1","type":["number"],"help":"","inlineHelp":"Internal var.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"s2","type":["number"],"help":"","inlineHelp":"Internal var.","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Rectangle.json b/docgen/output/Phaser.Rectangle.json deleted file mode 100644 index 7e5c9c424..000000000 --- a/docgen/output/Phaser.Rectangle.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Rectangle","extends":"","static":false,"constructor":true,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the top-left corner of the Rectangle.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the top-left corner of the Rectangle.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the Rectangle. Should always be either zero or a positive value.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the Rectangle. Should always be either zero or a positive value.","optional":false,"default":null}],"help":"Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.\\nIf you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created."},"consts":[],"methods":{"public":[{"name":"aabb","static":true,"returns":{"types":["Phaser.Rectangle"],"help":"The new Rectangle object."},"help":"Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.","line":869,"public":true,"protected":false,"private":false,"parameters":[{"name":"points","type":["array Phaser.Point"],"help":"The array of one or more points.","optional":false,"default":null},{"name":"out","type":["Phaser.Rectangle"],"help":"Optional Rectangle to store the value in, if not supplied a new Rectangle object will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"centerOn","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object"},"help":"Centers this Rectangle so that the center coordinates match the given x and y values.","line":124,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to place the center of the Rectangle at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to place the center of the Rectangle at.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clone","static":false,"returns":{"types":["Phaser.Rectangle"],"help":""},"help":"Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"output","type":["Phaser.Rectangle"],"help":"Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"contains","static":false,"returns":{"types":["boolean"],"help":"A value of true if the Rectangle object contains the specified point; otherwise false."},"help":"Determines whether the specified coordinates are contained within the region defined by this Rectangle object.","line":702,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the point to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the point to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"containsPoint","static":false,"returns":{"types":["boolean"],"help":"A value of true if the Rectangle object contains the specified point; otherwise false."},"help":"Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point object as a parameter.","line":737,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"point","type":["Phaser.Point"],"help":"The point object being checked. Can be Point or any object with .x and .y values.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"containsRaw","static":false,"returns":{"types":["boolean"],"help":"A value of true if the Rectangle object contains the specified point; otherwise false."},"help":"Determines whether the specified coordinates are contained within the region defined by the given raw values.","line":724,"public":true,"protected":false,"private":false,"parameters":[{"name":"rx","type":["number"],"help":"The x coordinate of the top left of the area.","optional":false,"default":null},{"name":"ry","type":["number"],"help":"The y coordinate of the top left of the area.","optional":false,"default":null},{"name":"rw","type":["number"],"help":"The width of the area.","optional":false,"default":null},{"name":"rh","type":["number"],"help":"The height of the area.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of the point to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the point to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"containsRect","static":false,"returns":{"types":["boolean"],"help":"A value of true if the Rectangle object contains the specified point; otherwise false."},"help":"Determines whether the first Rectangle object is fully contained within the second Rectangle object.\\nA Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.","line":751,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The first Rectangle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Rectangle"],"help":"The second Rectangle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyFrom","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object."},"help":"Copies the x, y, width and height properties from any given object to this Rectangle.","line":163,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copyTo","static":false,"returns":{"types":["object"],"help":"This object."},"help":"Copies the x, y, width and height properties from this Rectangle to any given object.","line":175,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["any"],"help":"The object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"equals","static":false,"returns":{"types":["boolean"],"help":"A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false."},"help":"Determines whether the two Rectangles are equal.\\nThis method compares the x, y, width and height properties of each Rectangle.","line":771,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The first Rectangle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Rectangle"],"help":"The second Rectangle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"floor","static":false,"returns":null,"help":"Runs Math.floor() on both the x and y values of this Rectangle.","line":137,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"floorAll","static":false,"returns":null,"help":"Runs Math.floor() on the x, y, width and height values of this Rectangle.","line":148,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"inflate","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object."},"help":"Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.","line":626,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"dx","type":["number"],"help":"The amount to be added to the left side of the Rectangle.","optional":false,"default":null},{"name":"dy","type":["number"],"help":"The amount to be added to the bottom side of the Rectangle.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"inflatePoint","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The Rectangle object."},"help":"Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter.","line":644,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"point","type":["Phaser.Point"],"help":"The x property of this Point object is used to increase the horizontal dimension of the Rectangle object. The y property is used to increase the vertical dimension of the Rectangle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersection","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0."},"help":"If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.","line":785,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The first Rectangle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Rectangle"],"help":"The second Rectangle object.","optional":false,"default":null},{"name":"output","type":["Phaser.Rectangle"],"help":"Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":{"types":["boolean"],"help":"A value of true if the specified object intersects with this Rectangle object; otherwise false."},"help":"Determines whether the two Rectangles intersect with each other.\\nThis method checks the x, y, width, and height properties of the Rectangles.","line":812,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The first Rectangle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Rectangle"],"help":"The second Rectangle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"intersectsRaw","static":false,"returns":{"types":["boolean"],"help":"A value of true if the specified object intersects with the Rectangle; otherwise false."},"help":"Determines whether the object specified intersects (overlaps) with the given values.","line":833,"public":true,"protected":false,"private":false,"parameters":[{"name":"left","type":["number"],"help":"The x coordinate of the left of the area.","optional":false,"default":null},{"name":"right","type":["number"],"help":"The right coordinate of the area.","optional":false,"default":null},{"name":"top","type":["number"],"help":"The y coordinate of the area.","optional":false,"default":null},{"name":"bottom","type":["number"],"help":"The bottom coordinate of the area.","optional":false,"default":null},{"name":"tolerance","type":["number"],"help":"A tolerance value to allow for an intersection test with padding, default to 0","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"offset","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object."},"help":"Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.","line":56,"public":true,"protected":false,"private":false,"parameters":[{"name":"dx","type":["number"],"help":"Moves the x value of the Rectangle object by this amount.","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Moves the y value of the Rectangle object by this amount.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"offsetPoint","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object."},"help":"Adjusts the location of the Rectangle object using a Point object as a parameter. This method is similar to the Rectangle.offset() method, except that it takes a Point object as a parameter.","line":71,"public":true,"protected":false,"private":false,"parameters":[{"name":"point","type":["Phaser.Point"],"help":"A Point object to use to offset this Rectangle object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"scale","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object"},"help":"Scales the width and height of this Rectangle by the given amounts.","line":105,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The amount to scale the width of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the width, etc.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The amount to scale the height of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the height, etc.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTo","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"This Rectangle object"},"help":"Sets the members of Rectangle to the specified values.","line":86,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate of the top-left corner of the Rectangle.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of the top-left corner of the Rectangle.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the Rectangle. Should always be either zero or a positive value.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the Rectangle. Should always be either zero or a positive value.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"size","static":false,"returns":{"types":["Phaser.Point"],"help":"The size of the Rectangle object"},"help":"The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.","line":657,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The Rectangle object.","optional":false,"default":null},{"name":"output","type":["Phaser.Point"],"help":"Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"A string representation of the instance."},"help":"Returns a string representation of this object.","line":324,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"union","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"A Rectangle object that is the union of the two Rectangles."},"help":"Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.","line":849,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["Phaser.Rectangle"],"help":"The first Rectangle object.","optional":false,"default":null},{"name":"b","type":["Phaser.Rectangle"],"help":"The second Rectangle object.","optional":false,"default":null},{"name":"output","type":["Phaser.Rectangle"],"help":"Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.","inlineHelp":"The sum of the y and height properties.","line":363,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bottomRight","type":["Phaser.Point"],"help":"The location of the Rectangles bottom right corner as a Point object.","inlineHelp":"Gets or sets the location of the Rectangles bottom right corner as a Point object.","line":384,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerX","type":["number"],"help":"The x coordinate of the center of the Rectangle.","inlineHelp":"The x coordinate of the center of the Rectangle.","line":473,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerY","type":["number"],"help":"The y coordinate of the center of the Rectangle.","inlineHelp":"The y coordinate of the center of the Rectangle.","line":490,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"empty","type":["boolean"],"help":"Determines whether or not this Rectangle object is empty. A Rectangle object is empty if its width or height is less than or equal to 0.\\nIf set to true then all of the Rectangle properties are set to 0.","inlineHelp":"Gets or sets the Rectangles empty state.","line":599,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"halfHeight","type":["number"],"help":"","inlineHelp":"Half of the height of the Rectangle.","line":350,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"halfWidth","type":["number"],"help":"","inlineHelp":"Half of the width of the Rectangle.","line":337,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of the Rectangle. This value should never be set to a negative.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"left","type":["number"],"help":"The x coordinate of the left of the Rectangle. 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.","inlineHelp":"The x coordinate of the left of the Rectangle.","line":402,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"perimeter","type":["number"],"help":"The perimeter size of the Rectangle. This is the sum of all 4 sides.","inlineHelp":"The perimeter size of the Rectangle. This is the sum of all 4 sides.","line":460,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"randomX","type":["number"],"help":"A random value between the left and right values (inclusive) of the Rectangle.","inlineHelp":"A random value between the left and right values (inclusive) of the Rectangle.","line":508,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"randomY","type":["number"],"help":"A random value between the top and bottom values (inclusive) of the Rectangle.","inlineHelp":"A random value between the top and bottom values (inclusive) of the Rectangle.","line":524,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"The sum of the x and width properties. 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.","inlineHelp":"The sum of the x and width properties.","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.\\nHowever it does affect the height property, whereas changing the y value does not affect the height property.","inlineHelp":"The y coordinate of the top of the Rectangle.","line":540,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"topLeft","type":["Phaser.Point"],"help":"The location of the Rectangles top left corner as a Point object.","inlineHelp":"The location of the Rectangles top left corner as a Point object.","line":562,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"topRight","type":["Phaser.Point"],"help":"The location of the Rectangles top right corner as a Point object.","inlineHelp":"The location of the Rectangles top left corner as a Point object.","line":580,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"volume","type":["number"],"help":"The volume of the Rectangle derived from width * height.","inlineHelp":"The volume of the Rectangle derived from width * height.","line":446,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of the Rectangle. This value should never be set to a negative.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x coordinate of the top-left corner of the Rectangle.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y coordinate of the top-left corner of the Rectangle.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.RenderTexture.json b/docgen/output/Phaser.RenderTexture.json deleted file mode 100644 index 8efd80e24..000000000 --- a/docgen/output/Phaser.RenderTexture.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.RenderTexture","extends":"PIXI.RenderTexture","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Internal Phaser reference key for the render texture.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the render texture.","optional":true,"default":"100"},{"name":"height","type":["number"],"help":"The height of the render texture.","optional":true,"default":"100"},{"name":"key","type":["string"],"help":"The key of the RenderTexture in the Cache, if stored there.","optional":true,"default":"''"},{"name":"scaleMode","type":["number"],"help":"One of the Phaser.scaleModes consts.","optional":true,"default":"Phaser.scaleModes.DEFAULT"},{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated.","optional":true,"default":"1"}],"help":"A RenderTexture is a special texture that allows any displayObject to be rendered to it. It allows you to take many complex objects and\\nrender them down into a single quad (on WebGL) which can then be used to texture other display objects with. A way of generating textures at run-time."},"consts":[],"methods":{"public":[{"name":"addTextureToCache","static":true,"returns":null,"help":"Adds a texture to the global PIXI.TextureCache. This cache is shared across the whole PIXI object.","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The Texture to add to the cache.","optional":false,"default":null},{"name":"id","type":["string"],"help":"The id that the texture will be stored against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"clear","static":false,"returns":null,"help":"Clears the RenderTexture.","line":176,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this texture","line":155,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyBase","type":["boolean"],"help":"Whether to destroy the base texture as well","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a new a Texture based on the given canvas element.","line":276,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromFrame","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that returns a Texture objected based on the given frame id.\\nIf the frame id is not in the texture cache an error will be thrown.","line":260,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame id of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a Texture object from the given image url.\\nIf the image is not in the texture cache it will be created and loaded.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"getBase64","static":false,"returns":{"types":["string"],"help":"A base64 encoded string of the texture."},"help":"Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.","line":294,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getCanvas","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"A Canvas element with the texture rendered on."},"help":"Creates a Canvas element, renders this RenderTexture to it and then returns it.","line":305,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getImage","static":false,"returns":{"types":["Image"],"help":""},"help":"Will return a HTML Image of the texture","line":281,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"removeTextureFromCache","static":true,"returns":{"types":["PIXI.Texture"],"help":"The texture that was removed"},"help":"Remove a texture from the global PIXI.TextureCache.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"id","type":["string"],"help":"The id of the texture to be removed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"render","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":90,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapText","Phaser.Group"],"help":" The display object to render to this texture.","optional":false,"default":null},{"name":"position","type":["Phaser.Point"],"help":"A Point object containing the position to render the display object at.","optional":false,"default":null},{"name":"clear","type":["boolean"],"help":"If true the texture will be cleared before the display object is drawn.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"renderXY","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":66,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapText","Phaser.Group"],"help":" The display object to render to this texture.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x position to render the object at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y position to render the object at.","optional":false,"default":null},{"name":"clear","type":["boolean"],"help":"If true the texture will be cleared before the display object is drawn.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"resize","static":false,"returns":null,"help":"Resizes the RenderTexture.","line":145,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width to resize to.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height to resize to.","optional":false,"default":null},{"name":"updateBase","type":["boolean"],"help":"Should the baseTexture.width and height values be resized as well?","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"setFrame","static":false,"returns":null,"help":"Specifies the region of the baseTexture that this texture will use.","line":168,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Rectangle"],"help":"The frame of the texture to set it to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"The base texture object that this texture uses","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crop","type":["Phaser.Rectangle"],"help":"This is the area of the BaseTexture image to actually copy to the Canvas \/ WebGL when rendering,\\nirrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)","inlineHelp":"","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["Phaser.Rectangle"],"help":"The framing rectangle of the render texture","inlineHelp":"","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the render texture","inlineHelp":"","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"","inlineHelp":"The key of the RenderTexture in the Cache, if stored there.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"matrix","type":["PIXI.Matrix"],"help":"","inlineHelp":"The matrix that is applied when display objects are rendered to this RenderTexture.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"noFrame","type":["boolean"],"help":"Does this Texture have any frame data assigned to it?","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.","inlineHelp":"","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"requiresUpdate","type":["boolean"],"help":"This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)","inlineHelp":"","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"trim","type":["Phaser.Rectangle"],"help":"The texture trim data.","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"Base Phaser object type.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"valid","type":["boolean"],"help":"","inlineHelp":"","line":129,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The with of the render texture","inlineHelp":"","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.RequestAnimationFrame.json b/docgen/output/Phaser.RequestAnimationFrame.json deleted file mode 100644 index abd7a5943..000000000 --- a/docgen/output/Phaser.RequestAnimationFrame.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.RequestAnimationFrame","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"forceSetTimeOut","type":["boolean"],"help":"Tell Phaser to use setTimeOut even if raf is available.","optional":true,"default":"false"}],"help":"Abstracts away the use of RAF or setTimeOut for the core game update loop."},"consts":[],"methods":{"public":[{"name":"isRAF","static":false,"returns":{"types":["boolean"],"help":""},"help":"Is the browser using requestAnimationFrame?","line":160,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isSetTimeOut","static":false,"returns":{"types":["boolean"],"help":""},"help":"Is the browser using setTimeout?","line":151,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the requestAnimationFrame running or setTimeout if unavailable in browser","line":74,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops the requestAnimationFrame from running.","line":131,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateRAF","static":false,"returns":null,"help":"The update method for the requestAnimationFrame","line":107,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateSetTimeout","static":false,"returns":null,"help":"The update method for the setTimeout.","line":119,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"forceSetTimeOut","type":["boolean"],"help":"","inlineHelp":"Tell Phaser to use setTimeOut even if raf is available.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"The currently running game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isRunning","type":["boolean"],"help":"","inlineHelp":"true if RequestAnimationFrame is running, otherwise false.","line":28,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_isSetTimeOut","type":["boolean"],"help":"","inlineHelp":" - true if the browser is using setTimeout instead of raf.","line":52,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onLoop","type":["function"],"help":"","inlineHelp":"The function called by the update.","line":58,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_timeOutID","type":["number"],"help":"","inlineHelp":"The callback ID used when calling cancel.","line":64,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.RetroFont.json b/docgen/output/Phaser.RetroFont.json deleted file mode 100644 index 3245f75bc..000000000 --- a/docgen/output/Phaser.RetroFont.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.RetroFont","extends":"Phaser.RenderTexture","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The font set graphic set as stored in the Game.Cache.","optional":false,"default":null},{"name":"characterWidth","type":["number"],"help":"The width of each character in the font set.","optional":false,"default":null},{"name":"characterHeight","type":["number"],"help":"The height of each character in the font set.","optional":false,"default":null},{"name":"chars","type":["string"],"help":"The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.","optional":false,"default":null},{"name":"charsPerRow","type":["number"],"help":"The number of characters per row in the font set. If not given charsPerRow will be the image width \/ characterWidth.","optional":true,"default":null},{"name":"xSpacing","type":["number"],"help":"If the characters in the font set have horizontal spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If the characters in the font set have vertical spacing between them set the required amount here.","optional":true,"default":"0"},{"name":"xOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","optional":true,"default":"0"},{"name":"yOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","optional":true,"default":"0"}],"help":"A Retro Font is similar to a BitmapFont, in that it uses a texture to render the text. However unlike a BitmapFont every character in a RetroFont\\nis the same size. This makes it similar to a sprite sheet. You typically find font sheets like this from old 8\/16-bit games and demos."},"consts":[{"name":"","type":"string","help":"","line":282},{"name":"\/0123456789:;<","type":"string","help":"","line":219},{"name":"?06DJPV,","type":"string","help":"","line":254},{"name":"ABCDEFGHIJKLMNO","type":"string","help":"","line":261},{"name":"ALIGN_CENTER","type":"string","help":"","line":205},{"name":"ALIGN_LEFT","type":"string","help":"","line":191},{"name":"ALIGN_RIGHT","type":"string","help":"","line":198},{"name":"TEXT_SET10","type":"string","help":"","line":275},{"name":"TEXT_SET3","type":"string","help":"","line":226},{"name":"TEXT_SET4","type":"string","help":"","line":233}],"methods":{"public":[{"name":"addTextureToCache","static":true,"returns":null,"help":"Adds a texture to the global PIXI.TextureCache. This cache is shared across the whole PIXI object.","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The Texture to add to the cache.","optional":false,"default":null},{"name":"id","type":["string"],"help":"The id that the texture will be stored against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"buildRetroFontText","static":false,"returns":null,"help":"Updates the texture with the new text.","line":343,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"clear","static":false,"returns":null,"help":"Clears the RenderTexture.","line":176,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this texture","line":155,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyBase","type":["boolean"],"help":"Whether to destroy the base texture as well","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a new a Texture based on the given canvas element.","line":276,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromFrame","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that returns a Texture objected based on the given frame id.\\nIf the frame id is not in the texture cache an error will be thrown.","line":260,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame id of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a Texture object from the given image url.\\nIf the image is not in the texture cache it will be created and loaded.","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"getBase64","static":false,"returns":{"types":["string"],"help":"A base64 encoded string of the texture."},"help":"Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.","line":294,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getCanvas","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"A Canvas element with the texture rendered on."},"help":"Creates a Canvas element, renders this RenderTexture to it and then returns it.","line":305,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getImage","static":false,"returns":{"types":["Image"],"help":""},"help":"Will return a HTML Image of the texture","line":281,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"getLongestLine","static":false,"returns":{"types":["number"],"help":"The length of the longest line of text."},"help":"Works out the longest line of text in _text and returns its length","line":477,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pasteLine","static":false,"returns":null,"help":"Internal function that takes a single line of text (2nd parameter) and pastes it into the BitmapData at the given coordinates.\\nUsed by getLine and getMultiLine","line":439,"public":true,"protected":false,"private":false,"parameters":[{"name":"line","type":["string"],"help":"The single line of text to paste.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate.","optional":false,"default":null},{"name":"customSpacingX","type":["number"],"help":"Custom X spacing.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeTextureFromCache","static":true,"returns":{"types":["PIXI.Texture"],"help":"The texture that was removed"},"help":"Remove a texture from the global PIXI.TextureCache.","line":305,"public":true,"protected":false,"private":false,"parameters":[{"name":"id","type":["string"],"help":"The id of the texture to be removed","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"render","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":90,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapText","Phaser.Group"],"help":" The display object to render to this texture.","optional":false,"default":null},{"name":"position","type":["Phaser.Point"],"help":"A Point object containing the position to render the display object at.","optional":false,"default":null},{"name":"clear","type":["boolean"],"help":"If true the texture will be cleared before the display object is drawn.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"renderXY","static":false,"returns":null,"help":"This function will draw the display object to the texture.","line":66,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.Text","Phaser.BitmapText","Phaser.Group"],"help":" The display object to render to this texture.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x position to render the object at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y position to render the object at.","optional":false,"default":null},{"name":"clear","type":["boolean"],"help":"If true the texture will be cleared before the display object is drawn.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"resize","static":false,"returns":null,"help":"Resizes the RenderTexture.","line":145,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The width to resize to.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height to resize to.","optional":false,"default":null},{"name":"updateBase","type":["boolean"],"help":"Should the baseTexture.width and height values be resized as well?","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.RenderTexture"},{"name":"setFixedWidth","static":false,"returns":null,"help":"If you need this RetroFont to have a fixed width and custom alignment you can set the width here.\\nIf text is wider than the width specified it will be cropped off.","line":293,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"Width in pixels of this RetroFont. Set to zero to disable and re-enable automatic resizing.","optional":false,"default":null},{"name":"lineAlignment","type":["string"],"help":"Align the text within this width. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.","optional":true,"default":"'left'"}],"inherited":false,"inheritedFrom":""},{"name":"setFrame","static":false,"returns":null,"help":"Specifies the region of the baseTexture that this texture will use.","line":168,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Rectangle"],"help":"The frame of the texture to set it to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Texture"},{"name":"setText","static":false,"returns":null,"help":"A helper function that quickly sets lots of variables at once, and then updates the text.","line":314,"public":true,"protected":false,"private":false,"parameters":[{"name":"content","type":["string"],"help":"The text of this sprite.","optional":false,"default":null},{"name":"multiLine","type":["boolean"],"help":"Set to true if you want to support carriage-returns in the text and create a multi-line sprite instead of a single line.","optional":true,"default":"false"},{"name":"characterSpacing","type":["number"],"help":"To add horizontal spacing between each character specify the amount in pixels.","optional":true,"default":"0"},{"name":"lineSpacing","type":["number"],"help":"To add vertical spacing between each line of text, set the amount in pixels.","optional":true,"default":"0"},{"name":"lineAlignment","type":["string"],"help":"Align each line of multi-line text. Set to RetroFont.ALIGN_LEFT, RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.","optional":true,"default":"'left'"},{"name":"allowLowerCase","type":["boolean"],"help":"Lots of bitmap font sets only include upper-case characters, if yours needs to support lower case then set this to true.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"updateOffset","static":false,"returns":null,"help":"Updates the x and\/or y offset that the font is rendered from. This updates all of the texture frames, so be careful how often it is called.\\nNote that the values given for the x and y properties are either ADDED to or SUBTRACTED from (if negative) the existing offsetX\/Y values of the characters.\\nSo if the current offsetY is 8 and you want it to start rendering from y16 you would call updateOffset(0, 8) to add 8 to the current y offset.","line":535,"public":true,"protected":false,"private":false,"parameters":[{"name":"xOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","optional":true,"default":"0"},{"name":"yOffset","type":["number"],"help":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"removeUnsupportedCharacters","static":false,"returns":{"types":["string"],"help":" A clean version of the string."},"help":"Internal helper function that removes all unsupported characters from the _text String, leaving only characters contained in the font set.","line":506,"public":false,"protected":true,"private":false,"parameters":[{"name":"stripCR","type":["boolean"],"help":"Should it strip carriage returns as well?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"align","type":["string"],"help":"","inlineHelp":"Alignment of the text when multiLine = true or a fixedWidth is set. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoUpperCase","type":["boolean"],"help":"","inlineHelp":"Automatically convert any text to upper case. Lots of old bitmap fonts only contain upper-case characters, so the default is true.","line":89,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"The base texture object that this texture uses","inlineHelp":"","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"characterHeight","type":["number"],"help":"","inlineHelp":"The height of each character in the font set.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"characterPerRow","type":["number"],"help":"","inlineHelp":"The number of characters per row in the font set.","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"characterSpacingX","type":["number"],"help":"","inlineHelp":"If the characters in the font set have horizontal spacing between them set the required amount here.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"characterSpacingY","type":["number"],"help":"","inlineHelp":"If the characters in the font set have vertical spacing between them set the required amount here.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"characterWidth","type":["number"],"help":"","inlineHelp":"The width of each character in the font set.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crop","type":["Phaser.Rectangle"],"help":"This is the area of the BaseTexture image to actually copy to the Canvas \/ WebGL when rendering,\\nirrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)","inlineHelp":"","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"customSpacingX","type":["number"],"help":"","inlineHelp":"Adds horizontal spacing between each character of the font, in pixels.","line":95,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"customSpacingY","type":["number"],"help":"","inlineHelp":"Adds vertical spacing between each line of multi-line text, set in pixels.","line":101,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedWidth","type":["number"],"help":"If you need this RetroFont image to have a fixed width you can set the width in this value.\\nIf text is wider than the width specified it will be cropped off.","inlineHelp":"","line":108,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontSet","type":["Image"],"help":"","inlineHelp":"A reference to the image stored in the Game.Cache that contains the font.","line":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["Phaser.Rectangle"],"help":"The framing rectangle of the render texture","inlineHelp":"","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameData","type":["Phaser.FrameData"],"help":"","inlineHelp":"The FrameData representing this Retro Font.","line":130,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the render texture","inlineHelp":"","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"","inlineHelp":"The key of the RenderTexture in the Cache, if stored there.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"matrix","type":["PIXI.Matrix"],"help":"","inlineHelp":"The matrix that is applied when display objects are rendered to this RenderTexture.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"multiLine","type":["boolean"],"help":"","inlineHelp":"If set to true all carriage-returns in text will form new lines (see align). If false the font will only contain one single line of text (the default)","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"noFrame","type":["boolean"],"help":"Does this Texture have any frame data assigned to it?","inlineHelp":"","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offsetX","type":["number"],"help":"","inlineHelp":"If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"offsetY","type":["number"],"help":"","inlineHelp":"If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.","inlineHelp":"","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"requiresUpdate","type":["boolean"],"help":"This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)","inlineHelp":"","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stamp","type":["Phaser.Image"],"help":"","inlineHelp":"The image that is stamped to the RenderTexture for each character in the font.","line":172,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"text","type":["string"],"help":"","inlineHelp":"Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.","line":602,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"trim","type":["Phaser.Rectangle"],"help":"The texture trim data.","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"Base Phaser object type.","line":179,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"valid","type":["boolean"],"help":"","inlineHelp":"","line":129,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The with of the render texture","inlineHelp":"","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_text","type":["string"],"help":"","inlineHelp":"The text of the font image.","line":119,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"grabData","type":["array"],"help":"","inlineHelp":"An array of rects for faster character pasting.","line":125,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Rope.json b/docgen/output/Phaser.Rope.json deleted file mode 100644 index 056e3b174..000000000 --- a/docgen/output/Phaser.Rope.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Rope","extends":"PIXI.Rope","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Rope at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Rope at.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Rope during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Rope is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null},{"name":"points","type":["array"],"help":"An array of {Phaser.Point}.","optional":false,"default":null}],"help":"A Rope is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.\\nPlease note that Ropes, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.\\nExample usage: https:\/\/github.com\/codevinsky\/phaser-rope-demo\/blob\/master\/dist\/demo.js"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the Rope. This removes it from its parent group, destroys the event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":408,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the Rope is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":311,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Rope during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Rope is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"A reference to playing Animation instance."},"help":"Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()\\nIf the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.","line":482,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be played, e.g. \"fire\", \"walk\", \"jump\".","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":279,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":167,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":[],"help":[]},"help":"Resets the Rope. This places the Rope at the given x\/y world coordinates, resets the tilePosition and then\\nsets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.\\nIf the Rope has a physics body that too is reset.","line":499,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Sprite at.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the Rope uses for rendering.\\nThis is primarily an internal method used by Rope.loadTexture, although you may call it directly.","line":360,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the Rope texture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":266,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Sprite in degrees.","line":532,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Sprite be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Sprite should be automatically camera culled or not.","line":110,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"body","type":["Phaser.Physics.Arcade.Body","Phaser.Physics.P2.Body","Phaser.Physics.Ninja.Body","null"],"help":"By default Sprites won't add themselves to any physics system and their physics body will be `null`.\\nTo enable them for physics you need to call `game.physics.enable(sprite, system)` where `sprite` is this object\\nand `system` is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via `Sprite.body`.\\n\\nImportant: Enabling a Sprite for P2 or Ninja physics will automatically set `Sprite.anchor` to 0.5 so the physics body is centered on the Sprite.\\nIf you need a different result then adjust or re-create the Body shape offsets manually, and\/or reset the anchor after enabling physics.","inlineHelp":"","line":137,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":124,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkWorldBounds","type":["boolean"],"help":"If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds\\nand optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its\\nbounds every frame to support it, and not all games need it. Enable it by setting the value to true.","inlineHelp":"","line":119,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":821,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"Whether the strip is dirty or not","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"Rope.exists controls if the core game loop and physics update this Rope or not.\\nWhen you set Rope.exists to false it will remove its Body from the physics world (if it has one) and also set Rope.visible to false.\\nSetting Rope.exists to true will re-add the Body to the physics world (if it has a body) and set Rope.visible to true.","inlineHelp":"If the Rope is processed by the core game update and physics.","line":629,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Rope that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Rope.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Rope was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Rope to the Camera at its current world coordinates.","line":598,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":552,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame name and updates the Texture Cache for display.","line":573,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":95,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Rope won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":675,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Sprite.","line":42,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"if you need a padding, not yet implemented","inlineHelp":"","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture of the strip","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"updateAnimation","type":["array"],"help":"The segments that make up the rope body as an array of Phaser.Rectangles","inlineHelp":"Returns an array of Phaser.Rectangles that represent the segments of the given rope","line":796,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the Rope on the x axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Rope on the x axis relative to the local coordinates of the parent.","line":715,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the Rope on the y axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Rope on the y axis relative to the local coordinates of the parent.","line":742,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":153,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frame","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameName","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_scroll","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.ScaleManager.json b/docgen/output/Phaser.ScaleManager.json deleted file mode 100644 index 58adc20a8..000000000 --- a/docgen/output/Phaser.ScaleManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.ScaleManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"width","type":["number","string"],"help":"The width of the game.","optional":false,"default":null},{"name":"height","type":["number","string"],"help":"The height of the game.","optional":false,"default":null}],"help":"The ScaleManager object is responsible for helping you manage the scaling, resizing and alignment of your game within the browser."},"consts":[{"name":"EXACT_FIT","type":"number","help":"","line":289},{"name":"NO_SCALE","type":"number","help":"","line":295},{"name":"RESIZE","type":"number","help":"","line":307},{"name":"SHOW_ALL","type":"number","help":"","line":301}],"methods":{"public":[{"name":"boot","static":false,"returns":null,"help":"Calculates and sets the game dimensions based on the given width and height.","line":421,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkOrientation","static":false,"returns":null,"help":"window.orientationchange event handler.","line":636,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"The orientationchange event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkOrientationState","static":false,"returns":null,"help":"Checks if the browser is in the correct orientation for your game (if forceLandscape or forcePortrait have been set)","line":597,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkResize","static":false,"returns":null,"help":"window.resize event handler.","line":664,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"The resize event data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys the ScaleManager and removes any event listeners.","line":1084,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"forceOrientation","static":false,"returns":null,"help":"If you need your game to run in only one orientation you can force that to happen.","line":583,"public":true,"protected":false,"private":false,"parameters":[{"name":"forceLandscape","type":["boolean"],"help":"true if the game should run in landscape mode only.","optional":false,"default":null},{"name":"forcePortrait","type":["boolean"],"help":"true if the game should run in portrait mode only.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"parseConfig","static":false,"returns":null,"help":"Parses the Game configuration object.","line":317,"public":true,"protected":false,"private":false,"parameters":[{"name":"config","type":["object"],"help":"The game configuration object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"refresh","static":false,"returns":null,"help":"Re-calculate scale mode and update screen size. This only applies if ScaleMode is not set to RESIZE.","line":732,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setExactFit","static":false,"returns":null,"help":"Sets the width and height values of the canvas, no larger than the maxWidth\/Height.","line":956,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setMaximum","static":false,"returns":null,"help":"Sets this.width equal to window.innerWidth and this.height equal to window.innerHeight.","line":930,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setMinMax","static":false,"returns":null,"help":"Set the ScaleManager min and max dimensions in one single callback.","line":483,"public":true,"protected":false,"private":false,"parameters":[{"name":"minWidth","type":["number"],"help":"The minimum width the game is allowed to scale down to.","optional":false,"default":null},{"name":"minHeight","type":["number"],"help":"The minimum height the game is allowed to scale down to.","optional":false,"default":null},{"name":"maxWidth","type":["number"],"help":"The maximum width the game is allowed to scale up to.","optional":false,"default":null},{"name":"maxHeight","type":["number"],"help":"The maximum height the game is allowed to scale up to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setResizeCallback","static":false,"returns":null,"help":"Sets the callback that will be called when the window resize event occurs, or if set the parent container changes dimensions.\\nUse this to handle responsive game layout options.\\nNote that the callback will only be called if the ScaleManager.scaleMode is set to RESIZE.","line":467,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback that will be called each time a window.resize event happens or if set, the parent container resizes.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setShowAll","static":false,"returns":null,"help":"Calculates the multiplier needed to scale the game proportionally.","line":942,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"Sets the canvas style width and height values based on minWidth\/Height and maxWidth\/Height.","line":843,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setupScale","static":false,"returns":null,"help":"Calculates and sets the game dimensions based on the given width and height.","line":343,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number","string"],"help":"The width of the game.","optional":false,"default":null},{"name":"height","type":["number","string"],"help":"The height of the game.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"startFullScreen","static":false,"returns":null,"help":"Tries to enter the browser into full screen mode.\\nPlease note that this needs to be supported by the web browser and isn't the same thing as setting your game to fill the browser.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"antialias","type":["boolean"],"help":"You can toggle the anti-alias feature of the canvas before jumping in to full screen (false = retain pixel art, true = smooth art)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stopFullScreen","static":false,"returns":null,"help":"Stops full screen mode if the browser is in it.","line":1018,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateDimensions","static":false,"returns":null,"help":"Called automatically when the game parent dimensions change.","line":541,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The new width of the parent container.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The new height of the parent container.","optional":false,"default":null},{"name":"resize","type":["boolean"],"help":"True if the renderer should be resized, otherwise false to just update the internal vars.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"fullScreenChange","static":false,"returns":null,"help":"Called automatically when the browser enters of leaves full screen mode.","line":1030,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"The fullscreenchange event","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"The ScaleManager.preUpdate is called automatically by the core Game loop.","line":506,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"aspectRatio","type":["number"],"help":"","inlineHelp":"The aspect ratio of the scaled game.","line":186,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"bounds","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The bounds of the scaled game. The x\/y will match the offset of the canvas element and the width\/height the scaled width and height.","line":180,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"enterFullScreen","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser enters full screen mode (if it supports the FullScreen API).","line":134,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enterIncorrectOrientation","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser enters an incorrect orientation, as defined by forceOrientation.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enterLandscape","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser enters landscape orientation having been in portrait.","line":106,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enterPortrait","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser enters portrait orientation having been in landscape.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"event-","type":["any"],"help":"","inlineHelp":" The native browser events from full screen API changes.","line":197,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"forceLandscape","type":["boolean"],"help":"","inlineHelp":"Set to `true` if the game should only run in a landscape orientation.","line":67,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"forcePortrait","type":["boolean"],"help":"","inlineHelp":"Set to `true` if the game should only run in a portrait orientation.","line":73,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fullScreenTarget","type":["any"],"help":"This is the DOM element that will have the Full Screen mode called on it. It defaults to the game canvas, but can be retargetted to any valid DOM element.\\nIf you adjust this property it's up to you to see it has the correct CSS applied, and that you have contained the game canvas correctly.\\nNote that if you use a scale property of EXACT_FIT then fullScreenTarget will have its width and height style set to 100%.","inlineHelp":"","line":129,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"grid","type":["Phaser.FlexGrid"],"help":"","inlineHelp":"EXPERIMENTAL: A responsive grid on which you can align game objects.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Height of the game after calculation.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"incorrectOrientation","type":["boolean"],"help":"","inlineHelp":"If `forceLandscape` or `forcePortrait` are true and the browser doesn't match that orientation this is set to `true`.","line":79,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"isFullScreen","type":["boolean"],"help":"","inlineHelp":"Returns true if the browser is in full screen mode, otherwise false.","line":1130,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"isLandscape","type":["boolean"],"help":"","inlineHelp":"Returns true if the browser dimensions match a landscape display.","line":1156,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"isPortrait","type":["boolean"],"help":"","inlineHelp":"Returns true if the browser dimensions match a portrait display.","line":1143,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"leaveFullScreen","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser leaves full screen mode (if it supports the FullScreen API).","line":139,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"leaveIncorrectOrientation","type":["Phaser.Signal"],"help":"","inlineHelp":"The event that is dispatched when the browser leaves an incorrect orientation, as defined by forceOrientation.","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"margin","type":["Phaser.Point"],"help":"","inlineHelp":"If the game canvas is set to align by adjusting the margin, the margin calculation values are stored in this Point.","line":174,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"maxHeight","type":["number"],"help":"","inlineHelp":"Maximum height the canvas should be scaled to (in pixels). If null it will scale to whatever height the browser can handle.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxIterations","type":["number"],"help":"","inlineHelp":"The maximum number of times it will try to resize the canvas to fill the browser.","line":101,"default":"5","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maxWidth","type":["number"],"help":"","inlineHelp":"Maximum width the canvas should be scaled to (in pixels). If null it will scale to whatever width the browser can handle.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"minHeight","type":["number"],"help":"","inlineHelp":"Minimum height the canvas should be scaled to (in pixels).","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"minWidth","type":["number"],"help":"","inlineHelp":"Minimum width the canvas should be scaled to (in pixels).","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"","inlineHelp":"Holds the offset coordinates of the Game.canvas from the top-left of the browser window (used by Input and other classes)","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResize","type":["function"],"help":"","inlineHelp":"The callback that will be called each time a window.resize event happens or if set, the parent container resizes.","line":232,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResizeContext","type":["object"],"help":"","inlineHelp":"The context in which the callback will be called.","line":238,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"orientation","type":["number"],"help":"","inlineHelp":"The orientation value of the game (as defined by window.orientation if set). 90 = landscape. 0 = portrait.","line":144,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pageAlignHorizontally","type":["boolean"],"help":"It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation\/resizing events.\\nIt doesn't care about any other DOM element that may be on the page, it literally just sets the margin.","inlineHelp":"If you wish to align your game in the middle of the page then you can set this value to true.","line":87,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pageAlignVertically","type":["boolean"],"help":"It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation\/resizing events.\\nIt doesn't care about any other DOM element that may be on the page, it literally just sets the margin.","inlineHelp":"If you wish to align your game in the middle of the page then you can set this value to true.","line":95,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parentIsWindow","type":["boolean"],"help":"","inlineHelp":"If the parent container of the game is the browser window, rather than a div, this is set to `true`.","line":208,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"parentNode","type":["object"],"help":"","inlineHelp":"The fully parsed parent container of the game. If the parent is the browser window this will be `null`.","line":214,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"parentScaleFactor","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the game in relation to its parent container.","line":220,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scaleFactor","type":["Phaser.Point"],"help":"","inlineHelp":"The scale factor based on the game dimensions vs. the scaled dimensions.","line":162,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scaleFactorInversed","type":["Phaser.Point"],"help":"","inlineHelp":"The inversed scale factor. The displayed dimensions divided by the game dimensions.","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scaleMode","type":["number"],"help":"","inlineHelp":"The scaling method used by the ScaleManager.","line":1106,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceAspectRatio","type":["number"],"help":"","inlineHelp":"The aspect ratio (width \/ height) of the original game dimensions.","line":192,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"trackParentInterval","type":["number"],"help":"","inlineHelp":"The interval (in ms) upon which the ScaleManager checks if the parent has changed dimensions. Only applies if scaleMode = RESIZE and the game is contained within another html element.","line":226,"default":"2000","public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"Width of the game after calculation.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_check","type":["number"],"help":"","inlineHelp":"Cached size interval var.","line":262,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_height","type":["number"],"help":"","inlineHelp":"Cached game height for full screen mode.","line":256,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_nextParentCheck","type":["number"],"help":"","inlineHelp":"The time to run the next parent bounds check.","line":268,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_parentBounds","type":["object"],"help":"","inlineHelp":"The cached result of getBoundingClientRect from the parent.","line":274,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_width","type":["number"],"help":"","inlineHelp":"Cached game width for full screen mode.","line":250,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"scaleMode","type":["number"],"help":"","inlineHelp":"The current scaling method being used.","line":244,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Signal.json b/docgen/output/Phaser.Signal.json deleted file mode 100644 index 81b63837b..000000000 --- a/docgen/output/Phaser.Signal.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Signal","extends":"","static":false,"constructor":true,"parameters":[],"help":"A Signal is used for object communication via a custom broadcaster instead of Events."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.SignalBinding"],"help":"An Object representing the binding between the Signal and listener."},"help":"Add a listener to the signal.","line":184,"public":true,"protected":false,"private":false,"parameters":[{"name":"listener","type":["function"],"help":"The function to call when this Signal is dispatched.","optional":false,"default":null},{"name":"listenerContext","type":["object"],"help":"The context under which the listener will be executed (i.e. the object that should represent the `this` variable).","optional":true,"default":null},{"name":"priority","type":["number"],"help":"The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addOnce","static":false,"returns":{"types":["Phaser.SignalBinding"],"help":"An Object representing the binding between the Signal and listener."},"help":"Add listener to the signal that should be removed after first execution (will be executed only once).","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"listener","type":["function"],"help":"The function to call when this Signal is dispatched.","optional":false,"default":null},{"name":"listenerContext","type":["object"],"help":"The context under which the listener will be executed (i.e. the object that should represent the `this` variable).","optional":true,"default":null},{"name":"priority","type":["number"],"help":"The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"dispatch","static":false,"returns":null,"help":"Dispatch\/Broadcast Signal to all listeners added to the queue.","line":299,"public":true,"protected":false,"private":false,"parameters":[{"name":"params","type":["any"],"help":"Parameters that should be passed to each handler.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"dispose","static":false,"returns":null,"help":"Remove all bindings from signal and destroy any reference to external objects (destroy Signal object).\\nIMPORTANT: calling any method on the signal instance after calling dispose will throw errors.","line":351,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"forget","static":false,"returns":null,"help":"Forget memorized arguments.","line":339,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getNumListeners","static":false,"returns":{"types":["number"],"help":"Number of listeners attached to the Signal."},"help":"Gets the total number of listeneres attached to ths Signal.","line":274,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"halt","static":false,"returns":null,"help":"Stop propagation of the event, blocking the dispatch to next listeners on the queue.\\nIMPORTANT: should be called only during signal dispatch, calling it before\/after dispatch won't affect signal broadcast.","line":287,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"has","static":false,"returns":{"types":["boolean"],"help":"If Signal has the specified listener."},"help":"Check if listener was attached to Signal.","line":169,"public":true,"protected":false,"private":false,"parameters":[{"name":"listener","type":["function"],"help":"Signal handler function.","optional":false,"default":null},{"name":"context","type":["object"],"help":"Context on which listener will be executed (object that should represent the `this` variable inside listener function).","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":{"types":["function"],"help":"Listener handler function."},"help":"Remove a single listener from the dispatch queue.","line":217,"public":true,"protected":false,"private":false,"parameters":[{"name":"listener","type":["function"],"help":"Handler function that should be removed.","optional":false,"default":null},{"name":"context","type":["object"],"help":"Execution context (since you can add the same handler multiple times if executing in a different context).","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all listeners from the Signal.","line":239,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"If specified only listeners for the given context will be removed.","optional":true,"default":"null"}],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"String representation of the object."},"help":"","line":365,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_addBinding","static":false,"returns":null,"help":"","line":122,"public":false,"protected":false,"private":true,"parameters":[{"name":"binding","type":["Phaser.SignalBinding"],"help":"An Object representing the binding between the Signal and listener.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_indexOfListener","static":false,"returns":{"types":["number"],"help":"The index of the listener within the private bindings array."},"help":"","line":142,"public":false,"protected":false,"private":true,"parameters":[{"name":"listener","type":["function"],"help":"Signal handler function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_registerListener","static":false,"returns":{"types":["Phaser.SignalBinding"],"help":"An Object representing the binding between the Signal and listener."},"help":"","line":88,"public":false,"protected":false,"private":true,"parameters":[{"name":"listener","type":["function"],"help":"Signal handler function.","optional":false,"default":null},{"name":"isOnce","type":["boolean"],"help":"Should the listener only be called once?","optional":false,"default":null},{"name":"listenerContext","type":["object"],"help":"The context under which the listener is invoked.","optional":true,"default":null},{"name":"priority","type":["number"],"help":"The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added. (default = 0).","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"validateListener","static":false,"returns":null,"help":"","line":70,"public":false,"protected":false,"private":true,"parameters":[{"name":"listener","type":["function"],"help":"Signal handler function.","optional":false,"default":null},{"name":"fnName","type":["string"],"help":"Function name.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"If Signal is active and should broadcast events.\\nIMPORTANT: Setting this property during a dispatch will only affect the next dispatch, if you want to stop the propagation of a signal use `halt()` instead.","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"dispatch","type":["function"],"help":"","inlineHelp":"The dispatch function is what sends the Signal out.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"memorize","type":["boolean"],"help":"If Signal should keep record of previously dispatched parameters and\\nautomatically execute listener during `add()`\/`addOnce()` if Signal was\\nalready dispatched before.","inlineHelp":"","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_bindings","type":["array Phaser.SignalBinding"],"help":"","inlineHelp":"Internal variable.","line":20,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_prevParams","type":["any"],"help":"","inlineHelp":"Internal variable.","line":26,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_shouldPropagate","type":["boolean"],"help":"","inlineHelp":"","line":54,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.SignalBinding.json b/docgen/output/Phaser.SignalBinding.json deleted file mode 100644 index 73c040655..000000000 --- a/docgen/output/Phaser.SignalBinding.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.SignalBinding","extends":"","static":false,"constructor":true,"parameters":[{"name":"signal","type":["Phaser.Signal"],"help":"Reference to Signal object that listener is currently bound to.","optional":false,"default":null},{"name":"listener","type":["function"],"help":"Handler function bound to the signal.","optional":false,"default":null},{"name":"isOnce","type":["boolean"],"help":"If binding should be executed just once.","optional":false,"default":null},{"name":"listenerContext","type":["object"],"help":"Context on which listener will be executed (object that should represent the `this` variable inside listener function).","optional":true,"default":null},{"name":"priority","type":["number"],"help":"The priority level of the event listener. (default = 0).","optional":true,"default":null}],"help":"Object that represents a binding between a Signal and a listener function.\\nThis is an internal constructor and shouldn't be created directly.\\nInspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes."},"consts":[],"methods":{"public":[{"name":"detach","static":false,"returns":{"types":["function","null"],"help":"Handler function bound to the signal or `null` if binding was previously detached."},"help":"Detach binding from signal.\\nalias to: @see mySignal.remove(myBinding.getListener());","line":102,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"execute","static":false,"returns":{"types":["any"],"help":"Value returned by the listener."},"help":"Call listener passing arbitrary parameters.\\nIf binding was added using `Signal.addOnce()` it will be automatically removed from signal dispatch queue, this method is used internally for the signal dispatch.","line":77,"public":true,"protected":false,"private":false,"parameters":[{"name":"paramsArr","type":["array"],"help":"Array of parameters that should be passed to the listener.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getListener","static":false,"returns":{"types":["function"],"help":"Handler function bound to the signal."},"help":"","line":126,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getSignal","static":false,"returns":{"types":["Phaser.Signal"],"help":"Signal that listener is currently bound to."},"help":"","line":134,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isBound","static":false,"returns":{"types":["boolean"],"help":"True if binding is still bound to the signal and has a listener."},"help":"","line":110,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isOnce","static":false,"returns":{"types":["boolean"],"help":"If SignalBinding will only be executed once."},"help":"","line":118,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"toString","static":false,"returns":{"types":["string"],"help":"String representation of the object."},"help":"","line":153,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_destroy","static":false,"returns":null,"help":"Delete instance properties","line":143,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"If binding is active and should be executed.","inlineHelp":"","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["object","undefined","null"],"help":"","inlineHelp":"Context on which listener will be executed (object that should represent the `this` variable inside listener function).","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"params","type":["array","null"],"help":"Default parameters passed to listener during `Signal.dispatch` and `SignalBinding.execute` (curried parameters).","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_isOnce","type":["boolean"],"help":"","inlineHelp":"If binding should be executed just once.","line":33,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_listener","type":["Phaser.Game"],"help":"","inlineHelp":"Handler function bound to the signal.","line":27,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_priority","type":["number"],"help":"","inlineHelp":"Listener priority.","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_signal","type":["Phaser.Signal"],"help":"","inlineHelp":"Reference to Signal object that listener is currently bound to.","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.SinglePad.json b/docgen/output/Phaser.SinglePad.json deleted file mode 100644 index c06acb7c8..000000000 --- a/docgen/output/Phaser.SinglePad.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.SinglePad","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"padParent","type":["object"],"help":"The parent Phaser.Gamepad object (all gamepads reside under this)","optional":false,"default":null}],"help":"A single Phaser Gamepad"},"consts":[],"methods":{"public":[{"name":"addCallbacks","static":false,"returns":null,"help":"Add callbacks to the this Gamepad to handle connect \/ disconnect \/ button down \/ button up \/ axis change \/ float value buttons.\\n\\nonConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context under which the callbacks are run.","optional":false,"default":null},{"name":"callbacks","type":["object"],"help":"Object that takes six different callbak methods:","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"axis","static":false,"returns":{"types":["number"],"help":"Axis value if available otherwise false"},"help":"Returns value of requested axis.","line":438,"public":true,"protected":false,"private":false,"parameters":[{"name":"axisCode","type":["number"],"help":"The index of the axis to check","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"buttonValue","static":false,"returns":{"types":["number"],"help":"Button value if available otherwise null. Be careful as this can incorrectly evaluate to 0."},"help":"Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example\\nanalog trigger buttons on the XBOX 360 controller.","line":527,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"connect","static":false,"returns":null,"help":"Gamepad connect function, should be called by Phaser.Gamepad.","line":221,"public":true,"protected":false,"private":false,"parameters":[{"name":"rawPad","type":["object"],"help":"The raw gamepad object","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this object and associated callback references.","line":302,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disconnect","static":false,"returns":null,"help":"Gamepad disconnect function, should be called by Phaser.Gamepad.","line":264,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getButton","static":false,"returns":{"types":["Phaser.GamepadButton"],"help":"The GamepadButton object which you can store locally and reference directly."},"help":"Gets a GamepadButton object from this controller to be stored and referenced locally.\\nThe GamepadButton object can then be polled, have events attached to it, etc.","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0, Phaser.Gamepad.XBOX360_A, etc.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isDown","static":false,"returns":{"types":["boolean"],"help":"True if the button is pressed down."},"help":"Returns true if the button is pressed down.","line":456,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isUp","static":false,"returns":{"types":["boolean"],"help":"True if the button is not currently pressed down."},"help":"Returns true if the button is not currently pressed.","line":474,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"True if the button is just pressed otherwise false."},"help":"Returns the \"just pressed\" state of a button from this gamepad. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).","line":510,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check for.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration below which the button is considered as being just pressed.","optional":true,"default":"250"}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":"True if the button is just released otherwise false."},"help":"Returns the \"just released\" state of a button from this gamepad. Just released is considered as being true if the button was released within the duration given (default 250ms).","line":493,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"The buttonCode of the button to check for.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration below which the button is considered as being just released.","optional":true,"default":"250"}],"inherited":false,"inheritedFrom":""},{"name":"pollStatus","static":false,"returns":null,"help":"Main update function called by Phaser.Gamepad.","line":169,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"processAxisChange","static":false,"returns":null,"help":"Handles changes in axis.","line":332,"public":true,"protected":false,"private":false,"parameters":[{"name":"axisState","type":["object"],"help":"State of the relevant axis","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processButtonDown","static":false,"returns":null,"help":"Handles button down press.","line":360,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"Which buttonCode of this button","optional":false,"default":null},{"name":"value","type":["object"],"help":"Button value","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processButtonFloat","static":false,"returns":null,"help":"Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)","line":412,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"Which buttonCode of this button","optional":false,"default":null},{"name":"value","type":["object"],"help":"Button value (will range somewhere between 0 and 1, but not specifically 0 or 1.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"processButtonUp","static":false,"returns":null,"help":"Handles button release.","line":386,"public":true,"protected":false,"private":false,"parameters":[{"name":"buttonCode","type":["number"],"help":"Which buttonCode of this button","optional":false,"default":null},{"name":"value","type":["object"],"help":"Button value","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Reset all buttons\/axes of this gamepad.","line":543,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which the callbacks are run.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"connected","type":["boolean"],"help":"","inlineHelp":"Whether or not this particular gamepad is connected or not.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deadZone","type":["number"],"help":"","inlineHelp":"Dead zone for axis feedback - within this value you won't trigger updates.","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The gamepad index as per browsers data","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"onAxisCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time an axis is changed.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onConnectCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time this gamepad is connected","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDisconnectCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time this gamepad is disconnected","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDownCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a button is pressed down.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFloatCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a button is changed to a value where value > 0 and value < 1.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpCallback","type":["function"],"help":"","inlineHelp":"This callback is invoked every time a gamepad button is released.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_axes","type":["array"],"help":"","inlineHelp":"Current axes state.","line":109,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_axesLen","type":["number"],"help":"","inlineHelp":"Length of the _axes array.","line":115,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_buttons","type":["array"],"help":"","inlineHelp":"Array of Phaser.GamepadButton objects. This array is populated when the gamepad is connected.","line":97,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_buttonsLen","type":["number"],"help":"","inlineHelp":"Length of the _buttons array.","line":103,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_prevTimestamp","type":["number"],"help":"","inlineHelp":"Used to check for differences between earlier polls and current state of gamepads.","line":91,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_rawPad","type":["object"],"help":"","inlineHelp":"The 'raw' gamepad data.","line":85,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"padParent","type":["Phaser.Gamepad"],"help":"","inlineHelp":"Main Phaser Gamepad object","line":79,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Sound.json b/docgen/output/Phaser.Sound.json deleted file mode 100644 index 123dc0b5d..000000000 --- a/docgen/output/Phaser.Sound.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Sound","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Reference to the current game instance.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"Default value for the volume, between 0 and 1.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"}],"help":"The Sound class constructor."},"consts":[],"methods":{"public":[{"name":"addMarker","static":false,"returns":null,"help":"Adds a marker into the current Sound. A marker is represented by a unique key and a start time and duration.\\nThis allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.","line":346,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"A unique name for this marker, i.e. 'explosion', 'gunshot', etc.","optional":false,"default":null},{"name":"start","type":["number"],"help":"The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"The volume the sound will play back at, between 0 (silent) and 1 (full volume).","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Sets if the sound will loop or not.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this sound and all associated events and removes it from the SoundManager.","line":881,"public":true,"protected":false,"private":false,"parameters":[{"name":"remove","type":["boolean"],"help":"If true this Sound is automatically removed from the SoundManager.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"fadeIn","static":false,"returns":null,"help":"Starts this sound playing (or restarts it if already doing so) and sets the volume to zero.\\nThen increases the volume from 0 to 1 over the duration specified.\\nAt the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,\\nand the final volume (1) as the second parameter.","line":799,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time in milliseconds over which the Sound should fade in.","optional":true,"default":"1000"},{"name":"loop","type":["boolean"],"help":"Should the Sound be set to loop? Note that this doesn't cause the fade to repeat.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"fadeOut","static":false,"returns":null,"help":"Decreases the volume of this Sound from its current value to 0 over the duration specified.\\nAt the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,\\nand the final volume (0) as the second parameter.","line":822,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time in milliseconds over which the Sound should fade out.","optional":true,"default":"1000"}],"inherited":false,"inheritedFrom":""},{"name":"fadeTo","static":false,"returns":null,"help":"Fades the volume of this Sound from its current value to the given volume over the duration specified.\\nAt the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,\\nand the final volume (volume) as the second parameter.","line":837,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time in milliseconds during which the Sound should fade out.","optional":true,"default":"1000"},{"name":"volume","type":["number"],"help":"The volume which the Sound should fade to. This is a value between 0 and 1.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pause","static":false,"returns":null,"help":"Pauses the sound.","line":673,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Sound"],"help":"This sound instance."},"help":"Play this sound, or a marked section of it.","line":448,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"If you want to play a marker then give the key here, otherwise leave blank to play the full sound.","optional":true,"default":"''"},{"name":"position","type":["number"],"help":"The starting position to play the sound from - this is ignored if you provide a marker.","optional":true,"default":"0"},{"name":"volume","type":["number"],"help":"Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Loop when it finished playing?","optional":true,"default":"false"},{"name":"forceRestart","type":["boolean"],"help":"If the sound is already playing you can set forceRestart to restart it from the beginning.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"removeMarker","static":false,"returns":null,"help":"Removes a marker from the sound.","line":368,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The key of the marker to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"restart","static":false,"returns":null,"help":"Restart the sound, or a marked section of it.","line":657,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"If you want to play a marker then give the key here, otherwise leave blank to play the full sound.","optional":true,"default":"''"},{"name":"position","type":["number"],"help":"The starting position to play the sound from - this is ignored if you provide a marker.","optional":true,"default":"0"},{"name":"volume","type":["number"],"help":"Volume of the sound you want to play.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Loop when it finished playing?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"resume","static":false,"returns":null,"help":"Resumes the sound.","line":691,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop playing this sound.","line":744,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"soundHasUnlocked","static":false,"returns":null,"help":"Called automatically when this sound is unlocked.","line":325,"public":false,"protected":true,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The Phaser.Cache key of the sound file to check for decoding.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Called automatically by Phaser.SoundManager.","line":379,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"fadeComplete","static":false,"returns":null,"help":"Internal handler for Sound.fadeIn, Sound.fadeOut and Sound.fadeTo.","line":864,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"allowMultiple","type":["boolean"],"help":"","inlineHelp":"This will allow you to have multiple instances of this Sound playing at once. This is only useful when running under Web Audio, and we recommend you implement a local pooling system to not flood the sound channels.","line":144,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoplay","type":["boolean"],"help":"","inlineHelp":"Boolean indicating whether the sound should start automatically.","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["AudioContext"],"help":"","inlineHelp":"Reference to the AudioContext instance.","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentMarker","type":["string"],"help":"","inlineHelp":"The string ID of the currently playing marker, if any.","line":126,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentTime","type":["number"],"help":"","inlineHelp":"The current time the sound is at.","line":78,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"duration","type":["number"],"help":"","inlineHelp":"The duration of the current sound marker in seconds.","line":83,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"durationMS","type":["number"],"help":"","inlineHelp":"The duration of the current sound marker in ms.","line":88,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"externalNode","type":["object"],"help":"","inlineHelp":"If defined this Sound won't connect to the SoundManager master gain node, but will instead connect to externalNode.","line":160,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"gainNode","type":["object"],"help":"","inlineHelp":"The gain node in a Web Audio system.","line":170,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running Game.","inlineHelp":"","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isDecoded","type":["boolean"],"help":"","inlineHelp":"Returns true if the sound file has decoded.","line":932,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"isDecoding","type":["boolean"],"help":"","inlineHelp":"Returns true if the sound file is still decoding.","line":919,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"isPlaying","type":["boolean"],"help":"","inlineHelp":"true if the sound is currently playing, otherwise false.","line":120,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"","inlineHelp":"Asset key for the sound.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loop","type":["boolean"],"help":"","inlineHelp":"Whether or not the sound or current sound marker will loop.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"markers","type":["object"],"help":"","inlineHelp":"The sound markers.","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"masterGainNode","type":["object"],"help":"","inlineHelp":"The master gain node in a Web Audio system.","line":165,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mute","type":["boolean"],"help":"","inlineHelp":"Gets or sets the muted state of this sound.","line":944,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"Name of the sound.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDecoded","type":["Phaser.Signal"],"help":"","inlineHelp":"The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)","line":214,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onFadeComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"The onFadeComplete event is dispatched when this sound finishes fading either in or out.","line":254,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoop","type":["Phaser.Signal"],"help":"","inlineHelp":"The onLoop event is dispatched when this sound loops during playback.","line":234,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMarkerComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"The onMarkerComplete event is dispatched when a marker within this sound completes playback.","line":249,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onMute","type":["Phaser.Signal"],"help":"","inlineHelp":"The onMouse event is dispatched when this sound is muted.","line":244,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPause","type":["Phaser.Signal"],"help":"","inlineHelp":"The onPause event is dispatched when this sound is paused.","line":224,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPlay","type":["Phaser.Signal"],"help":"","inlineHelp":"The onPlay event is dispatched each time this sound is played.","line":219,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResume","type":["Phaser.Signal"],"help":"","inlineHelp":"The onResume event is dispatched when this sound is resumed from a paused state.","line":229,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onStop","type":["Phaser.Signal"],"help":"","inlineHelp":"The onStop event is dispatched when this sound stops playback.","line":239,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"override","type":["boolean"],"help":"","inlineHelp":"if true when you play this sound it will always start from the beginning.","line":138,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"","inlineHelp":"true if the sound is paused, otherwise false.","line":104,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pausedPosition","type":["number"],"help":"","inlineHelp":"The position the sound had reached when it was paused.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pausedTime","type":["number"],"help":"","inlineHelp":"The game time at which the sound was paused.","line":114,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pendingPlayback","type":["boolean"],"help":"","inlineHelp":"true if the sound file is pending playback","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"position","type":["number"],"help":"","inlineHelp":"The position of the current sound marker.","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"startTime","type":["number"],"help":"","inlineHelp":"The time the Sound starts at (typically 0 unless starting from a marker)","line":73,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stopTime","type":["number"],"help":"","inlineHelp":"The time the sound stopped.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"totalDuration","type":["number"],"help":"","inlineHelp":"The total duration of the sound in seconds.","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"usingAudioTag","type":["boolean"],"help":"","inlineHelp":"true if the sound is being played via the Audio tag.","line":155,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"usingWebAudio","type":["boolean"],"help":"","inlineHelp":"true if this sound is being played with Web Audio.","line":150,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"volume","type":["number"],"help":"","inlineHelp":"Gets or sets the volume of this sound, a value between 0 and 1.","line":996,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_buffer","type":["any"],"help":"","inlineHelp":"Decoded data buffer \/ Audio tag.","line":266,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_muteVolume","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":296,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_muted","type":["boolean"],"help":"","inlineHelp":"Boolean indicating whether the sound is muted or not.","line":272,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onDecodedEventDispatched","type":["boolean"],"help":"","inlineHelp":"Was the onDecoded event dispatched?","line":314,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_paused","type":["boolean"],"help":"","inlineHelp":"Was this sound paused via code or a game event?","line":308,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempLoop","type":["boolean"],"help":"","inlineHelp":"Internal cache var.","line":302,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempMarker","type":["number"],"help":"","inlineHelp":"Internal marker var.","line":278,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempPosition","type":["number"],"help":"","inlineHelp":"Internal marker var.","line":284,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempVolume","type":["number"],"help":"","inlineHelp":"Internal marker var.","line":290,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_volume","type":["number"],"help":"","inlineHelp":"The global audio volume. A value between 0 (silence) and 1 (full volume).","line":260,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.SoundManager.json b/docgen/output/Phaser.SoundManager.json deleted file mode 100644 index 3c087f151..000000000 --- a/docgen/output/Phaser.SoundManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.SoundManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" reference to the current game instance.","optional":false,"default":null}],"help":"The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it.\\nNote: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files.\\nThe audio file type and the encoding of those files are extremely important. Not all browsers can play all audio formats.\\nThere is a good guide to what's supported here: http:\/\/hpr.dogphilosophy.net\/test\/"},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Sound"],"help":"The new sound instance."},"help":"Adds a new Sound into the SoundManager.","line":355,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"Default value for the volume.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"},{"name":"connect","type":["boolean"],"help":"Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"addSprite","static":false,"returns":{"types":["Phaser.AudioSprite"],"help":"The new AudioSprite instance."},"help":"Adds a new AudioSprite into the SoundManager.","line":376,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"decode","static":false,"returns":null,"help":"Decode a sound by its assets key.","line":291,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Assets key of the sound to be decoded.","optional":false,"default":null},{"name":"sound","type":["Phaser.Sound"],"help":"Its buffer will be set to decoded data.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Stops all the sounds in the game, then destroys them and finally clears up any callbacks.","line":523,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pauseAll","static":false,"returns":null,"help":"Pauses all the sounds in the game.","line":255,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Sound"],"help":"The new sound instance."},"help":"Adds a new Sound into the SoundManager and starts it playing.","line":445,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"volume","type":["number"],"help":"Default value for the volume.","optional":true,"default":"1"},{"name":"loop","type":["boolean"],"help":"Whether or not the sound will loop.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"True if the sound was removed successfully, otherwise false."},"help":"Removes a Sound from the SoundManager. The removed Sound is destroyed before removal.","line":391,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound"],"help":"The sound object to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeByKey","static":false,"returns":{"types":["number"],"help":"The number of matching sound objects that were removed."},"help":"Removes all Sounds from the SoundManager that have an asset key matching the given value.\\nThe removed Sounds are destroyed before removal.","line":417,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key to match when removing sound objects.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resumeAll","static":false,"returns":null,"help":"Resumes every sound in the game.","line":272,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stopAll","static":false,"returns":null,"help":"Stops all the sounds in the game.","line":238,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"unlock","static":false,"returns":null,"help":"Enables the audio, usually after the first touch.","line":203,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates every sound in the game.","line":322,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Initialises the sound manager.","line":114,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"setMute","static":false,"returns":null,"help":"Internal mute handler called automatically by the Sound.mute setter.","line":461,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"unsetMute","static":false,"returns":null,"help":"Internal mute handler called automatically by the Sound.mute setter.","line":493,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"channels","type":["number"],"help":"","inlineHelp":"The number of audio channels to use in playback.","line":103,"default":"32","public":true,"protected":false,"private":false,"readOnly":false},{"name":"connectToMaster","type":["boolean"],"help":"","inlineHelp":"Used in conjunction with Sound.externalNode this allows you to stop a Sound node being connected to the SoundManager master gain node.","line":91,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["AudioContext"],"help":"","inlineHelp":"The AudioContext being used for playback.","line":67,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mute","type":["boolean"],"help":"","inlineHelp":"Gets or sets the muted state of the SoundManager. This effects all sounds in the game.","line":548,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"noAudio","type":["boolean"],"help":"","inlineHelp":"Has audio been disabled via the PhaserGlobal object? Useful if you need to use a 3rd party audio library instead.","line":85,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onSoundDecode","type":["Phaser.Signal"],"help":"","inlineHelp":"The event dispatched when a sound decodes (typically only for mp3 files)","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchLocked","type":["boolean"],"help":"","inlineHelp":"true if the audio system is currently locked awaiting a touch event.","line":97,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"usingAudioTag","type":["boolean"],"help":"","inlineHelp":"true if the sound is being played via the Audio tag.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"usingWebAudio","type":["boolean"],"help":"","inlineHelp":"true if this sound is being played with Web Audio.","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"volume","type":["number"],"help":"","inlineHelp":"Gets or sets the global volume of the SoundManager, a value between 0 and 1.","line":588,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_codeMuted","type":["boolean"],"help":"","inlineHelp":"Internal mute tracking var.","line":34,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_muted","type":["boolean"],"help":"","inlineHelp":"Internal mute tracking var.","line":41,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sounds","type":["array"],"help":"","inlineHelp":"An array containing all the sounds","line":61,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_unlockSource","type":["AudioContext"],"help":"","inlineHelp":"Internal unlock tracking var.","line":48,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_volume","type":["number"],"help":"","inlineHelp":"The global audio volume. A value between 0 (silence) and 1 (full volume).","line":55,"default":"1","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Sprite.json b/docgen/output/Phaser.Sprite.json deleted file mode 100644 index 98b32bc21..000000000 --- a/docgen/output/Phaser.Sprite.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Sprite","extends":"PIXI.Sprite","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"help":"Sprites are the lifeblood of your game, used for nearly everything visual.\\n\\nAt its most basic a Sprite consists of a set of coordinates and a texture that is rendered to the canvas.\\nThey also contain additional properties allowing for physics motion (via Sprite.body), input handling (via Sprite.input),\\nevents (via Sprite.events), animation (via Sprite.animations), camera culling and more. Please see the Examples for use cases."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"bringToTop","static":false,"returns":{"types":[],"help":[]},"help":"Brings the Sprite to the top of the display list it is a child of. Sprites that are members of a Phaser.Group are only\\nbought to the top of that Group, not the entire display list.","line":797,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"crop","static":false,"returns":null,"help":"Crop allows you to crop the texture used to display this Sprite.\\nThis modifies the core Sprite texture frame, so the Sprite width\/height properties will adjust accordingly.\\n\\nCropping takes place from the top-left of the Sprite and can be modified in real-time by either providing an updated rectangle object to Sprite.crop,\\nor by modifying Sprite.cropRect (or a reference to it) and then calling Sprite.updateCrop.\\n\\nThe rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.\\nA reference to the rectangle is stored in Sprite.cropRect unless the `copy` parameter is `true` in which case the values are duplicated to a local object.","line":512,"public":true,"protected":false,"private":false,"parameters":[{"name":"rect","type":["Phaser.Rectangle"],"help":"The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.","optional":false,"default":null},{"name":"copy","type":["boolean"],"help":"If false Sprite.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Sprite.cropRect object.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"damage","static":false,"returns":{"types":[],"help":[]},"help":"Damages the Sprite, this removes the given amount from the Sprites health property.\\nIf health is then taken below or is equal to zero `Sprite.kill` is called.","line":735,"public":true,"protected":false,"private":false,"parameters":[{"name":"amount","type":["number"],"help":"The amount to subtract from the Sprite.health value.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the Sprite. This removes it from its parent group, destroys the input, event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":642,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"kill","static":false,"returns":{"types":[],"help":[]},"help":"Kills a Sprite. A killed Sprite has its alive, exists and visible properties all set to false.\\nIt will dispatch the onKilled event, you can listen to Sprite.events.onKilled for the signal.\\nNote that killing a Sprite is a way for you to quickly recycle it in a Sprite pool, it doesn't free it up from memory.\\nIf you don't need this Sprite any more you should call Sprite.destroy instead.","line":619,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the Sprite is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":359,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":true,"default":null},{"name":"stopAnimation","type":["boolean"],"help":"If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"overlap","static":false,"returns":{"types":["boolean"],"help":"True if the bounds of this Sprite intersects at any point with the bounds of the given display object."},"help":"Checks to see if the bounds of this Sprite overlaps with the bounds of the given Display Object, which can be a Sprite, Image, TileSprite or anything that extends those such as a Button.\\nThis check ignores the Sprites hitArea property and runs a Sprite.getBounds comparison on both objects to determine the result.\\nTherefore it's relatively expensive to use in large quantities (i.e. with lots of Sprites at a high frequency), but should be fine for low-volume testing where physics isn't required.","line":839,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["Phaser.Sprite","Phaser.Image","Phaser.TileSprite","Phaser.Button","PIXI.DisplayObject"],"help":"The display object to check against.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"A reference to playing Animation instance."},"help":"Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()\\nIf the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.","line":820,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be played, e.g. \"fire\", \"walk\", \"jump\".","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":322,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"preUpdate","static":false,"returns":{"types":["boolean"],"help":"True if the Sprite was rendered, otherwise false."},"help":"Automatically called by World.preUpdate.","line":204,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":[],"help":[]},"help":"Resets the Sprite. This places the Sprite at the given x\/y world coordinates and then\\nsets alive, exists, visible and renderable all to true. Also resets the outOfBounds state and health values.\\nIf the Sprite has a physics body that too is reset.","line":763,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"health","type":["number"],"help":"The health to give the Sprite.","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"resetFrame","static":false,"returns":null,"help":"Resets the Texture frame dimensions that the Sprite uses for rendering.","line":488,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"revive","static":false,"returns":{"types":[],"help":[]},"help":"Brings a 'dead' Sprite back to life, optionally giving it the health value specified.\\nA resurrected Sprite has its alive, exists and visible properties all set to true.\\nIt will dispatch the onRevived event, you can listen to Sprite.events.onRevived for the signal.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"health","type":["number"],"help":"The health to give the Sprite.","optional":true,"default":"1"}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the Sprite uses for rendering.\\nThis is primarily an internal method used by Sprite.loadTexture, although you may call it directly.","line":435,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the Sprite texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Sprite"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.\\nRemember if this Sprite has any children you should call update on them too.","line":312,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCrop","static":false,"returns":null,"help":"If you have set a crop rectangle on this Sprite via Sprite.crop and since modified the Sprite.cropRect property (or the rectangle it references)\\nthen you need to update the crop frame by calling this method.","line":550,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"A useful boolean to control if the Sprite is alive or dead (in terms of your gameplay, it doesn't effect rendering). Also linked to Sprite.health and Sprite.damage.","line":108,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Sprite in degrees.","line":853,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Sprite be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Sprite should be automatically camera culled or not.","line":84,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"body","type":["Phaser.Physics.Arcade.Body","Phaser.Physics.P2.Body","Phaser.Physics.Ninja.Body","null"],"help":"By default Sprites won't add themselves to any physics system and their physics body will be `null`.\\nTo enable them for physics you need to call `game.physics.enable(sprite, system)` where `sprite` is this object\\nand `system` is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via `Sprite.body`.\\n\\nImportant: Enabling a Sprite for P2 or Ninja physics will automatically set `Sprite.anchor` to 0.5 so the physics body is centered on the Sprite.\\nIf you need a different result then adjust or re-create the Body shape offsets manually, and\/or reset the anchor after enabling physics.","inlineHelp":"","line":102,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":147,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkWorldBounds","type":["boolean"],"help":"If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds\\nand optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its\\nbounds every frame to support it, and not all games need it. Enable it by setting the value to true.","inlineHelp":"","line":130,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"cropRect","type":["Phaser.Rectangle"],"help":"","inlineHelp":"The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.","line":153,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"Handy flag to use with Game.enableStep","line":142,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaX","type":["number"],"help":"Returns the delta x value. The difference between world.x now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was to the right, negative if to the left.","line":876,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaY","type":["number"],"help":"Returns the delta y value. The difference between world.y now and in the previous step.","inlineHelp":"The delta value. Positive if the motion was downwards, negative if upwards.","line":893,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"deltaZ","type":["number"],"help":"Returns the delta z value. The difference between rotation now and in the previous step.","inlineHelp":"The delta value.","line":910,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":1212,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"Sprite.exists controls if the core game loop and physics update this Sprite or not.\\nWhen you set Sprite.exists to false it will remove its Body from the physics world (if it has one) and also set Sprite.visible to false.\\nSetting Sprite.exists to true will re-add the Body to the physics world (if it has a body) and set Sprite.visible to true.","inlineHelp":"If the Sprite is processed by the core game update and physics.","line":1050,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Sprite that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Sprite.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Sprite was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Sprite to the Camera at its current world coordinates.","line":1097,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":958,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame name and updates the Texture Cache for display.","line":974,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"health","type":["number"],"help":"","inlineHelp":"Health value. Used in combination with damage() to allow for quick killing of Sprites.","line":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inCamera","type":["boolean"],"help":"Checks if the Sprite bounds are within the game camera, otherwise false if fully outside of it.","inlineHelp":"True if the Sprite bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.","line":944,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"inWorld","type":["boolean"],"help":"Checks if the Sprite bounds are within the game world, otherwise false if fully outside of it.","inlineHelp":"True if the Sprite bounds is within the game world, even if only partially. Otherwise false if fully outside of it.","line":927,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Sprite won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":1008,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lifespan","type":["number"],"help":"If you would like the Sprite to have a lifespan once 'born' you can set this to a positive value. Handy for particles, bullets, etc.\\nThe lifespan is decremented by game.time.elapsed each update, once it reaches zero the kill() function is called.","inlineHelp":"The lifespan of the Sprite (in ms) before it will be killed.","line":121,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Sprite.","line":39,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"outOfBoundsKill","type":["boolean"],"help":"","inlineHelp":"If true Sprite.kill is called as soon as Sprite.inWorld returns false, as long as Sprite.checkWorldBounds is true.","line":136,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderOrderID","type":["number"],"help":"","inlineHelp":"The render order ID, reset every frame.","line":991,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"Enable or disable texture smoothing for this Sprite. Only works for bitmap\/image textures. Smoothing is enabled by default.","inlineHelp":"Set to true to smooth the texture of this Sprite, or false to disable smoothing (great for pixel art)","line":1126,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the Sprite on the x axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Sprite on the x axis relative to the local coordinates of the parent.","line":1160,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the Sprite on the y axis relative to the local coordinates of the parent.","inlineHelp":"The position of the Sprite on the y axis relative to the local coordinates of the parent.","line":1187,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_bounds","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":188,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_cache","type":["array"],"help":"A small internal cache:\\n\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":170,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_crop","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":176,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frame","type":["Phaser.Rectangle"],"help":"","inlineHelp":"Internal cache var.","line":182,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.SpriteBatch.json b/docgen/output/Phaser.SpriteBatch.json deleted file mode 100644 index bdc361f17..000000000 --- a/docgen/output/Phaser.SpriteBatch.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.SpriteBatch","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"parent","type":["Phaser.Group","Phaser.Sprite","null"],"help":"The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If `undefined` or `null` it will use game.world.","optional":false,"default":null},{"name":"name","type":["string"],"help":"A name for this Group. Not used internally but useful for debugging.","optional":true,"default":"group"},{"name":"addToStage","type":["boolean"],"help":"If set to true this Group will be added directly to the Game.Stage instead of Game.World.","optional":true,"default":"false"}],"help":"The SpriteBatch class is a really fast version of the DisplayObjectContainer built purely for speed, so use when you need a lot of sprites or particles.\\nIt's worth mentioning that by default sprite batches are used through-out the renderer, so you only really need to use a SpriteBatch if you have over\\n1000 sprites that all share the same texture (or texture atlas). It's also useful if running in Canvas mode and you have a lot of un-rotated or un-scaled\\nSprites as it skips all of the Canvas setTransform calls, which helps performance, especially on mobile devices."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A name for this Group. Not used internally but useful for debugging.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the Group container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The x coordinate of the Group container.","line":1865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The y coordinate of the Group container.","line":1872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"type","type":["number"],"help":"","inlineHelp":"Internal Phaser Type value.","line":33,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Stage.json b/docgen/output/Phaser.Stage.json deleted file mode 100644 index c1f01d326..000000000 --- a/docgen/output/Phaser.Stage.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Stage","extends":"PIXI.Stage","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null}],"help":"The Stage controls root level display objects upon which everything is displayed.\\nIt also handles browser visibility handling and the pausing due to loss of focus."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"checkVisibility","static":false,"returns":null,"help":"Starts a page visibility event listener running, or window.blur\/focus if not supported by the browser.","line":200,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getMousePosition","static":false,"returns":{"types":["Phaser.Point"],"help":"A point containing the coordinates of the global InteractionData position."},"help":"This will return the point containing global coordinates of the mouse.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"This is called automatically before the renderer runs and after the plugins have updated.\\nIn postUpdate this is where all the final physics calculatations and object positioning happens.\\nThe objects are processed in the order of the display list.\\nThe only exception to this is if the camera is following an object, in which case that is updated first.","line":164,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"This is called automatically after the plugins preUpdate and before the State.update.\\nMost objects have preUpdate methods and it's where initial movement and positioning is done.","line":126,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setBackgroundColor","static":false,"returns":null,"help":"Sets the background color for the stage\\n\\nlike: 0xFFFFFF for white","line":117,"public":true,"protected":false,"private":false,"parameters":[{"name":"backgroundColor","type":["number"],"help":"the color of the background, easiest way to pass this in is in hex format","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setInteractionDelegate","static":false,"returns":null,"help":"Sets another DOM element which can receive mouse\/touch interactions instead of the default Canvas element.\\nThis is useful for when you have other DOM elements on top of the Canvas element.","line":80,"public":true,"protected":false,"private":false,"parameters":[{"name":"domElement","type":["DOMElement"],"help":"This new domElement which will receive mouse\/touch events","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Stage"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"This is called automatically after the State.update, but before particles or plugins update.","line":145,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"visibilityChange","static":false,"returns":null,"help":"This method is called when the document visibility is changed.","line":256,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"Its type will be used to decide whether the game should be paused or not.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"parseConfig","static":false,"returns":null,"help":"Parses a Game configuration object.","line":84,"public":false,"protected":true,"private":false,"parameters":[{"name":"config","type":["object"],"help":"The configuration object to parse.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"boot","static":false,"returns":null,"help":"Initialises the stage and adds the event listeners.","line":103,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"backgroundColor","type":["number","string"],"help":"","inlineHelp":"Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000'","line":336,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"currentRenderOrderID","type":["number"],"help":"","inlineHelp":"Reset each frame, keeps a count of the total number of objects updated.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disableVisibilityChange","type":["boolean"],"help":"","inlineHelp":"By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true.","line":42,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Stage and all children are updated, otherwise it is skipped.","line":48,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactionManager","type":["PIXI.InteractionManager"],"help":"The interaction manage for this stage, manages all interactive activity on the stage","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Whether or not the stage is interactive","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The name of this object.","line":29,"default":"'_stage_root'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"smoothed","type":["boolean"],"help":"Enable or disable texture smoothing for all objects on this Stage. Only works for bitmap\/image textures. Smoothing is enabled by default.","inlineHelp":"Set to true to smooth all sprites rendered on this Stage, or false to disable smoothing (great for pixel art)","line":361,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_backgroundColor","type":["number"],"help":"","inlineHelp":"Stage background color.","line":65,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"hiddenVar","type":["string"],"help":"","inlineHelp":"The page visibility API event name.","line":59,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"","inlineHelp":"Pixi level var, ignored by Phaser.","line":36,"default":"false","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.State.json b/docgen/output/Phaser.State.json deleted file mode 100644 index 32564b7ae..000000000 --- a/docgen/output/Phaser.State.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.State","extends":"","static":false,"constructor":true,"parameters":[],"help":"This is a base State class which can be extended if you are creating your own game.\\nIt provides quick access to common functions such as the camera, cache, input, match, sound and more."},"consts":[],"methods":{"public":[{"name":"create","static":false,"returns":null,"help":"create is called once preload has completed, this includes the loading of any assets from the Loader.\\nIf you don't have a preload method then create is the first method called in your State.","line":138,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadRender","static":false,"returns":null,"help":"loadRender is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.\\nThe difference between loadRender and render is that any objects you render in this method you must be sure their assets exist.","line":129,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadUpdate","static":false,"returns":null,"help":"loadUpdate is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.","line":120,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pauseUpdate","static":false,"returns":null,"help":"pauseUpdate is called while the game is paused instead of preUpdate, update and postUpdate.","line":182,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"paused","static":false,"returns":null,"help":"This method will be called if the core game loop is paused.","line":174,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preload","static":false,"returns":null,"help":"preload is called first. Normally you'd use this to load your game assets (or those needed for the current State)\\nYou shouldn't create any objects in this method that require assets that you're also loading in this method, as\\nthey won't yet be available.","line":112,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Nearly all display objects in Phaser render automatically, you don't need to tell them to render.\\nHowever the render method is called AFTER the game renderer and plugins have rendered, so you're able to do any\\nfinal post-processing style effects here. Note that this happens before plugins postRender takes place.","line":158,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"If your game is set to Scalemode RESIZE then each time the browser resizes it will call this function, passing in the new width and height.","line":166,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"shutdown","static":false,"returns":null,"help":"This method will be called when the State is shutdown (i.e. you switch to another state from this one).","line":190,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"The update method is left empty for your own use.\\nIt is called during the core game loop AFTER debug, physics, plugins and the Stage have had their preUpdate methods called.\\nIf is called BEFORE Stage, Tweens, Sounds, Input, Physics, Particles and Plugins have had their postUpdate methods called.","line":148,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"add","type":["Phaser.GameObjectFactory"],"help":"","inlineHelp":"A reference to the GameObjectFactory which can be used to add new objects to the World.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cache","type":["Phaser.Cache"],"help":"","inlineHelp":"A reference to the game cache which contains any loaded or generated assets, such as images, sound and more.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"camera","type":["Phaser.Camera"],"help":"","inlineHelp":"A handy reference to World.camera.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"This is a reference to the currently running Game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.Input"],"help":"","inlineHelp":"A reference to the Input Manager.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"load","type":["Phaser.Loader"],"help":"","inlineHelp":"A reference to the Loader, which you mostly use in the preload method of your state to load external assets.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"make","type":["Phaser.GameObjectCreator"],"help":"","inlineHelp":"A reference to the GameObjectCreator which can be used to make new objects.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"math","type":["Phaser.Math"],"help":"","inlineHelp":"A reference to Math class with lots of helpful functions.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"particles","type":["Phaser.Particles"],"help":"","inlineHelp":"The Particle Manager. It is called during the core gameloop and updates any Particle Emitters it has created.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physics","type":["Phaser.Physics"],"help":"","inlineHelp":"A reference to the physics manager which looks after the different physics systems available within Phaser.","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rnd","type":["Phaser.RandomDataGenerator"],"help":"","inlineHelp":"A reference to the seeded and repeatable random data generator.","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"A reference to the Scale Manager which controls the way the game scales on different displays.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sound","type":["Phaser.SoundManager"],"help":"","inlineHelp":"A reference to the Sound Manager which can create, play and stop sounds, as well as adjust global volume.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["Phaser.Stage"],"help":"","inlineHelp":"A reference to the Stage.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"time","type":["Phaser.Time"],"help":"","inlineHelp":"A reference to the game clock and timed events system.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tweens","type":["Phaser.TweenManager"],"help":"","inlineHelp":"A reference to the tween manager.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"A reference to the game world. All objects live in the Game World and its size is not bound by the display resolution.","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.StateManager.json b/docgen/output/Phaser.StateManager.json deleted file mode 100644 index bab2b0c7c..000000000 --- a/docgen/output/Phaser.StateManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.StateManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"pendingState","type":["Phaser.State","object"],"help":"A State object to seed the manager with.","optional":true,"default":"null"}],"help":"The State Manager is responsible for loading, setting up and switching game states."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":null,"help":"Adds a new State into the StateManager. You must give each State a unique key by which you'll identify it.\\nThe State can be either a Phaser.State object (or an object that extends it), a plain JavaScript object or a function.\\nIf a function is given a new state object will be created by calling it.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"A unique key you use to reference this state, i.e. \"MainMenu\", \"Level1\".","optional":false,"default":null},{"name":"state","type":["Phaser.State","object","function"],"help":" - The state you want to switch to.","optional":false,"default":null},{"name":"autoStart","type":["boolean"],"help":" - If true the State will be started immediately after adding it.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"checkState","static":false,"returns":{"types":["boolean"],"help":"true if the State has the required functions, otherwise false."},"help":"Checks if a given phaser state is valid. A State is considered valid if it has at least one of the core functions: preload, create, update or render.","line":422,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the state you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearCurrentState","static":false,"returns":null,"help":"This method clears the current State, calling its shutdown callback. The process also removes any active tweens,\\nresets the camera, resets input, clears physics, removes timers and if set clears the world and cache too.","line":371,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Removes all StateManager callback references to the State object, nulls the game reference and clears the States object.\\nYou don't recover from this without rebuilding the Phaser instance again.","line":723,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getCurrentState","static":false,"returns":{"types":[],"help":[]},"help":"Gets the current State.","line":570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"preUpdate is called right at the start of the game loop. It is responsible for changing to a new state that was requested previously.","line":311,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Delete the given state.","line":214,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"A unique key you use to reference this state, i.e. \"MainMenu\", \"Level1\".","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"restart","static":false,"returns":null,"help":"Restarts the current State. State.shutDown will be called (if it exists) before the State is restarted.","line":281,"public":true,"protected":false,"private":false,"parameters":[{"name":"clearWorld","type":["boolean"],"help":"Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly)","optional":true,"default":"true"},{"name":"clearCache","type":["boolean"],"help":"Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well.","optional":true,"default":"false"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the State.init function if it has one.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Start the given State. If a State is already running then State.shutDown will be called (if it exists) before switching to the new State.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the state you want to start.","optional":false,"default":null},{"name":"clearWorld","type":["boolean"],"help":"Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly)","optional":true,"default":"true"},{"name":"clearCache","type":["boolean"],"help":"Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well.","optional":true,"default":"false"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the State.init function (if it has one).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"link","static":false,"returns":null,"help":"Links game properties to the State given by the key.","line":458,"public":false,"protected":true,"private":false,"parameters":[{"name":"key","type":["string"],"help":"State key.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"loadComplete","static":false,"returns":null,"help":"","line":578,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pause","static":false,"returns":null,"help":"","line":599,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pauseUpdate","static":false,"returns":null,"help":"","line":645,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preRender","static":false,"returns":null,"help":"","line":665,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"","line":691,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"","line":678,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resume","static":false,"returns":null,"help":"","line":612,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"unlink","static":false,"returns":null,"help":"Nulls all State level Phaser properties, including a reference to Game.","line":488,"public":false,"protected":true,"private":false,"parameters":[{"name":"key","type":["string"],"help":"State key.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"","line":625,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"boot","static":false,"returns":null,"help":"The Boot handler is called by Phaser.Game when it first starts up.","line":143,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"dummy","static":false,"returns":null,"help":"Used by onInit and onShutdown when those functions don't exist on the state","line":303,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setCurrentState","static":false,"returns":null,"help":"Sets the current State. Should not be called directly (use StateManager.start)","line":521,"public":false,"protected":false,"private":true,"parameters":[{"name":"key","type":["string"],"help":"State key.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"current","type":["string"],"help":"","inlineHelp":"The current active State object (defaults to null).","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onCreateCallback","type":["function"],"help":"","inlineHelp":"This is called when the state preload has finished and creation begins.","line":82,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onInitCallback","type":["function"],"help":"","inlineHelp":"This is called when the state is set as the active state.","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoadRenderCallback","type":["function"],"help":"","inlineHelp":"This is called when the State is rendered during the preload phase.","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoadUpdateCallback","type":["function"],"help":"","inlineHelp":"This is called when the State is updated during the preload phase.","line":107,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPauseUpdateCallback","type":["function"],"help":"","inlineHelp":"This is called every frame while the game is paused.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPausedCallback","type":["function"],"help":"","inlineHelp":"This is called when the game is paused.","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPreRenderCallback","type":["function"],"help":"","inlineHelp":"This is called before the state is rendered and before the stage is cleared.","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onPreloadCallback","type":["function"],"help":"","inlineHelp":"This is called when the state starts to load assets.","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onRenderCallback","type":["function"],"help":"","inlineHelp":"This is called post-render. It doesn't happen during preload (see onLoadRenderCallback).","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResizeCallback","type":["function"],"help":"","inlineHelp":"This is called if ScaleManager.scalemode is RESIZE and a resize event occurs. It's passed the new width and height.","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onResumedCallback","type":["function"],"help":"","inlineHelp":"This is called when the game is resumed from a paused state.","line":122,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onShutDownCallback","type":["function"],"help":"","inlineHelp":"This is called when the state is shut down (i.e. swapped to another state).","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onUpdateCallback","type":["function"],"help":"","inlineHelp":"This is called when the state is updated, every game loop. It doesn't happen during preload (@see onLoadUpdateCallback).","line":87,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"states","type":["object"],"help":"","inlineHelp":"The object containing Phaser.States.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_args","type":["array"],"help":"","inlineHelp":"Temporary container when you pass vars from one State to another.","line":62,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_clearCache","type":["boolean"],"help":"","inlineHelp":"Clear the cache when we switch state?","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_clearWorld","type":["boolean"],"help":"","inlineHelp":"Clear the world when we switch state?","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_created","type":["boolean"],"help":"","inlineHelp":"Flag that sets if the State has been created or not.","line":56,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pendingState","type":["Phaser.State"],"help":"","inlineHelp":"The state to be switched to in the next frame.","line":33,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Text.json b/docgen/output/Phaser.Text.json deleted file mode 100644 index df8d84de9..000000000 --- a/docgen/output/Phaser.Text.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Text","extends":"PIXI.Text","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the new text object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new text object.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be written.","optional":false,"default":null},{"name":"style","type":["object"],"help":"The style object containing style attributes like font, font size ,","optional":false,"default":null}],"help":"Create a new `Text` object. This uses a local hidden Canvas object and renders the type into it. It then makes a texture from this for renderning to the view.\\nBecause of this you can only display fonts that are currently loaded and available to the browser. It won't load the fonts for you.\\nHere is a compatibility table showing the available default fonts across different mobile browsers: http:\/\/www.jordanm.co.uk\/tinytype"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addColor","static":false,"returns":null,"help":"This method allows you to set specific colors within the Text.\\nIt works by taking a color value, which is a typical HTML string such as `#ff0000` or `rgb(255,0,0)` and a position.\\nThe position value is the index of the character in the Text string to start applying this color to.\\nOnce set the color remains in use until either another color or the end of the string is encountered.\\nFor example if the Text was `Photon Storm` and you did `Text.addColor('#ffff00', 6)` it would color in the word `Storm` in yellow.","line":498,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["string"],"help":"A canvas fillstyle that will be used on the text eg `red`, `#00FF00`, `rgba()`.","optional":false,"default":null},{"name":"position","type":["number"],"help":"The index of the character in the string to start applying this color value from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearColors","static":false,"returns":null,"help":"Clears any previously set color stops.","line":480,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate.","line":211,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":162,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setShadow","static":false,"returns":null,"help":"","line":303,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.","optional":true,"default":"0"},{"name":"color","type":["string"],"help":"The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.","optional":true,"default":"'rgba(0,0,0,0)'"},{"name":"blur","type":["number"],"help":"The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStyle","static":false,"returns":null,"help":"Set the style of the text by passing a single style object to it.","line":326,"public":true,"protected":false,"private":false,"parameters":[{"name":"style","type":["object"],"help":"The style properties to be set on the Text.","optional":true,"default":null},{"name":"style.font","type":["string"],"help":" 20pt Arial'] - The style and size of the font.","optional":true,"default":"'bol"},{"name":"style.fill","type":["string"],"help":"A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.","optional":true,"default":"'black'"},{"name":"style.align","type":["string"],"help":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.","optional":true,"default":"'left'"},{"name":"style.stroke","type":["string"],"help":"A canvas stroke style that will be used on the text stroke eg 'blue', '#FCFF00'.","optional":true,"default":"'black'"},{"name":"style.strokeThickness","type":["number"],"help":"A number that represents the thickness of the stroke. Default is 0 (no stroke).","optional":true,"default":"0"},{"name":"style.wordWrap","type":["boolean"],"help":"Indicates if word wrap should be used.","optional":true,"default":"false"},{"name":"style.wordWrapWidth","type":["number"],"help":"The width in pixels at which text will wrap.","optional":true,"default":"100"}],"inherited":false,"inheritedFrom":""},{"name":"setText","static":false,"returns":null,"help":"Set the copy for the text object. To split a line you can use '\\n'.","line":153,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The copy that you would like the text to display","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Text"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":203,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"runWordWrap","static":false,"returns":null,"help":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal bounds.","line":512,"public":false,"protected":false,"private":true,"parameters":[{"name":"text","type":["string"],"help":"The text to perform word wrap detection against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateText","static":false,"returns":null,"help":"Renders text. This replaces the Pixi.Text.updateText function as we need a few extra bits in here.","line":352,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"align","type":["string"],"help":"","inlineHelp":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.","line":713,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Text, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead.","inlineHelp":"Gets or sets the angle of rotation in degrees.","line":561,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":119,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"colors","type":["array"],"help":"","inlineHelp":"An array of the color values as specified by `Text.addColor`.","line":124,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["HTMLCanvasElement"],"help":"The canvas 2d context that everything is drawn with","inlineHelp":"","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":1010,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Text isn't updated by the core game loop.","line":46,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fill","type":["object"],"help":"","inlineHelp":"A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.","line":691,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An Text that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Text.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Text was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Text to the Camera at its current world coordinates.","line":983,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"font","type":["string"],"help":"","inlineHelp":"The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.","line":605,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontSize","type":["number"],"help":"","inlineHelp":"The size of the font in pixels.","line":633,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontWeight","type":["number"],"help":"","inlineHelp":"The weight of the font: 'normal', 'bold', 'italic'. You can combine settings too, such as 'bold italic'.","line":663,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":114,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Text object won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":941,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineSpacing","type":["number"],"help":"","inlineHelp":"Additional spacing (in pixels) between each line of text if multi-line.","line":823,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this object.","line":52,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the canvas.","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowBlur","type":["number"],"help":"","inlineHelp":"The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).","line":916,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowColor","type":["string"],"help":"","inlineHelp":"The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.","line":894,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowOffsetX","type":["number"],"help":"","inlineHelp":"The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.","line":850,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowOffsetY","type":["number"],"help":"","inlineHelp":"The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.","line":872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"stroke","type":["string"],"help":"","inlineHelp":"A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'.","line":735,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"strokeThickness","type":["number"],"help":"","inlineHelp":"A number that represents the thickness of the stroke. Default is 0 (no stroke)","line":757,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"text","type":["string"],"help":"The text string to be displayed by this Text object, taking into account the style settings.","inlineHelp":"The text string to be displayed by this Text object, taking into account the style settings.","line":578,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":58,"default":"Phaser.TEXT","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wordWrap","type":["boolean"],"help":"","inlineHelp":"Indicates if word wrap should be used.","line":779,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wordWrapWidth","type":["number"],"help":"","inlineHelp":"The width at which text will wrap.","line":801,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":146,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_charCount","type":["number"],"help":"","inlineHelp":"Internal character counter used by the text coloring.","line":104,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_font","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fontSize","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fontWeight","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":92,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_text","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"lineSpacing","type":["number"],"help":"","inlineHelp":"Additional spacing (in pixels) between each line of text if multi-line.","line":98,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Tile.json b/docgen/output/Phaser.Tile.json deleted file mode 100644 index 51cc2c49a..000000000 --- a/docgen/output/Phaser.Tile.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Tile","extends":"","static":false,"constructor":true,"parameters":[{"name":"layer","type":["object"],"help":"The layer in the Tilemap data that this tile belongs to.","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index of this tile type in the core map data.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate of this tile.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate of this tile.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the tile.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the tile.","optional":false,"default":null}],"help":"A Tile is a representation of a single tile within the Tilemap."},"consts":[],"methods":{"public":[{"name":"containsPoint","static":false,"returns":{"types":["boolean"],"help":"True if the coordinates are within this Tile, otherwise false."},"help":"Check if the given x and y world coordinates are within this Tile.","line":154,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to test.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to test.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"copy","static":false,"returns":null,"help":"Copies the tile data and properties from the given tile to this tile.","line":301,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Tile"],"help":"The tile to copy from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clean up memory.","line":215,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"intersects","static":false,"returns":null,"help":"Check for intersection with this tile.","line":169,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x axis in pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y axis in pixels.","optional":false,"default":null},{"name":"right","type":["number"],"help":"The right point.","optional":false,"default":null},{"name":"bottom","type":["number"],"help":"The bottom point.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isInteresting","static":false,"returns":{"types":["boolean"],"help":"True if the Tile is interesting, otherwise false."},"help":"Is this tile interesting?","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"collides","type":["boolean"],"help":"If true will check any collides value.","optional":false,"default":null},{"name":"faces","type":["boolean"],"help":"If true will check any face value.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resetCollision","static":false,"returns":null,"help":"Reset collision status flags.","line":251,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setCollision","static":false,"returns":null,"help":"Sets the collision flags for each side of this tile and updates the interesting faces list.","line":232,"public":true,"protected":false,"private":false,"parameters":[{"name":"left","type":["boolean"],"help":"Indicating collide with any object on the left.","optional":false,"default":null},{"name":"right","type":["boolean"],"help":"Indicating collide with any object on the right.","optional":false,"default":null},{"name":"up","type":["boolean"],"help":"Indicating collide with any object on the top.","optional":false,"default":null},{"name":"down","type":["boolean"],"help":"Indicating collide with any object on the bottom.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionCallback","static":false,"returns":null,"help":"Set a callback to be called when this tile is hit by an object.\\nThe callback must true true for collision processing to take place.","line":203,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"Callback function.","optional":false,"default":null},{"name":"context","type":["object"],"help":"Callback will be called within this context.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"","inlineHelp":"The alpha value at which this tile is drawn to the canvas.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bottom","type":["number"],"help":"","inlineHelp":"The sum of the y and height properties.","line":391,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"canCollide","type":["boolean"],"help":"","inlineHelp":"True if this tile can collide on any of its faces or has a collision callback set.","line":339,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"collideDown","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the bottom.","line":128,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideLeft","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the left.","line":110,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideRight","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the right.","line":116,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collideUp","type":["boolean"],"help":"","inlineHelp":"Indicating collide with any object on the top.","line":122,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collides","type":["boolean"],"help":"","inlineHelp":"True if this tile can collide on any of its faces.","line":326,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"collisionCallback","type":["function"],"help":"","inlineHelp":"Tile collision callback.","line":134,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"collisionCallbackContext","type":["object"],"help":"","inlineHelp":"The context in which the collision callback will be called.","line":140,"default":"this","public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceBottom","type":["boolean"],"help":"","inlineHelp":"Is the bottom of this tile an interesting edge?","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceLeft","type":["boolean"],"help":"","inlineHelp":"Is the left of this tile an interesting edge?","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceRight","type":["boolean"],"help":"","inlineHelp":"Is the right of this tile an interesting edge?","line":104,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"faceTop","type":["boolean"],"help":"","inlineHelp":"Is the top of this tile an interesting edge?","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of the tile in pixels.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank\/null tile.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"layer","type":["object"],"help":"","inlineHelp":"The layer in the Tilemap data that this tile belongs to.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"left","type":["number"],"help":"","inlineHelp":"The x value in pixels.","line":352,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"properties","type":["object"],"help":"","inlineHelp":"Tile specific properties.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The sum of the x and width properties.","line":365,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scanned","type":["boolean"],"help":"","inlineHelp":"Has this tile been walked \/ turned into a poly?","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"top","type":["number"],"help":"","inlineHelp":"The y value.","line":378,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of the tile in pixels.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"The x map coordinate of this tile.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"The y map coordinate of this tile.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.TileSprite.json b/docgen/output/Phaser.TileSprite.json deleted file mode 100644 index cef7331ed..000000000 --- a/docgen/output/Phaser.TileSprite.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.TileSprite","extends":"PIXI.TilingSprite","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the TileSprite.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the TileSprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"help":"A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.\\nPlease note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling."},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"autoScroll","static":false,"returns":null,"help":"Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll().\\nThe scroll speed is specified in pixels per second.\\nA negative x value will scroll to the left. A positive x value will scroll to the right.\\nA negative y value will scroll up. A positive y value will scroll down.","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Horizontal scroll speed in pixels per second.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Vertical scroll speed in pixels per second.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":441,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTilingTexture","static":false,"returns":null,"help":"","line":379,"public":true,"protected":false,"private":false,"parameters":[{"name":"forcePowerOfTwo","type":["boolean"],"help":"Whether we want to force the texture to be a power of two","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.TilingSprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the framing rectangle of the sprite as a PIXI.Rectangle object","line":286,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.TilingSprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"loadTexture","static":false,"returns":null,"help":"Changes the Texture the TileSprite is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.\\nThis causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.","line":342,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"play","static":false,"returns":{"types":["Phaser.Animation"],"help":"A reference to playing Animation instance."},"help":"Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()\\nIf the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.","line":516,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the animation to be played, e.g. \"fire\", \"walk\", \"jump\".","optional":false,"default":null},{"name":"frameRate","type":["number"],"help":"The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.","optional":true,"default":"null"},{"name":"loop","type":["boolean"],"help":"Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.","optional":true,"default":"false"},{"name":"killOnComplete","type":["boolean"],"help":"If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"Internal function called by the World postUpdate cycle.","line":282,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":172,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"reset","static":false,"returns":{"types":[],"help":[]},"help":"Resets the TileSprite. This places the TileSprite at the given x\/y world coordinates, resets the tilePosition and then\\nsets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.\\nIf the TileSprite has a physics body that too is reset.","line":533,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the Sprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the Sprite at.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setFrame","static":false,"returns":null,"help":"Sets the Texture frame the TileSprite uses for rendering.\\nThis is primarily an internal method used by TileSprite.loadTexture, although you may call it directly.","line":393,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The Frame to be used by the TileSprite texture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"stopScroll","static":false,"returns":null,"help":"Stops an automatically scrolling TileSprite.","line":327,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":272,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"alive","type":["boolean"],"help":"","inlineHelp":"A useful boolean to control if the TileSprite is alive or dead (in terms of your gameplay, it doesn't effect rendering).","line":141,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.\\nValues outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.","inlineHelp":"The angle of this Sprite in degrees.","line":566,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"animations","type":["Phaser.AnimationManager"],"help":"","inlineHelp":"This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoCull","type":["boolean"],"help":"Should this Sprite be automatically culled if out of range of the camera?\\nA culled sprite has its renderable property set to 'false'.\\nBe advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.","inlineHelp":"A flag indicating if the Sprite should be automatically camera culled or not.","line":108,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite","inlineHelp":"","line":84,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"body","type":["Phaser.Physics.Arcade.Body","Phaser.Physics.P2.Body","Phaser.Physics.Ninja.Body","null"],"help":"By default Sprites won't add themselves to any physics system and their physics body will be `null`.\\nTo enable them for physics you need to call `game.physics.enable(sprite, system)` where `sprite` is this object\\nand `system` is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via `Sprite.body`.\\n\\nImportant: Enabling a Sprite for P2 or Ninja physics will automatically set `Sprite.anchor` to 0.5 so the physics body is centered on the Sprite.\\nIf you need a different result then adjust or re-create the Body shape offsets manually, and\/or reset the anchor after enabling physics.","inlineHelp":"","line":135,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":122,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"checkWorldBounds","type":["boolean"],"help":"If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds\\nand optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its\\nbounds every frame to support it, and not all games need it. Enable it by setting the value to true.","inlineHelp":"","line":117,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":801,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"TileSprite.exists controls if the core game loop and physics update this TileSprite or not.\\nWhen you set TileSprite.exists to false it will remove its Body from the physics world (if it has one) and also set TileSprite.visible to false.\\nSetting TileSprite.exists to true will re-add the Body to the physics world (if it has a body) and set TileSprite.visible to true.","inlineHelp":"If the TileSprite is processed by the core game update and physics.","line":663,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An TileSprite that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in TileSprite.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this TileSprite was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this TileSprite to the Camera at its current world coordinates.","line":632,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frame","type":["number"],"help":"","inlineHelp":"Gets or sets the current frame index and updates the Texture Cache for display.","line":586,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frameName","type":["string"],"help":"","inlineHelp":"Gets or sets the current frame name and updates the Texture Cache for display.","line":607,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the TilingSprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a TileSprite won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":709,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"","inlineHelp":"This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this Sprite.","line":40,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Whether this sprite is renderable or not","inlineHelp":"","line":66,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tilePosition","type":["Phaser.Point"],"help":"The offset position of the image that is being tiled","inlineHelp":"","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileScale","type":["Phaser.Point"],"help":"The scaling of the image that is being tiled","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileScaleOffset","type":["Phaser.Point"],"help":"A point that represents the scale of the texture object","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value","inlineHelp":"","line":75,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":101,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the TileSprite on the x axis relative to the local coordinates of the parent.","inlineHelp":"The position of the TileSprite on the x axis relative to the local coordinates of the parent.","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the TileSprite on the y axis relative to the local coordinates of the parent.","inlineHelp":"The position of the TileSprite on the y axis relative to the local coordinates of the parent.","line":776,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":157,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frame","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":72,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_frameName","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":78,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_scroll","type":["Phaser.Point"],"help":"","inlineHelp":"Internal cache var.","line":84,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Tilemap.json b/docgen/output/Phaser.Tilemap.json deleted file mode 100644 index 77a2f425e..000000000 --- a/docgen/output/Phaser.Tilemap.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Tilemap","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.","optional":true,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"width","type":["number"],"help":"The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"},{"name":"height","type":["number"],"help":"The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"}],"help":"Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.\\nTo do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.\\nWhen using CSV data you must provide the key and the tileWidth and tileHeight parameters.\\nIf creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.\\nNote that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.\\nA Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself.\\nA map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around."},"consts":[{"name":"CSV","type":"number","help":"","line":163},{"name":"EAST","type":"number","help":"","line":181},{"name":"NORTH","type":"number","help":"","line":175},{"name":"SOUTH","type":"number","help":"","line":187},{"name":"TILED_JSON","type":"number","help":"","line":169},{"name":"WEST","type":"number","help":"","line":193}],"methods":{"public":[{"name":"addTilesetImage","static":false,"returns":{"types":["Phaser.Tileset"],"help":"Returns the Tileset object that was created or updated, or null if it failed."},"help":"Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.\\nNote that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.","line":254,"public":true,"protected":false,"private":false,"parameters":[{"name":"tileset","type":["string"],"help":"The name of the tileset as specified in the map data.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The key of the Phaser.Cache image used for this tileset. If not specified it will look for an image with a key matching the tileset parameter.","optional":true,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value, if that isn't set then 32.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value, if that isn't set then 32.","optional":true,"default":"32"},{"name":"tileMargin","type":["number"],"help":"The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value.","optional":true,"default":"0"},{"name":"tileSpacing","type":["number"],"help":"The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value.","optional":true,"default":"0"},{"name":"gid","type":["number"],"help":"If adding multiple tilesets to a blank\/dynamic map, specify the starting GID the set will use here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"copy","static":false,"returns":{"types":["array"],"help":"An array of the tiles that were copied."},"help":"Copies all of the tiles in the given rectangular block into the tilemap data buffer.","line":1383,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to copy the tiles from.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":{"types":["Phaser.TilemapLayer"],"help":"The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly."},"help":"Creates an empty map of the given dimensions and one blank layer. If layers already exist they are erased.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the default layer of the map.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the map in tiles.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the map in tiles.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tiles the map uses for calculations.","optional":false,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tiles the map uses for calculations.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the layer to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createBlankLayer","static":false,"returns":{"types":["Phaser.TilemapLayer"],"help":"The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly."},"help":"Creates a new and empty layer on this Tilemap. By default TilemapLayers are fixed to the camera.","line":471,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of this layer. Must be unique within the map.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the layer in tiles.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the layer in tiles.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tiles the layer uses for calculations.","optional":false,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tiles the layer uses for calculations.","optional":false,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the layer to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFromObjects","static":false,"returns":null,"help":"Creates a Sprite for every object matching the given gid in the map data. You can optionally specify the group that the Sprite will be created in. If none is\\ngiven it will be created in the World. All properties from the map data objectgroup are copied across to the Sprite, so you can use this as an easy way to\\nconfigure Sprite properties from within the map editor. For example giving an object a property of alpha: 0.5 in the map editor will duplicate that when the\\nSprite is created. You could also give it a value like: body.velocity.x: 100 to set it moving automatically.","line":378,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the Object Group to create Sprites from.","optional":false,"default":null},{"name":"gid","type":["number"],"help":"The layer array index value, or if a string is given the layer name within the map data.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"},{"name":"autoCull","type":["boolean"],"help":"The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range.","optional":true,"default":"false"},{"name":"group","type":["Phaser.Group"],"help":"Group to add the Sprite to. If not specified it will be added to the World group.","optional":true,"default":"Phaser.World"},{"name":"CustomClass","type":["object"],"help":"If you wish to create your own class, rather than Phaser.Sprite, pass the class here. Your class must extend Phaser.Sprite and have the same constructor parameters.","optional":true,"default":"Phaser.Sprite"},{"name":"adjustY","type":["boolean"],"help":"By default the Tiled map editor uses a bottom-left coordinate system. Phaser uses top-left. So most objects will appear too low down. This parameter moves them up by their height.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"createLayer","static":false,"returns":{"types":["Phaser.TilemapLayer"],"help":"The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly."},"help":"Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.\\nThe `layer` parameter is important. If you've created your map in Tiled then you can get this by looking in Tiled and looking at the Layer name.\\nOr you can open the JSON file it exports and look at the layers[].name value. Either way it must match.\\nIf you wish to create a blank layer to put your own tiles on then see Tilemap.createBlankLayer.","line":434,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number","string"],"help":"The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width.","optional":true,"default":null},{"name":"height","type":["number"],"help":"The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height.","optional":true,"default":null},{"name":"group","type":["Phaser.Group"],"help":"Optional Group to add the object to. If not specified it will be added to the World group.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Removes all layer data from this tile map and nulls the game reference.\\nNote: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.","line":1764,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"dump","static":false,"returns":null,"help":"Dumps the tilemap data out to the console.","line":1722,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"fill","static":false,"returns":null,"help":"Fills the given area with the specified tile.","line":1685,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the tile that the area will be filled with.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"forEach","static":false,"returns":null,"help":"For each tile in the given area defined by x\/y and width\/height run the given callback.","line":1535,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["number"],"help":"The callback. Each tile in the given area will be passed to this callback as the first and only parameter.","optional":false,"default":null},{"name":"context","type":["number"],"help":"The context under which the callback should be run.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getImageIndex","static":false,"returns":{"types":["number"],"help":"The index of the image in this tilemap, or null if not found."},"help":"Gets the image index based on its name.","line":598,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the image to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getLayerIndex","static":false,"returns":{"types":["number"],"help":"The index of the layer in this tilemap, or null if not found."},"help":"Gets the layer index based on its name.","line":572,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the layer to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getObjectIndex","static":false,"returns":{"types":["number"],"help":"The index of the object in this tilemap, or null if not found."},"help":"Gets the object index based on its name.","line":611,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the object to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTile","static":false,"returns":{"types":["Phaser.Tile"],"help":"The tile at the given coordinates or null if no tile was found or the coordinates were invalid."},"help":"Gets a tile from the Tilemap Layer. The coordinates are given in tile values.","line":1316,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position to get the tile from (given in tile units, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to get the tile from (given in tile units, not pixels)","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to get the tile from.","optional":true,"default":null},{"name":"nonNull","type":["boolean"],"help":"If true getTile won't return null for empty tiles, but a Tile object with an index of -1.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"getTileAbove","static":false,"returns":null,"help":"Gets the tile above the tile coordinates given.\\nMostly used as an internal function by calculateFaces.","line":987,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number"],"help":"The local layer index to get the tile from. Can be determined by Tilemap.getLayer().","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileBelow","static":false,"returns":null,"help":"Gets the tile below the tile coordinates given.\\nMostly used as an internal function by calculateFaces.","line":1007,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number"],"help":"The local layer index to get the tile from. Can be determined by Tilemap.getLayer().","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileLeft","static":false,"returns":null,"help":"Gets the tile to the left of the tile coordinates given.\\nMostly used as an internal function by calculateFaces.","line":1027,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number"],"help":"The local layer index to get the tile from. Can be determined by Tilemap.getLayer().","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileRight","static":false,"returns":null,"help":"Gets the tile to the right of the tile coordinates given.\\nMostly used as an internal function by calculateFaces.","line":1047,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number"],"help":"The local layer index to get the tile from. Can be determined by Tilemap.getLayer().","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to get the tile from. In tiles, not pixels.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileWorldXY","static":false,"returns":{"types":["Phaser.Tile"],"help":"The tile at the given coordinates."},"help":"Gets a tile from the Tilemap layer. The coordinates are given in pixel values.","line":1358,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position to get the tile from (given in pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to get the tile from (given in pixels)","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tiles. If not given the map default is used.","optional":true,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tiles. If not given the map default is used.","optional":true,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to get the tile from.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTilesetIndex","static":false,"returns":{"types":["number"],"help":"The index of the tileset in this tilemap, or null if not found."},"help":"Gets the tileset index based on its name.","line":585,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the tileset to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hasTile","static":false,"returns":{"types":["boolean"],"help":"True if there is a tile at the given location, otherwise false."},"help":"Checks if there is a tile at the given location.","line":1084,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position to check if a tile exists at (given in tile units, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to check if a tile exists at (given in tile units, not pixels)","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to set as current.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"paste","static":false,"returns":null,"help":"Pastes a previously copied block of tile data into the given x\/y coordinates. Data should have been prepared with Tilemap.copy.","line":1443,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left of the area to paste to (given in tiles, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to paste to (given in tiles, not pixels)","optional":false,"default":null},{"name":"tileblock","type":["array"],"help":"The block of tiles to paste.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to paste the tiles into.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"putTile","static":false,"returns":{"types":["Phaser.Tile"],"help":"The Tile object that was created or added to this map."},"help":"Puts a tile of the given index value at the coordinate specified.\\nIf you pass `null` as the tile it will pass your call over to Tilemap.removeTile instead.","line":1156,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Tile","number","null"],"help":"The index of this tile to set or a Phaser.Tile object. If null the tile is removed from the map.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position to place the tile (given in tile units, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to place the tile (given in tile units, not pixels)","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to modify.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"putTileWorldXY","static":false,"returns":{"types":["Phaser.Tile"],"help":"The Tile object that was created or added to this map."},"help":"Puts a tile into the Tilemap layer. The coordinates are given in pixel values.","line":1228,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Tile","number"],"help":"The index of this tile to set or a Phaser.Tile object.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position to insert the tile (given in pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to insert the tile (given in pixels)","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tile in pixels.","optional":false,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tile in pixels.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to modify.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"random","static":false,"returns":null,"help":"Randomises a set of tiles in a given area.","line":1597,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAllLayers","static":false,"returns":null,"help":"Removes all layers from this tile map.","line":1710,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeTile","static":false,"returns":{"types":["Phaser.Tile"],"help":"The Tile object that was removed from this map."},"help":"Removes the tile located at the given coordinates and updates the collision data.","line":1101,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position to place the tile (given in tile units, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to place the tile (given in tile units, not pixels)","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to modify.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeTileWorldXY","static":false,"returns":{"types":["Phaser.Tile"],"help":"The Tile object that was removed from this map."},"help":"Removes the tile located at the given coordinates and updates the collision data. The coordinates are given in pixel values.","line":1134,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position to insert the tile (given in pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position to insert the tile (given in pixels)","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The width of the tile in pixels.","optional":false,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tile in pixels.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to modify.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"replace","static":false,"returns":null,"help":"Scans the given area for tiles with an index matching `source` and updates their index to match `dest`.","line":1564,"public":true,"protected":false,"private":false,"parameters":[{"name":"source","type":["number"],"help":"The tile index value to scan for.","optional":false,"default":null},{"name":"dest","type":["number"],"help":"The tile index value to replace found tiles with.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"searchTileIndex","static":false,"returns":{"types":["Phaser.Tile"],"help":"The first (or n skipped) tile with the matching index."},"help":"Searches the entire map layer for the first tile matching the given index, then returns that Phaser.Tile object.\\nIf no match is found it returns null.\\nThe search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next column.\\nIf the reverse boolean is true, it scans starting from the bottom-right corner travelling up to the top-left.","line":1252,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The tile index value to search for.","optional":false,"default":null},{"name":"skip","type":["number"],"help":"The number of times to skip a matching tile before returning.","optional":true,"default":"0"},{"name":"reverse","type":["number"],"help":"If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.","optional":true,"default":"false"},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to get the tile from.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setCollision","static":false,"returns":null,"help":"Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].\\nThe `collides` parameter controls if collision will be enabled (true) or disabled (false).","line":690,"public":true,"protected":false,"private":false,"parameters":[{"name":"indexes","type":["number","array"],"help":"Either a single tile index, or an array of tile IDs to be checked for collision.","optional":false,"default":null},{"name":"collides","type":["boolean"],"help":"If true it will enable collision. If false it will clear collision.","optional":true,"default":"true"},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null},{"name":"recalculate","type":["boolean"],"help":"Recalculates the tile faces after the update.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionBetween","static":false,"returns":null,"help":"Sets collision on a range of tiles where the tile IDs increment sequentially.\\nCalling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.\\nThe `collides` parameter controls if collision will be enabled (true) or disabled (false).","line":730,"public":true,"protected":false,"private":false,"parameters":[{"name":"start","type":["number"],"help":"The first index of the tile to be set for collision.","optional":false,"default":null},{"name":"stop","type":["number"],"help":"The last index of the tile to be set for collision.","optional":false,"default":null},{"name":"collides","type":["boolean"],"help":"If true it will enable collision. If false it will clear collision.","optional":true,"default":"true"},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null},{"name":"recalculate","type":["boolean"],"help":"Recalculates the tile faces after the update.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionByExclusion","static":false,"returns":null,"help":"Sets collision on all tiles in the given layer, except for the IDs of those in the given array.\\nThe `collides` parameter controls if collision will be enabled (true) or disabled (false).","line":765,"public":true,"protected":false,"private":false,"parameters":[{"name":"indexes","type":["array"],"help":"An array of the tile IDs to not be counted for collision.","optional":false,"default":null},{"name":"collides","type":["boolean"],"help":"If true it will enable collision. If false it will clear collision.","optional":true,"default":"true"},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null},{"name":"recalculate","type":["boolean"],"help":"Recalculates the tile faces after the update.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"setLayer","static":false,"returns":null,"help":"Sets the current layer to the given index.","line":1064,"public":true,"protected":false,"private":false,"parameters":[{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to set as current.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setPreventRecalculate","static":false,"returns":null,"help":"Turn off\/on the recalculation of faces for tile or collission updates.\\nsetPreventRecalculate(true) puts recalculation on hold while\\nsetPreventRecalculate(false) recalculates all the changed layers.","line":894,"public":true,"protected":false,"private":false,"parameters":[{"name":"if","type":["boolean"],"help":" true it will put the recalculation on hold.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTileIndexCallback","static":false,"returns":null,"help":"Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.\\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.\\nIf you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.","line":628,"public":true,"protected":false,"private":false,"parameters":[{"name":"indexes","type":["number","array"],"help":"Either a single tile index, or an array of tile indexes to have a collision callback set for.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be invoked when the tile is collided with.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback is called.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTileLocationCallback","static":false,"returns":null,"help":"Sets a global collision callback for the given map location within the layer. This will affect all tiles on this layer found in the given area.\\nIf a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.\\nIf you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.","line":662,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the area to copy (given in tiles, not pixels)","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be invoked when the tile is collided with.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context under which the callback is called.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTileSize","static":false,"returns":null,"help":"Sets the base tile size for the map.","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"tileWidth","type":["number"],"help":"The width of the tiles the map uses for calculations.","optional":false,"default":null},{"name":"tileHeight","type":["number"],"help":"The height of the tiles the map uses for calculations.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shuffle","static":false,"returns":null,"help":"Shuffles a set of tiles in a given area. It will only randomise the tiles in that area, so if they're all the same nothing will appear to have changed!","line":1642,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"swap","static":false,"returns":null,"help":"Scans the given area for tiles with an index matching tileA and swaps them with tileB.","line":1481,"public":true,"protected":false,"private":false,"parameters":[{"name":"tileA","type":["number"],"help":"First tile index.","optional":false,"default":null},{"name":"tileB","type":["number"],"help":"Second tile index.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left of the area to operate one, given in tiles, not pixels.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width in tiles of the area to operate on.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height in tiles of the area to operate on.","optional":false,"default":null},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"calculateFaces","static":false,"returns":null,"help":"Internal function.","line":915,"public":false,"protected":true,"private":false,"parameters":[{"name":"layer","type":["number"],"help":"The index of the TilemapLayer to operate on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the element in the array, or null if not found."},"help":"Gets the layer index based on the layers name.","line":551,"public":false,"protected":true,"private":false,"parameters":[{"name":"location","type":["array"],"help":"The local array to search.","optional":false,"default":null},{"name":"name","type":["string"],"help":"The name of the array element to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getLayer","static":false,"returns":{"types":["number"],"help":"The TilemapLayer index."},"help":"Gets the TilemapLayer index as used in the setCollision calls.","line":863,"public":false,"protected":true,"private":false,"parameters":[{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setCollisionByIndex","static":false,"returns":null,"help":"Sets collision values on a tile in the set.\\nYou shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.","line":800,"public":false,"protected":true,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the tile on the layer.","optional":false,"default":null},{"name":"collides","type":["boolean"],"help":"If true it will enable collision on the tile. If false it will clear collision values from the tile.","optional":true,"default":"true"},{"name":"layer","type":["number"],"help":"The layer to operate on. If not given will default to this.currentLayer.","optional":true,"default":null},{"name":"recalculate","type":["boolean"],"help":"Recalculates the tile faces after the update.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"swapHandler","static":false,"returns":null,"help":"Internal function that handles the swapping of tiles.","line":1508,"public":false,"protected":false,"private":true,"parameters":[{"name":"value","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"collideIndexes","type":["array"],"help":"","inlineHelp":"An array of tile indexes that collide.","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collision","type":["array"],"help":"","inlineHelp":"An array of collision data (polylines, etc).","line":122,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentLayer","type":["number"],"help":"","inlineHelp":"The current layer.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugMap","type":["array"],"help":"","inlineHelp":"Map data used for debug values only.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"format","type":["number"],"help":"","inlineHelp":"The format of the map data, either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height of the map (in tiles).","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"heightInPixels","type":["number"],"help":"","inlineHelp":"The height of the map in pixels based on height * tileHeight.","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"images","type":["array"],"help":"","inlineHelp":"An array of Tiled Image Layers.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"","inlineHelp":"The key of this map data in the Phaser.Cache.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"layer","type":["number","string","Phaser.TilemapLayer"],"help":"","inlineHelp":"The current layer object.","line":1780,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"layers","type":["array"],"help":"","inlineHelp":"An array of Tilemap layer data.","line":97,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"objects","type":["array"],"help":"","inlineHelp":"An array of Tiled Object Layers.","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"orientation","type":["string"],"help":"","inlineHelp":"The orientation of the map data (as specified in Tiled), usually 'orthogonal'.","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"properties","type":["object"],"help":"","inlineHelp":"Map specific properties as specified in Tiled.","line":82,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileHeight","type":["number"],"help":"","inlineHelp":"The base height of the tiles in the map (in pixels).","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileWidth","type":["number"],"help":"","inlineHelp":"The base width of the tiles in the map (in pixels).","line":57,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tiles","type":["array"],"help":"","inlineHelp":"The super array of Tiles.","line":107,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tilesets","type":["array"],"help":"","inlineHelp":"An array of Tilesets.","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"version","type":["number"],"help":"","inlineHelp":"The version of the map data (as specified in Tiled, usually 1).","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width of the map (in tiles).","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"widthInPixels","type":["number"],"help":"","inlineHelp":"The width of the map in pixels based on width * tileWidth.","line":87,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_results","type":["array"],"help":"","inlineHelp":"Internal var.","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempA","type":["number"],"help":"","inlineHelp":"Internal var.","line":149,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tempB","type":["number"],"help":"","inlineHelp":"Internal var.","line":155,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.TilemapLayer.json b/docgen/output/Phaser.TilemapLayer.json deleted file mode 100644 index 87696daff..000000000 --- a/docgen/output/Phaser.TilemapLayer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.TilemapLayer","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"tilemap","type":["Phaser.Tilemap"],"help":"The tilemap to which this layer belongs.","optional":false,"default":null},{"name":"index","type":["number"],"help":"The layer index within the map that this TilemapLayer represents.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the renderable area of the layer.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the renderable area of the layer.","optional":false,"default":null}],"help":"A Tilemap Layer is a set of map data combined with a Tileset in order to render that data to the game."},"consts":[],"methods":{"public":[{"name":"getRayCastTiles","static":false,"returns":{"types":["array Phaser.Tile"],"help":"An array of Phaser.Tiles."},"help":"Gets all tiles that intersect with the given line.","line":399,"public":true,"protected":false,"private":false,"parameters":[{"name":"line","type":["Phaser.Line"],"help":"The line used to determine which tiles to return.","optional":false,"default":null},{"name":"stepRate","type":["number"],"help":"How many steps through the ray will we check? If undefined or null it uses TilemapLayer.rayStepRate.","optional":true,"default":null},{"name":"collides","type":["boolean"],"help":"If true only return tiles that collide on one or more faces.","optional":true,"default":"false"},{"name":"interestingFace","type":["boolean"],"help":"If true only return tiles that have interesting faces.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"getTileX","static":false,"returns":{"types":["Phaser.Tile"],"help":"The tile with specific properties."},"help":"Convert a pixel value to a tile coordinate.","line":347,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the point in target tile.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileXY","static":false,"returns":{"types":["Phaser.Point","object"],"help":"A Point object with its x and y properties set."},"help":"Convert a pixel value to a tile coordinate.","line":379,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the point in target tile.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the point in target tile.","optional":false,"default":null},{"name":"point","type":["Phaser.Point","object"],"help":"The Point object to set the x and y values on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTileY","static":false,"returns":{"types":["Phaser.Tile"],"help":"The tile with specific properties."},"help":"Convert a pixel value to a tile coordinate.","line":362,"public":true,"protected":false,"private":false,"parameters":[{"name":"y","type":["number"],"help":"Y position of the point in target tile.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTiles","static":false,"returns":{"types":["array Phaser.Tile"],"help":"An array of Phaser.Tiles."},"help":"Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the top left corner.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the top left corner.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the area to get.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the area to get.","optional":false,"default":null},{"name":"collides","type":["boolean"],"help":"If true only return tiles that collide on one or more faces.","optional":true,"default":"false"},{"name":"interestingFace","type":["boolean"],"help":"If true only return tiles that have interesting faces.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate. Handles cache updates.","line":213,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Renders the tiles to the layer canvas and pushes to the display.","line":512,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"renderDebug","static":false,"returns":null,"help":"Renders a collision debug overlay on-top of the canvas. Called automatically by render when debug = true.","line":630,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resizeWorld","static":false,"returns":null,"help":"Sets the world size to match the size of this layer.","line":244,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateMax","static":false,"returns":null,"help":"Internal function to update maximum values.","line":498,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_fixX","static":false,"returns":{"types":["number"],"help":"x coordinate in scrollFactor-adjusted dimensions"},"help":"Take an x coordinate that doesn't account for scrollFactorX and 'fix' it\\ninto a scrolled local space. Used primarily internally","line":259,"public":false,"protected":false,"private":true,"parameters":[{"name":"x","type":["number"],"help":"x coordinate in camera space","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_fixY","static":false,"returns":{"types":["number"],"help":"y coordinate in scrollFactor-adjusted dimensions"},"help":"Take a y coordinate that doesn't account for scrollFactorY and 'fix' it\\ninto a scrolled local space. Used primarily internally","line":304,"public":false,"protected":false,"private":true,"parameters":[{"name":"y","type":["number"],"help":"y coordinate in camera space","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_unfixX","static":false,"returns":{"types":["number"],"help":"x coordinate in camera space"},"help":"Take an x coordinate that _does_ account for scrollFactorX and 'unfix' it\\nback to camera space. Used primarily internally","line":284,"public":false,"protected":false,"private":true,"parameters":[{"name":"x","type":["number"],"help":"x coordinate in scrollFactor-adjusted dimensions","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_unfixY","static":false,"returns":{"types":["number"],"help":"y coordinate in camera space"},"help":"Take a y coordinate that _does_ account for scrollFactorY and 'unfix' it\\nback to camera space. Used primarily internally","line":329,"public":false,"protected":false,"private":true,"parameters":[{"name":"y","type":["number"],"help":"y coordinate in scrollFactor-adjusted dimensions","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"","inlineHelp":"Required Pixi var.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixed to the camera then use this Point to specify how far away from the Camera x\/y it's rendered.","line":88,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"","inlineHelp":"The canvas to which this TilemapLayer draws.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collisionHeight","type":["number"],"help":"","inlineHelp":"The height of the collision tiles.","line":794,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"collisionWidth","type":["number"],"help":"","inlineHelp":"The width of the collision tiles.","line":774,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"The 2d context of the canvas.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"debug","type":["boolean"],"help":"","inlineHelp":"If set to true the collideable tile edges path will be rendered. Only works when game is running in Phaser.CANVAS mode.","line":100,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugAlpha","type":["number"],"help":"","inlineHelp":"If debug is true then the tileset is rendered with this alpha level, to make the tile edges clearer.","line":106,"default":"0.5","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugCallbackColor","type":["string"],"help":"","inlineHelp":"If debug is true this is the color used to outline the edges of tiles that have collision callbacks. Provide in hex or rgb\/rgba string format.","line":130,"default":"'rgba(255, 0, 0, 1)'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugColor","type":["string"],"help":"","inlineHelp":"If debug is true this is the color used to outline the edges of collidable tiles. Provide in hex or rgb\/rgba string format.","line":112,"default":"'rgba(0, 255, 0, 1)'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugFill","type":["boolean"],"help":"","inlineHelp":"If true the debug tiles are filled with debugFillColor AND stroked around.","line":118,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"debugFillColor","type":["string"],"help":"","inlineHelp":"If debugFill is true this is the color used to fill the tiles. Provide in hex or rgb\/rgba string format.","line":124,"default":"'rgba(0, 255, 0, 0.2)'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"Flag controlling when to re-render the layer.","line":151,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x\/y coordinates as offsets from the top left of the camera.","inlineHelp":"Fixes this object to the Camera.","line":83,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The index of this layer within the Tilemap.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"layer","type":["object"],"help":"","inlineHelp":"The layer object within the Tilemap that this layer represents.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"map","type":["Phaser.Tilemap"],"help":"","inlineHelp":"The Tilemap to which this layer is bound.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The name of the layer.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rayStepRate","type":["number"],"help":"","inlineHelp":"When ray-casting against tiles this is the number of steps it will jump. For larger tile sizes you can increase this to improve performance.","line":157,"default":"4","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scrollFactorX","type":["number"],"help":"horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls\\nhalf as quickly as the 'normal' camera-locked layers do)","inlineHelp":"speed at which this layer scrolls","line":138,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scrollFactorY","type":["number"],"help":"vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls\\nhalf as quickly as the 'normal' camera-locked layers do)","inlineHelp":"speed at which this layer scrolls","line":146,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"scrollX","type":["number"],"help":"","inlineHelp":"Scrolls the map horizontally or returns the current x position.","line":728,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scrollY","type":["number"],"help":"","inlineHelp":"Scrolls the map vertically or returns the current y position.","line":751,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"","inlineHelp":"Required Pixi var.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textureFrame","type":["Phaser.Frame"],"help":"","inlineHelp":"Dimensions of the renderable area.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileColor","type":["string"],"help":"","inlineHelp":"If no tileset is given the tiles will be rendered as rectangles in this color. Provide in hex or rgb\/rgba string format.","line":94,"default":"'rgb(255, 255, 255)'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":76,"default":"Phaser.TILEMAPLAYER","public":true,"protected":false,"private":false,"readOnly":false},{"name":"wrap","type":["boolean"],"help":"","inlineHelp":"Flag controlling if the layer tiles wrap at the edges. Only works if the World size matches the Map size.","line":163,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_mc","type":["object"],"help":"","inlineHelp":"Local map data and calculation cache.","line":169,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_results","type":["array"],"help":"","inlineHelp":"Local render loop var to help avoid gc spikes.","line":198,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.TilemapParser.json b/docgen/output/Phaser.TilemapParser.json deleted file mode 100644 index c55c3ad3d..000000000 --- a/docgen/output/Phaser.TilemapParser.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.TilemapParser","extends":"","static":true,"constructor":false,"parameters":[],"help":"Phaser.TilemapParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into a Tilemap."},"consts":[],"methods":{"public":[{"name":"getEmptyData","static":false,"returns":{"types":["object"],"help":"Generated map data."},"help":"Returns an empty map data object.","line":126,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"parse","static":false,"returns":{"types":["object"],"help":"The parsed map object."},"help":"Parse tilemap data from the cache and creates a Tilemap object.","line":26,"public":true,"protected":false,"private":false,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Game reference to the currently running game.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The key of the tilemap in the Cache.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"width","type":["number"],"help":"The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"},{"name":"height","type":["number"],"help":"The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.","optional":true,"default":"10"}],"inherited":false,"inheritedFrom":""},{"name":"parseCSV","static":false,"returns":{"types":["object"],"help":"Generated map data."},"help":"Parses a CSV file into valid map data.","line":72,"public":true,"protected":false,"private":false,"parameters":[{"name":"data","type":["string"],"help":"The CSV file data.","optional":false,"default":null},{"name":"tileWidth","type":["number"],"help":"The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"},{"name":"tileHeight","type":["number"],"help":"The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.","optional":true,"default":"32"}],"inherited":false,"inheritedFrom":""},{"name":"parseJSON","static":false,"returns":{"types":["object"],"help":"Generated and parsed map data."},"help":"Parses a Tiled JSON file into valid map data.","line":188,"public":true,"protected":false,"private":false,"parameters":[{"name":"json","type":["object"],"help":"The JSON map data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Tileset.json b/docgen/output/Phaser.Tileset.json deleted file mode 100644 index 2f3e68ce1..000000000 --- a/docgen/output/Phaser.Tileset.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Tileset","extends":"","static":false,"constructor":true,"parameters":[{"name":"name","type":["string"],"help":"The name of the tileset in the map data.","optional":false,"default":null},{"name":"firstgid","type":["number"],"help":"The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of each tile in pixels.","optional":true,"default":"32"},{"name":"height","type":["number"],"help":"Height of each tile in pixels.","optional":true,"default":"32"},{"name":"margin","type":["number"],"help":"The amount of margin around the tilesheet.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"The amount of spacing between each tile in the sheet.","optional":true,"default":"0"},{"name":"properties","type":["object"],"help":"Tileset properties.","optional":true,"default":null}],"help":"A Tile set is a combination of an image containing the tiles and collision data per tile.\\nYou should not normally instantiate this class directly."},"consts":[],"methods":{"public":[{"name":"draw","static":false,"returns":null,"help":"Draws a tile from this Tileset at the given coordinates on the context.","line":102,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["CanvasRenderingContext2D"],"help":"The context to draw the tile onto.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to draw to.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to draw to.","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index of the tile within the set to draw.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setImage","static":false,"returns":null,"help":"Adds a reference from this Tileset to an Image stored in the Phaser.Cache.","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"image","type":["Image"],"help":"The image this tileset will use to draw with.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSpacing","static":false,"returns":null,"help":"Sets tile spacing and margins.","line":166,"public":true,"protected":false,"private":false,"parameters":[{"name":"tileMargin","type":["number"],"help":"The margin around the tiles in the sheet.","optional":true,"default":null},{"name":"tileSpacing","type":["number"],"help":"The spacing between the tiles in the sheet.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"columns","type":["number"],"help":"","inlineHelp":"The number of columns in the tile sheet.","line":76,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"firstgid","type":["number"],"help":"","inlineHelp":"The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"image","type":["object"],"help":"","inlineHelp":"The image used for rendering. This is a reference to the image stored in Phaser.Cache.","line":66,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The name of the Tileset.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"properties","type":["object"],"help":"","inlineHelp":"Tileset specific properties (typically defined in the Tiled editor).","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rows","type":["number"],"help":"","inlineHelp":"The number of rows in the tile sheet.","line":71,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileHeight","type":["number"],"help":"","inlineHelp":"The height of a tile in pixels.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileMargin","type":["number"],"help":"","inlineHelp":"The margin around the tiles in the tileset.","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileSpacing","type":["number"],"help":"","inlineHelp":"The spacing in pixels between each tile in the tileset.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tileWidth","type":["number"],"help":"","inlineHelp":"The width of a tile in pixels.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of tiles in the tilesheet.","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"draw","type":["array"],"help":"","inlineHelp":"The tile drawImage look-up table","line":87,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Time.json b/docgen/output/Phaser.Time.json deleted file mode 100644 index a8024128a..000000000 --- a/docgen/output/Phaser.Time.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Time","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" A reference to the currently running game.","optional":false,"default":null}],"help":"This is the core internal game clock.\\nIt manages the elapsed time and calculation of elapsed values, used for game object motion and tweens."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Timer"],"help":"The given Phaser.Timer object."},"help":"Adds an existing Phaser.Timer object to the Timer pool.","line":191,"public":true,"protected":false,"private":false,"parameters":[{"name":"timer","type":["Phaser.Timer"],"help":"An existing Phaser.Timer object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":{"types":["Phaser.Timer"],"help":"The Timer object that was created."},"help":"Creates a new stand-alone Phaser.Timer object.","line":206,"public":true,"protected":false,"private":false,"parameters":[{"name":"autoDestroy","type":["boolean"],"help":"A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"elapsedSecondsSince","static":false,"returns":{"types":["number"],"help":"Duration between given time and now (in seconds)."},"help":"How long has passed since the given time (in seconds).","line":390,"public":true,"protected":false,"private":false,"parameters":[{"name":"since","type":["number"],"help":"The time you want to measure (in seconds).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"elapsedSince","static":false,"returns":{"types":["number"],"help":"The difference between the given time and now."},"help":"How long has passed since the given time.","line":379,"public":true,"protected":false,"private":false,"parameters":[{"name":"since","type":["number"],"help":"The time you want to measure against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all Timer objects, regardless of their state. Also clears all Timers from the Time.events timer.","line":223,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the private _started value to now and removes all currently running Timers.","line":399,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"totalElapsedSeconds","static":false,"returns":{"types":["number"],"help":"The number of seconds that have elapsed since the game was started."},"help":"The number of seconds that have elapsed since the game was started.","line":368,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Called automatically by Phaser.Game after boot. Should not be called directly.","line":177,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates the game clock and if enabled the advanced timing data. This is called automatically by Phaser.Game.","line":243,"public":false,"protected":true,"private":false,"parameters":[{"name":"time","type":["number"],"help":"The current timestamp.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"gamePaused","static":false,"returns":null,"help":"Called when the game enters a paused state.","line":323,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"gameResumed","static":false,"returns":null,"help":"Called when the game resumes from a paused state.","line":344,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"advancedTiming","type":["boolean"],"help":"","inlineHelp":"If true Phaser.Time will perform advanced profiling including the fps rate, fps min\/max and msMin and msMax.","line":56,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"deltaCap","type":["number"],"help":"","inlineHelp":"If you need to cap the delta timer, set the value here. For 60fps the delta should be 0.016, so try variances just above this.","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Timer"],"help":"","inlineHelp":"This is a Phaser.Timer object bound to the master clock to which you can add timed events.","line":123,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fpsMax","type":["number"],"help":"","inlineHelp":"The highest rate the fps has reached (usually no higher than 60fps). Only calculated if Time.advancedTiming is true.","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fpsMin","type":["number"],"help":"","inlineHelp":"The lowest rate the fps has dropped to. Only calculated if Time.advancedTiming is true.","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"frames","type":["number"],"help":"","inlineHelp":"The number of frames record in the last second. Only calculated if Time.advancedTiming is true.","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lastTime","type":["number"],"help":"","inlineHelp":"Internal value used by timeToCall as part of the setTimeout loop","line":118,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"msMax","type":["number"],"help":"","inlineHelp":"The maximum amount of time the game has taken between two frames. Only calculated if Time.advancedTiming is true.","line":83,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"msMin","type":["number"],"help":"","inlineHelp":"The minimum amount of time the game has taken between two frames. Only calculated if Time.advancedTiming is true.","line":78,"default":"1000","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pauseDuration","type":["number"],"help":"","inlineHelp":"Records how long the game was paused for in miliseconds.","line":108,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsElapsed","type":["number"],"help":"","inlineHelp":"The elapsed time calculated for the physics motion updates. In a stable 60fps system this will be 0.016 every frame.","line":88,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeCap","type":["number"],"help":"","inlineHelp":"If the difference in time between two frame updates exceeds this value, the frame time is reset to avoid huge elapsed counts.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"timeToCall","type":["number"],"help":"","inlineHelp":"The value that setTimeout needs to work out when to next update","line":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"elapsed","type":["number"],"help":"","inlineHelp":"Elapsed time since the last frame (in ms).","line":44,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"fps","type":["number"],"help":"","inlineHelp":"Frames per second. Only calculated if Time.advancedTiming is true.","line":62,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"now","type":["number"],"help":"","inlineHelp":"The time right now.","line":38,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"pausedTime","type":["number"],"help":"","inlineHelp":"Records how long the game has been paused for. Is reset each time the game pauses.","line":50,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"prevTime","type":["number"],"help":"","inlineHelp":"The time the previous update occurred.","line":32,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"time","type":["number"],"help":"","inlineHelp":"Game time counter. If you need a value for in-game calculation please use Phaser.Time.now instead.","line":26,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[{"name":"_i","type":["number"],"help":"","inlineHelp":"Temp. array counter variable.","line":165,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_justResumed","type":["boolean"],"help":"","inlineHelp":"Internal value used to recover from the game pause state.","line":147,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_len","type":["number"],"help":"","inlineHelp":"Temp. array length variable.","line":159,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pauseStarted","type":["number"],"help":"","inlineHelp":"The time the game started being paused.","line":141,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_started","type":["number"],"help":"","inlineHelp":"The time at which the Game instance started.","line":129,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_timeLastSecond","type":["number"],"help":"","inlineHelp":"The time (in ms) that the last second counter ticked over.","line":135,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_timers","type":["array"],"help":"","inlineHelp":"Internal store of Phaser.Timer objects.","line":153,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Timer.json b/docgen/output/Phaser.Timer.json deleted file mode 100644 index 2f024158c..000000000 --- a/docgen/output/Phaser.Timer.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Timer","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" A reference to the currently running game.","optional":false,"default":null},{"name":"autoDestroy","type":["boolean"],"help":"A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).","optional":true,"default":"true"}],"help":"A Timer is a way to create small re-usable or disposable objects that do nothing but wait for a specific moment in time, and then dispatch an event.\\nYou can add as many events to a Timer as you like, each with their own delays. A Timer uses milliseconds as its unit of time. There are 1000 ms in 1 second.\\nSo if you want to fire an event every quarter of a second you'd need to set the delay to 250."},"consts":[{"name":"HALF","type":"number","help":"","line":159},{"name":"MINUTE","type":"number","help":"","line":147},{"name":"QUARTER","type":"number","help":"","line":165},{"name":"SECOND","type":"number","help":"","line":153}],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.TimerEvent"],"help":"The Phaser.TimerEvent object that was created."},"help":"Adds a new Event to this Timer. The event will fire after the given amount of 'delay' in milliseconds has passed, once the Timer has started running.\\nCall Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.\\nIf the Timer is already running the delay will be calculated based on the timers current time.","line":220,"public":true,"protected":false,"private":false,"parameters":[{"name":"delay","type":["number"],"help":"The number of milliseconds that should elapse before the Timer will call the given callback.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the Timer event occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["any"],"help":"The values to be sent to your callback function when it is called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"adjustEvents","static":false,"returns":null,"help":"Adjusts the time of all pending events and the nextTick by the given baseTime.","line":526,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"clearPendingEvents","static":false,"returns":null,"help":"Clears any events from the Timer which have pendingDelete set to true and then resets the private _len and _i values.","line":367,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Timer. Any pending Events are not dispatched.\\nThe onComplete callbacks won't be called.","line":620,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loop","static":false,"returns":{"types":["Phaser.TimerEvent"],"help":"The Phaser.TimerEvent object that was created."},"help":"Adds a new looped Event to this Timer that will repeat forever or until the Timer is stopped.\\nThe event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running.\\nCall Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.\\nIf the Timer is already running the delay will be calculated based on the timers current time.","line":259,"public":true,"protected":false,"private":false,"parameters":[{"name":"delay","type":["number"],"help":"The number of milliseconds that should elapse before the Timer will call the given callback.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the Timer event occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["any"],"help":"The values to be sent to your callback function when it is called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"order","static":false,"returns":null,"help":"Orders the events on this Timer so they are in tick order. This is called automatically when new events are created.","line":330,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pause","static":false,"returns":null,"help":"Pauses the Timer and all events in the queue.","line":483,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Removes a pending TimerEvent from the queue.","line":311,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Phaser.TimerEvent"],"help":"The event to remove from the queue.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Removes all Events from this Timer and all callbacks linked to onComplete, but leaves the Timer running.\\nThe onComplete callbacks won't be called.","line":605,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"repeat","static":false,"returns":{"types":["Phaser.TimerEvent"],"help":"The Phaser.TimerEvent object that was created."},"help":"Adds a new TimerEvent that will always play through once and then repeat for the given number of iterations.\\nThe event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running.\\nCall Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.\\nIf the Timer is already running the delay will be calculated based on the timers current time.","line":240,"public":true,"protected":false,"private":false,"parameters":[{"name":"delay","type":["number"],"help":"The number of milliseconds that should elapse before the Timer will call the given callback.","optional":false,"default":null},{"name":"repeatCount","type":["number"],"help":"The number of times the event will repeat once is has finished playback. A repeatCount of 1 means it will repeat itself once, playing the event twice in total.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the Timer event occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["any"],"help":"The values to be sent to your callback function when it is called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resume","static":false,"returns":null,"help":"Resumes the Timer and updates all pending events.","line":563,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts this Timer running.","line":270,"public":true,"protected":false,"private":false,"parameters":[{"name":"delay","type":["number"],"help":"The number of milliseconds that should elapse before the Timer will start.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops this Timer from running. Does not cause it to be destroyed if autoDestroy is set to true.","line":293,"public":true,"protected":false,"private":false,"parameters":[{"name":"clearEvents","type":["boolean"],"help":"If true all the events in Timer will be cleared, otherwise they will remain.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"sortHandler","static":false,"returns":null,"help":"Sort handler used by Phaser.Timer.order.","line":347,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":{"types":["boolean"],"help":"True if there are still events waiting to be dispatched, otherwise false if this Timer can be destroyed."},"help":"The main Timer update event, called automatically by Phaser.Time.update.","line":392,"public":false,"protected":true,"private":false,"parameters":[{"name":"time","type":["number"],"help":"The time from the core game clock.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"_pause","static":false,"returns":null,"help":"This is called by the core Game loop. Do not call it directly, instead use Timer.pause.","line":508,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_resume","static":false,"returns":null,"help":"This is called by the core Game loop. Do not call it directly, instead use Timer.pause.","line":586,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":{"types":["Phaser.TimerEvent"],"help":"The Phaser.TimerEvent object that was created."},"help":"Creates a new TimerEvent on this Timer. Use the methods add, repeat or loop instead of this.","line":181,"public":false,"protected":false,"private":true,"parameters":[{"name":"delay","type":["number"],"help":"The number of milliseconds that should elapse before the Timer will call the given callback. This value should be an integer, not a float. Math.round() is applied to it by this method.","optional":false,"default":null},{"name":"loop","type":["boolean"],"help":"Should the event loop or not?","optional":false,"default":null},{"name":"repeatCount","type":["number"],"help":"The number of times the event will repeat.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the Timer event occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["array"],"help":"The values to be sent to your callback function when it is called.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"autoDestroy","type":["boolean"],"help":"","inlineHelp":"A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"duration","type":["number"],"help":"","inlineHelp":"The duration in ms remaining until the next event will occur.","line":650,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"events","type":["array Phaser.TimerEvent"],"help":"","inlineHelp":"An array holding all of this timers Phaser.TimerEvent objects. Use the methods add, repeat and loop to populate it.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"expired","type":["boolean"],"help":"","inlineHelp":"An expired Timer is one in which all of its events have been dispatched and none are pending.","line":42,"default":"false","public":true,"protected":false,"private":false,"readOnly":true},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The number of pending events in the queue.","line":672,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"ms","type":["number"],"help":"","inlineHelp":"The duration in milliseconds that this Timer has been running for.","line":685,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"next","type":["number"],"help":"","inlineHelp":"The time at which the next event will occur.","line":637,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"onComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal will be dispatched when this Timer has completed, meaning there are no more events in the queue.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"paused","type":["boolean"],"help":"","inlineHelp":"The paused state of the Timer. You can pause the timer by calling Timer.pause() and Timer.resume() or by the game pausing.","line":78,"default":"false","public":true,"protected":false,"private":false,"readOnly":true},{"name":"running","type":["boolean"],"help":"","inlineHelp":"True if the Timer is actively running. Do not switch this boolean, if you wish to pause the timer then use Timer.pause() instead.","line":30,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"seconds","type":["number"],"help":"","inlineHelp":"The duration in seconds that this Timer has been running for.","line":707,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"timeCap","type":["number"],"help":"","inlineHelp":"If the difference in time between two frame updates exceeds this value, the event times are reset to avoid catch-up situations.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"elapsed","type":["number"],"help":"","inlineHelp":"Elapsed time since the last frame (in ms).","line":48,"default":null,"public":false,"protected":true,"private":false,"readOnly":false},{"name":"nextTick","type":["number"],"help":"","inlineHelp":"The time the next tick will occur.","line":65,"default":null,"public":false,"protected":true,"private":false,"readOnly":true}],"private":[{"name":"_codePaused","type":["boolean"],"help":"","inlineHelp":"Was the Timer paused by code or by Game focus loss?","line":84,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_diff","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":133,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_i","type":["number"],"help":"","inlineHelp":"Temp. array counter variable.","line":127,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_len","type":["number"],"help":"","inlineHelp":"Temp. array length variable.","line":115,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_marked","type":["number"],"help":"","inlineHelp":"Temp. counter variable.","line":121,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_newTick","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":139,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_now","type":["number"],"help":"","inlineHelp":"The current start-time adjusted time.","line":109,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pauseStarted","type":["number"],"help":"","inlineHelp":"The time the game started being paused.","line":97,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pauseTotal","type":["number"],"help":"","inlineHelp":"Total paused time.","line":103,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_started","type":["number"],"help":"","inlineHelp":"The time at which this Timer instance started running.","line":91,"default":"0","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.TimerEvent.json b/docgen/output/Phaser.TimerEvent.json deleted file mode 100644 index 1b2ff6b28..000000000 --- a/docgen/output/Phaser.TimerEvent.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.TimerEvent","extends":"","static":false,"constructor":true,"parameters":[{"name":"timer","type":["Phaser.Timer"],"help":"The Timer object that this TimerEvent belongs to.","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The delay in ms at which this TimerEvent fires.","optional":false,"default":null},{"name":"tick","type":["number"],"help":"The tick is the next game clock time that this event will fire at.","optional":false,"default":null},{"name":"repeatCount","type":["number"],"help":"If this TimerEvent repeats it will do so this many times.","optional":false,"default":null},{"name":"loop","type":["boolean"],"help":"True if this TimerEvent loops, otherwise false.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the TimerEvent occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["array"],"help":"The values to be passed to the callback.","optional":false,"default":null}],"help":"A TimerEvent is a single event that is processed by a Phaser.Timer.\\nIt consists of a delay, which is a value in milliseconds after which the event will fire.\\nIt can call a specific callback, passing in optional parameters."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"arguments","type":["array"],"help":"","inlineHelp":"The values to be passed to the callback.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"callback","type":["function"],"help":"","inlineHelp":"The callback that will be called when the TimerEvent occurs.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context in which the callback will be called.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"delay","type":["number"],"help":"","inlineHelp":"The delay in ms at which this TimerEvent fires.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loop","type":["boolean"],"help":"","inlineHelp":"True if this TimerEvent loops, otherwise false.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"repeatCount","type":["number"],"help":"","inlineHelp":"If this TimerEvent repeats it will do so this many times.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tick","type":["number"],"help":"","inlineHelp":"The tick is the next game clock time that this event will fire at.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"timer","type":["Phaser.Timer"],"help":"","inlineHelp":"The Timer object that this TimerEvent belongs to.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"pendingDelete","type":["boolean"],"help":"","inlineHelp":"A flag that controls if the TimerEvent is pending deletion.","line":69,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Touch.json b/docgen/output/Phaser.Touch.json deleted file mode 100644 index 059c87d7d..000000000 --- a/docgen/output/Phaser.Touch.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Touch","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Touch handles touch events with your game. Note: Android 2.x only supports 1 touch event at once, no multi-touch."},"consts":[],"methods":{"public":[{"name":"consumeTouchMove","static":false,"returns":null,"help":"Consumes all touchmove events on the document (only enable this if you know you need it!).","line":178,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onTouchCancel","static":false,"returns":null,"help":"Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome).\\nOccurs for example on iOS when you put down 4 fingers and the app selector UI appears.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnd","static":false,"returns":null,"help":"The handler for the touchend events.","line":336,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnter","static":false,"returns":null,"help":"For touch enter and leave its a list of the touch points that have entered or left the target.\\nDoesn't appear to be supported by most browsers on a canvas element yet.","line":262,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchLeave","static":false,"returns":null,"help":"For touch enter and leave its a list of the touch points that have entered or left the target.\\nDoesn't appear to be supported by most browsers on a canvas element yet.","line":289,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchMove","static":false,"returns":null,"help":"The handler for the touchmove events.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchStart","static":false,"returns":null,"help":"The internal method that handles the touchstart event from the browser.","line":193,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the event listeners running.","line":124,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop the event listeners.","line":364,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which callbacks are called.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"","inlineHelp":"You can disable all Touch events by setting disabled = true. While set all new touch events will be ignored.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["TouchEvent"],"help":"","inlineHelp":"The browser touch DOM event. Will be set to null if no touch event has ever been received.","line":72,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preventDefault","type":["boolean"],"help":"","inlineHelp":"If true the TouchEvent will have prevent.default called on it.","line":66,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchCancelCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchCancel event.","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchEndCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchEnd event.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchEnterCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchEnter event.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchLeaveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchLeave event.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchMoveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchMove event.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchStartCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchStart event.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onTouchCancel","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":108,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchEnd","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchEnter","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":96,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchLeave","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":102,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchMove","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":114,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchStart","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":78,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Tween.json b/docgen/output/Phaser.Tween.json deleted file mode 100644 index 8d6848bce..000000000 --- a/docgen/output/Phaser.Tween.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Tween","extends":"","static":false,"constructor":true,"parameters":[{"name":"object","type":["object"],"help":"Target object will be affected by this tween.","optional":false,"default":null},{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"manager","type":["Phaser.TweenManager"],"help":"The TweenManager responsible for looking after this Tween.","optional":false,"default":null}],"help":"Tween constructor\\nCreate a new Tween<\/code>."},"consts":[],"methods":{"public":[{"name":"chain","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"You can chain tweens together by passing a reference to the chain function. This enables one tween to call another on completion.\\nYou can pass as many tweens as you like to this function, they will each be chained in sequence.","line":557,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"delay","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Sets a delay time before this tween will start.","line":478,"public":true,"protected":false,"private":false,"parameters":[{"name":"amount","type":["number"],"help":"The amount of the delay in ms.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"easing","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"easing","type":["function"],"help":"The easing function this tween will use, i.e. Phaser.Easing.Linear.None.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"from","static":false,"returns":{"types":["Phaser.Tween"],"help":"This Tween object."},"help":"Sets this tween to be a `from` tween on the properties given. A `from` tween starts at the given value and tweens to the current values.\\nFor example a Sprite with an `x` coordinate of 100 could be tweened from `x: 200` by giving a properties object of `{ x: 200 }`.","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"properties","type":["object"],"help":"Properties you want to tween from.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"Duration of this tween in ms.","optional":true,"default":"1000"},{"name":"ease","type":["function"],"help":"Easing function. If not set it will default to Phaser.Easing.Linear.None.","optional":true,"default":"null"},{"name":"autoStart","type":["boolean"],"help":"Whether this tween will start automatically or not.","optional":true,"default":"false"},{"name":"delay","type":["number"],"help":"Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.","optional":true,"default":"0"},{"name":"repeat","type":["number"],"help":"Should the tween automatically restart once complete? If you want it to run forever set as Number.MAX_VALUE. This ignores any chained tweens.","optional":true,"default":"0"},{"name":"yoyo","type":["boolean"],"help":"A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"generateData","static":false,"returns":{"types":["array"],"help":"An array of tweened values."},"help":"This will generate an array populated with the tweened object values from start to end.\\nIt works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and similar functions.\\nIt ignores delay and repeat counts and any chained tweens. Just one play through of tween data is returned, including yoyo if set.","line":345,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameRate","type":["number"],"help":"The speed in frames per second that the data should be generated at. The higher the value, the larger the array it creates.","optional":true,"default":"60"},{"name":"data","type":["array"],"help":"If given the generated data will be appended to this array, otherwise a new array will be returned.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"interpolation","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Set interpolation function the tween will use, by default it uses Phaser.Math.linearInterpolation.\\nAlso available: Phaser.Math.bezierInterpolation and Phaser.Math.catmullRomInterpolation.","line":543,"public":true,"protected":false,"private":false,"parameters":[{"name":"interpolation","type":["function"],"help":"The interpolation function to use (Phaser.Math.linearInterpolation by default)","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"loop","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Loop a chain of tweens\\n\\nUsage:\\ngame.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)\\n.to({ y: 300 }, 1000, Phaser.Easing.Linear.None)\\n.to({ x: 0 }, 1000, Phaser.Easing.Linear.None)\\n.to({ y: 0 }, 1000, Phaser.Easing.Linear.None)\\n.loop();","line":576,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onUpdateCallback","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Sets a callback to be fired each time this tween updates.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The callback to invoke each time this tween is updated.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which to call the onUpdate callback.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pause","static":false,"returns":null,"help":"Pauses the tween.","line":605,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"repeat","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Sets the number of times this tween will repeat.","line":492,"public":true,"protected":false,"private":false,"parameters":[{"name":"times","type":["number"],"help":"How many times to repeat.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resume","static":false,"returns":null,"help":"Resumes a paused tween.","line":633,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Starts the tween running. Can also be called by the autoStart parameter of Tween.to.","line":291,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Stops the tween if running and removes it from the TweenManager. If there are any onComplete callbacks or events they are not dispatched.","line":459,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"to","static":false,"returns":{"types":["Phaser.Tween"],"help":"This Tween object."},"help":"Sets this tween to be a `to` tween on the properties given. A `to` tween starts at the current value and tweens to the destination value given.\\nFor example a Sprite with an `x` coordinate of 100 could be tweened to `x` 200 by giving a properties object of `{ x: 200 }`.","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"properties","type":["object"],"help":"The properties you want to tween, such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"Duration of this tween in ms.","optional":true,"default":"1000"},{"name":"ease","type":["function"],"help":"Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden at will.","optional":true,"default":"null"},{"name":"autoStart","type":["boolean"],"help":"Whether this tween will start automatically or not.","optional":true,"default":"false"},{"name":"delay","type":["number"],"help":"Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.","optional":true,"default":"0"},{"name":"repeat","type":["number"],"help":"Should the tween automatically restart once complete? If you want it to run forever set as Number.MAX_VALUE. This ignores any chained tweens.","optional":true,"default":"0"},{"name":"yoyo","type":["boolean"],"help":"A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":{"types":["boolean"],"help":"false if the tween has completed and should be deleted from the manager, otherwise true (still active)."},"help":"Core tween update function called by the TweenManager. Does not need to be invoked directly.","line":671,"public":true,"protected":false,"private":false,"parameters":[{"name":"time","type":["number"],"help":"A timestamp passed in by the TweenManager.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"yoyo","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"A tween that has yoyo set to true will run through from start to finish, then reverse from finish to start.\\nUsed in combination with repeat you can create endless loops.","line":508,"public":true,"protected":false,"private":false,"parameters":[{"name":"yoyo","type":["boolean"],"help":"Set to true to yoyo this tween.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_pause","static":false,"returns":null,"help":"This is called by the core Game loop. Do not call it directly, instead use Tween.pause.","line":618,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_resume","static":false,"returns":null,"help":"This is called by the core Game loop. Do not call it directly, instead use Tween.pause.","line":650,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isRunning","type":["boolean"],"help":"","inlineHelp":"If the tween is running this is set to true, otherwise false. Tweens that are in a delayed state, waiting to start, are considered as being running.","line":181,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"onComplete","type":["Phaser.Signal"],"help":"","inlineHelp":"The onComplete event is fired when the Tween completes. Does not fire if the Tween is set to loop.","line":175,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onLoop","type":["Phaser.Signal"],"help":"","inlineHelp":"The onLoop event is fired if the Tween loops.","line":170,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onStart","type":["Phaser.Signal"],"help":"","inlineHelp":"The onStart event is fired when the Tween begins.","line":165,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pendingDelete","type":["boolean"],"help":"","inlineHelp":"If this tween is ready to be deleted by the TweenManager.","line":160,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_chainedTweens","type":["array"],"help":"","inlineHelp":"A private array of chained tweens.","line":113,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_codePaused","type":["boolean"],"help":"","inlineHelp":"Was the Tween paused by code or by Game focus loss?","line":154,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_delayTime","type":["number"],"help":"","inlineHelp":"Private delay counter.","line":88,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_duration","type":["number"],"help":"","inlineHelp":"Private duration counter.","line":60,"default":"1000","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_easingFunction","type":["function"],"help":"","inlineHelp":"The easing function used for the tween.","line":101,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_interpolationFunction","type":["function"],"help":"","inlineHelp":"The interpolation function used for the tween.","line":107,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_manager","type":["Phaser.TweenManager"],"help":"","inlineHelp":"Reference to the TweenManager.","line":35,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_object","type":["object"],"help":"Reference to the target object.","inlineHelp":"","line":24,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onStartCallbackFired","type":["boolean"],"help":"","inlineHelp":"Private flag.","line":120,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onUpdateCallback","type":["function"],"help":"","inlineHelp":"An onUpdate callback.","line":127,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onUpdateCallbackContext","type":["object"],"help":"","inlineHelp":"The context in which to call the onUpdate callback.","line":134,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_paused","type":["boolean"],"help":"","inlineHelp":"Is this Tween paused or not?","line":141,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_pausedTime","type":["number"],"help":"","inlineHelp":"Private pause timer.","line":148,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_repeat","type":["number"],"help":"","inlineHelp":"Private repeat counter.","line":67,"default":"0","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_reversed","type":["boolean"],"help":"","inlineHelp":"Private reversed flag.","line":81,"default":"false","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_startTime","type":["number"],"help":"","inlineHelp":"Private start time counter.","line":95,"default":"null","public":false,"protected":false,"private":true,"readOnly":false},{"name":"_valuesEnd","type":["object"],"help":"","inlineHelp":"Private value object.","line":47,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_valuesStart","type":["object"],"help":"","inlineHelp":"Private value object.","line":41,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_valuesStartRepeat","type":["object"],"help":"","inlineHelp":"Private value object.","line":53,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_yoyo","type":["boolean"],"help":"","inlineHelp":"Private yoyo flag.","line":74,"default":"false","public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.TweenManager.json b/docgen/output/Phaser.TweenManager.json deleted file mode 100644 index d99f29384..000000000 --- a/docgen/output/Phaser.TweenManager.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.TweenManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Game has a single instance of the TweenManager through which all Tween objects are created and updated.\\nTweens are hooked into the game clock and pause system, adjusting based on the game state.\\n\\nTweenManager is based heavily on tween.js by http:\/\/soledadpenades.com.\\nThe difference being that tweens belong to a games instance of TweenManager, rather than to a global TWEEN object.\\nIt also has callbacks swapped for Signals and a few issues patched with regard to properties and completion errors.\\nPlease see https:\/\/github.com\/sole\/tween.js for a full list of contributors."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":null,"help":"Add a new tween into the TweenManager.","line":79,"public":true,"protected":false,"private":false,"parameters":[{"name":"tween","type":["Phaser.Tween"],"help":"The tween object you want to add.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":null,"help":"Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"Object the tween will be run on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAll","static":false,"returns":null,"help":"Get all the tween objects in an array.","line":51,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isTweening","static":false,"returns":null,"help":"Checks to see if a particular Sprite is currently being tweened.","line":175,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The object to check for tweens against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pauseAll","static":false,"returns":null,"help":"Pauses all currently running tweens.","line":218,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Remove a tween from this manager.","line":105,"public":true,"protected":false,"private":false,"parameters":[{"name":"tween","type":["Phaser.Tween"],"help":"The tween object you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.","line":61,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resumeAll","static":false,"returns":null,"help":"Resumes all currently paused tweens.","line":232,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update all the tween objects you added to this manager.","line":131,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_pauseAll","static":false,"returns":null,"help":"Private. Called by game focus loss. Pauses all currently running tweens.","line":189,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_resumeAll","static":false,"returns":null,"help":"Private. Called by game focus loss. Resumes all currently paused tweens.","line":204,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_add","type":["array Phaser.Tween"],"help":"","inlineHelp":"All of the tweens queued to be added in the next update.","line":37,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tweens","type":["array Phaser.Tween"],"help":"","inlineHelp":"All of the currently running tweens.","line":31,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Utils.Debug.json b/docgen/output/Phaser.Utils.Debug.json deleted file mode 100644 index 2aec3087c..000000000 --- a/docgen/output/Phaser.Utils.Debug.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Utils.Debug","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"A collection of methods for displaying debug information about game objects.\\nIf your game is running in WebGL then Debug will create a Sprite that is placed at the top of the Stage display list and bind a canvas texture\\nto it, which must be uploaded every frame. Be advised: this is expenive.\\nIf your game is using a Canvas renderer then the debug information is literally drawn on the top of the active game canvas and no Sprite is used."},"consts":[],"methods":{"public":[{"name":"body","static":false,"returns":null,"help":"Render a Sprites Physics body if it has one set. Note this only works for Arcade and\\nNinja (AABB, circle only) Physics.\\nTo display a P2 body you should enable debug mode on the body when creating it.","line":739,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The sprite whos body will be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgba(0,255,0,0.4)'"},{"name":"filled","type":["boolean"],"help":"Render the objected as a filled (default, true) or a stroked (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"bodyInfo","static":false,"returns":null,"help":"Render a Sprites Physic Body information.","line":772,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The sprite to be rendered.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"box2dBody","static":false,"returns":null,"help":"Renders 'debug draw' data for the given Box2D body.\\nThis uses the standard debug drawing feature of Box2D, so colors will be decided by the Box2D engine.","line":818,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The sprite whos body will be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(0,255,0)'"}],"inherited":false,"inheritedFrom":""},{"name":"box2dWorld","static":false,"returns":null,"help":"Renders 'debug draw' data for the Box2D world if it exists.\\nThis uses the standard debug drawing feature of Box2D, so colors will be decided by\\nthe Box2D engine.","line":799,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"cameraInfo","static":false,"returns":null,"help":"Render camera information including dimensions and location.","line":284,"public":true,"protected":false,"private":false,"parameters":[{"name":"camera","type":["Phaser.Camera"],"help":"The Phaser.Camera to show the debug information for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"geom","static":false,"returns":null,"help":"Renders a Rectangle.","line":635,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["Phaser.Rectangle","object"],"help":"The geometry object to render.","optional":false,"default":null},{"name":"color","type":["string"],"help":"Color of the debug info to be rendered (format is css color string).","optional":true,"default":null},{"name":"filled","type":["boolean"],"help":"Render the objected as a filled (default, true) or a stroked (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"inputInfo","static":false,"returns":null,"help":"Render debug information about the Input object.","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"key","static":false,"returns":null,"help":"Renders Phaser.Key object information.","line":409,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["Phaser.Key"],"help":"The Key to render the information for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"lineInfo","static":false,"returns":null,"help":"Renders Line information in the given color.","line":532,"public":true,"protected":false,"private":false,"parameters":[{"name":"line","type":["Phaser.Line"],"help":"The Line to display the data for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"pixel","static":false,"returns":null,"help":"Renders a single pixel at the given size.","line":551,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"X position of the pixel to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the pixel to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"Color of the pixel (format is css color string).","optional":true,"default":null},{"name":"size","type":["number"],"help":"The 'size' to render the pixel at.","optional":true,"default":"2"}],"inherited":false,"inheritedFrom":""},{"name":"pointer","static":false,"returns":null,"help":"Renders the Pointer.circle object onto the stage in green if down or red if up along with debug text.","line":329,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"The Pointer you wish to display.","optional":false,"default":null},{"name":"hideIfUp","type":["boolean"],"help":"Doesn't render the circle if the pointer is up.","optional":true,"default":"false"},{"name":"downColor","type":["string"],"help":"The color the circle is rendered in if down.","optional":true,"default":"'rgba(0,255,0,0.5)'"},{"name":"upColor","type":["string"],"help":"The color the circle is rendered in if up (and hideIfUp is false).","optional":true,"default":"'rgba(255,0,0,0.5)'"},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Internal method that clears the canvas (if a Sprite) ready for a new debug session.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"quadTree","static":false,"returns":null,"help":"Visually renders a QuadTree to the display.","line":696,"public":true,"protected":false,"private":false,"parameters":[{"name":"quadtree","type":["Phaser.QuadTree"],"help":"The quadtree to render.","optional":false,"default":null},{"name":"color","type":["string"],"help":"The color of the lines in the quadtree.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Clears the Debug canvas.","line":147,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"ropeSegments","static":false,"returns":null,"help":"Renders the Rope's segments. Note: This is really expensive as it has to calculate new segments everytime you call it","line":467,"public":true,"protected":false,"private":false,"parameters":[{"name":"rope","type":["Phaser.Rope"],"help":"The rope to display the segments of.","optional":false,"default":null},{"name":"color","type":["string"],"help":"Color of the debug info to be rendered (format is css color string).","optional":true,"default":null},{"name":"filled","type":["boolean"],"help":"Render the rectangle as a fillRect (default, true) or a strokeRect (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"soundInfo","static":false,"returns":null,"help":"Render Sound information, including decoded state, duration, volume and more.","line":253,"public":true,"protected":false,"private":false,"parameters":[{"name":"sound","type":["Phaser.Sound"],"help":"The sound object to debug.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"spriteBounds","static":false,"returns":null,"help":"Renders the Sprites bounds. Note: This is really expensive as it has to calculate the bounds every time you call it!","line":449,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image"],"help":"The sprite to display the bounds of.","optional":false,"default":null},{"name":"color","type":["string"],"help":"Color of the debug info to be rendered (format is css color string).","optional":true,"default":null},{"name":"filled","type":["boolean"],"help":"Render the rectangle as a fillRect (default, true) or a strokeRect (false)","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"spriteCoords","static":false,"returns":null,"help":"Renders the sprite coordinates in local, positional and world space.","line":506,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image"],"help":"The sprite to display the coordinates for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"spriteInfo","static":false,"returns":null,"help":"Render debug infos (including name, bounds info, position and some other properties) about the Sprite.","line":484,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite to display the information of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"spriteInputInfo","static":false,"returns":null,"help":"Render Sprite Input Debug information.","line":388,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image"],"help":"The sprite to display the input data for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""},{"name":"text","static":false,"returns":null,"help":"Render a string of text.","line":668,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The line of text to draw.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"Color of the debug info to be rendered (format is css color string).","optional":true,"default":null},{"name":"font","type":["string"],"help":"The font of text to draw.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"timer","static":false,"returns":null,"help":"Render Timer information.","line":309,"public":true,"protected":false,"private":false,"parameters":[{"name":"timer","type":["Phaser.Timer"],"help":"The Phaser.Timer to show the debug information for.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the debug info to be rendered.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the debug info to be rendered.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug info to be rendered. (format is css color string).","optional":true,"default":"'rgb(255,255,255)'"}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Internal method that boots the debug displayer.","line":108,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"line","static":false,"returns":null,"help":"Internal method that outputs a single line of text split over as many columns as needed, one per parameter.","line":222,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Internal method that resets and starts the debug output values.","line":171,"public":false,"protected":true,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X value the debug info will start from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The Y value the debug info will start from.","optional":true,"default":"0"},{"name":"color","type":["string"],"help":"The color the debug text will drawn in.","optional":true,"default":"'rgb(255,255,255)'"},{"name":"columnWidth","type":["number"],"help":"The spacing between columns.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Internal method that stops the debug output.","line":204,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"baseTexture","type":["PIXI.BaseTexture"],"help":"","inlineHelp":"Required Pixi var.","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"","inlineHelp":"The canvas to which this BitmapData draws.","line":32,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"columnWidth","type":["number"],"help":"","inlineHelp":"The spacing between columns.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"","inlineHelp":"The 2d context of the canvas.","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentAlpha","type":["number"],"help":"","inlineHelp":"The current alpha the debug information will be rendered at.","line":91,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentX","type":["number"],"help":"","inlineHelp":"The current X position the debug information will be rendered at.","line":79,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"currentY","type":["number"],"help":"","inlineHelp":"The current Y position the debug information will be rendered at.","line":85,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"Does the canvas need re-rendering?","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"font","type":["string"],"help":"","inlineHelp":"The font that the debug information is rendered in.","line":58,"default":"'14px Courier'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineHeight","type":["number"],"help":"","inlineHelp":"The line height between the debug text.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderShadow","type":["boolean"],"help":"","inlineHelp":"Should the text be rendered with a slight shadow? Makes it easier to read on different types of background.","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sprite","type":["PIXI.Sprite"],"help":"","inlineHelp":"If debugging in WebGL mode we need this.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"","inlineHelp":"Required Pixi var.","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"textureFrame","type":["Phaser.Frame"],"help":"","inlineHelp":"Dimensions of the renderable area.","line":47,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.Utils.json b/docgen/output/Phaser.Utils.json deleted file mode 100644 index 168eea73c..000000000 --- a/docgen/output/Phaser.Utils.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.Utils","extends":"","static":true,"constructor":false,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"extend","static":false,"returns":{"types":["object"],"help":"The extended object."},"help":"This is a slightly modified version of http:\/\/api.jquery.com\/jQuery.extend\/","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"deep","type":["boolean"],"help":"Perform a deep copy?","optional":false,"default":null},{"name":"target","type":["object"],"help":"The target object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getProperty","static":false,"returns":{"types":["any"],"help":"the value of the property or null if property isn't found ."},"help":"Gets an objects property by string.","line":23,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to traverse.","optional":false,"default":null},{"name":"prop","type":["string"],"help":"The property whose value will be returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isPlainObject","static":false,"returns":{"types":["boolean"],"help":"- true if the object is plain, otherwise false."},"help":"This is a slightly modified version of jQuery.isPlainObject. A plain object is an object whose internal class property is [object Object].","line":256,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to inspect.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mixin","static":false,"returns":{"types":["object"],"help":"The modified destination object."},"help":"Mixes the source object into the destination object, returning the newly modified destination object.\\nBased on original code by @mudcube","line":373,"public":true,"protected":false,"private":false,"parameters":[{"name":"from","type":["object"],"help":"The object to copy (the source object).","optional":false,"default":null},{"name":"to","type":["object"],"help":"The object to copy to (the destination object).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pad","static":false,"returns":{"types":["string"],"help":"The padded string"},"help":"Javascript string pad http:\/\/www.webtoolkit.info\/.\\npad = the string to pad it out with (defaults to a space)\\ndir = 1 (left), 2 (right), 3 (both)","line":218,"public":true,"protected":false,"private":false,"parameters":[{"name":"str","type":["string"],"help":"The target string.","optional":false,"default":null},{"name":"len","type":["number"],"help":"The number of characters to be added.","optional":false,"default":null},{"name":"pad","type":["number"],"help":"The string to pad it out with (defaults to a space).","optional":false,"default":null},{"name":"dir","type":["number"],"help":" The direction dir = 1 (left), 2 (right), 3 (both).","optional":true,"default":"3"}],"inherited":false,"inheritedFrom":""},{"name":"parseDimension","static":false,"returns":{"types":["number"],"help":"The parsed dimension."},"help":"Get a unit dimension from a string.","line":152,"public":true,"protected":false,"private":false,"parameters":[{"name":"size","type":["string","number"],"help":"The size to parse.","optional":false,"default":null},{"name":"dimension","type":["number"],"help":"The window dimension to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rotateArray","static":false,"returns":{"types":["array"],"help":"The rotated array"},"help":"Rotates the given array.\\nBased on the routine from http:\/\/jsfiddle.net\/MrPolywhirl\/NH42z\/","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["array"],"help":"The array to rotate.","optional":false,"default":null},{"name":"direction","type":["number","string"],"help":"The amount to rotate. Either a number: 90, -90, 270, -270, 180 or a string: 'rotateLeft', 'rotateRight' or 'rotate180'","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setProperty","static":false,"returns":{"types":["object"],"help":"The object on which the property was set."},"help":"Sets an objects property by string.","line":56,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to traverse","optional":false,"default":null},{"name":"prop","type":["string"],"help":"The property whose value will be changed","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shuffle","static":false,"returns":{"types":["array"],"help":"The shuffled array."},"help":"A standard Fisher-Yates Array shuffle implementation.","line":193,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to shuffle.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"transposeArray","static":false,"returns":{"types":["array"],"help":"The transposed array."},"help":"Transposes the elements of the given Array.","line":86,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to transpose.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/output/Phaser.World.json b/docgen/output/Phaser.World.json deleted file mode 100644 index e49977700..000000000 --- a/docgen/output/Phaser.World.json +++ /dev/null @@ -1 +0,0 @@ -{"class":{"name":"Phaser.World","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Reference to the current game instance.","optional":false,"default":null}],"help":"\"This world is but a canvas to our imagination.\" - Henry David Thoreau\\n\\nA game has only one world. The world is an abstract place in which all game objects live. It is not bound\\nby stage limits and can be any size. You look into the world via cameras. All game objects live within\\nthe world at world-based coordinates. By default a world is created the same size as your Stage."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addMultiple","static":false,"returns":{"types":["any"],"help":"The array of children that were added to the Group."},"help":"Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.\\nThe children are automatically added to the top of the Group, so render on-top of everything else within the Group.\\nTODO: Add ability to pass the children as parameters rather than having to be an array.","line":249,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"ascendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1385,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"bringToTop","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Brings the given child to the top of this Group so it renders above all other children.","line":509,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to bring to the top of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)\\nAfter the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.","line":1095,"public":true,"protected":false,"private":false,"parameters":[{"name":"method","type":["string"],"help":"A string containing the name of the function that will be called. The function must exist on the child.","optional":false,"default":null},{"name":"context","type":["string"],"help":"A string containing the context under which the method will be executed. Set to null to default to the child.","optional":true,"default":"null"},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the method.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"callAllExists","static":false,"returns":null,"help":"Calls a function on all of the children that have exists=true in this Group.\\nAfter the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that exists on the children that will be called.","optional":false,"default":null},{"name":"existsValue","type":["boolean"],"help":"Only children with exists=existsValue will be called.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkAll","static":false,"returns":null,"help":"This function allows you to quickly check that the same property across all children of this Group is equal to the given value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be checked on the Group but not its children.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be checked. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"checkProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was was equal to value, false if not."},"help":"Checks a property for the given value on the child.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be checked.","optional":false,"default":null},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"countDead","static":false,"returns":{"types":["number"],"help":"The number of children flagged as dead."},"help":"Call this function to find out how many members of the group are dead.","line":1582,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"countLiving","static":false,"returns":{"types":["number"],"help":"The number of children flagged as alive."},"help":"Call this function to find out how many members of the group are alive.","line":1570,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"create","static":false,"returns":{"types":["Phaser.Sprite","object"],"help":"The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed."},"help":"Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":335,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"true"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"createMultiple","static":false,"returns":null,"help":"Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.\\nUseful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist\\nand will be positioned at 0, 0 (relative to the Group.x\/y)\\nYou can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.","line":380,"public":true,"protected":false,"private":false,"parameters":[{"name":"quantity","type":["number"],"help":"The number of Sprites to create.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The Game.cache key of the image that this Sprite will use.","optional":false,"default":null},{"name":"frame","type":["number","string"],"help":"If the Sprite image contains multiple frames you can specify which one to use here.","optional":true,"default":null},{"name":"exists","type":["boolean"],"help":"The default exists state of the Sprite.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"customSort","static":false,"returns":null,"help":"This allows you to use your own sort handler function.\\nIt will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.","line":1364,"public":true,"protected":false,"private":false,"parameters":[{"name":"sortHandler","type":["function"],"help":"Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.","optional":false,"default":null},{"name":"context","type":["object"],"help":"The scope in which the sortHandler is called.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"descendingSortHandler","static":false,"returns":null,"help":"An internal helper function for the sort process.","line":1416,"public":true,"protected":false,"private":false,"parameters":[{"name":"a","type":["object"],"help":"The first object being sorted.","optional":false,"default":null},{"name":"b","type":["object"],"help":"The second object being sorted.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Group. Removes all children, then removes the container from the display list and nulls references.","line":1751,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this Group have its destroy method called?","optional":true,"default":"true"},{"name":"soft","type":["boolean"],"help":"A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"divideAll","static":false,"returns":null,"help":"Divides the given property by the amount on all children in this Group.\\nGroup.divideAll('x', 2) will half the child.x value.","line":1004,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to divide, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"filter","static":false,"returns":{"types":["Phaser.ArrayList"],"help":"Returns an array list containing all the children that the predicate returned true for"},"help":"Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate\\nFor example:\\nvar healthyList = Group.filter(function(child, index, children) {\\nreturn child.health > 10 ? true : false;\\n}, true);\\nhealthyList.callAll('attack');\\nNote: Currently this will skip any children which are Groups themselves.","line":1223,"public":true,"protected":false,"private":false,"parameters":[{"name":"predicate","type":["function"],"help":"The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEach","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.\\nAfter the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEach(awardBonusGold, this, true, 100, 500)\\nNote: Currently this will skip any children which are Groups themselves.","line":1250,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null},{"name":"checkExists","type":["boolean"],"help":"If set only children with exists=true will be passed to the callback, otherwise all children will be passed.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachAlive","static":false,"returns":null,"help":"Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachAlive(causeDamage, this, 500)","line":1295,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachDead","static":false,"returns":null,"help":"Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachDead(bringToLife, this)","line":1313,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"forEachExists","static":false,"returns":null,"help":"Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.\\nYou can add as many parameters as you like, which will all be passed to the callback along with the child.\\nFor example: Group.forEachExists(causeDamage, this, 500)","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function that will be called. Each child of the Group will be passed to it as its first parameter.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getAt","static":false,"returns":{"types":["any"],"help":"The child that was found at the given index. If the index was out of bounds then this will return -1."},"help":"Returns the child found at the given index within this Group.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to return the child from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBottom","static":false,"returns":{"types":["any"],"help":"The child at the bottom of the Group."},"help":"Returns the child at the bottom of this Group. The bottom is the one being displayed (rendered) below every other child.","line":1555,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","line":299,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.DisplayObjectContainer"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getFirstAlive","static":false,"returns":{"types":["any"],"help":"The first alive child, or null if none found."},"help":"Call this function to retrieve the first object with alive === true in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1515,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstDead","static":false,"returns":{"types":["any"],"help":"The first dead child, or null if none found."},"help":"Call this function to retrieve the first object with alive === false in the group.\\nThis is handy for checking if everything has been wiped out, or choosing a squad leader, etc.","line":1528,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getFirstExists","static":false,"returns":{"types":["any"],"help":"The first child, or null if none found."},"help":"Call this function to retrieve the first object with exists == (the given state) in the Group.","line":1497,"public":true,"protected":false,"private":false,"parameters":[{"name":"state","type":["boolean"],"help":"True or false.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if it's not a member of this Group."},"help":"Get the index position of the given child in this Group. This should always match the childs z property.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to get the index for.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getRandom","static":false,"returns":{"types":["any"],"help":"A random child of this Group."},"help":"Returns a member at random from the group.","line":1596,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"Optional offset off the front of the array. Default value is 0, or the beginning of the array.","optional":false,"default":null},{"name":"length","type":["number"],"help":"Optional restriction on the number of values you want to randomly select from.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"getTop","static":false,"returns":{"types":["any"],"help":"The child at the top of the Group."},"help":"Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.","line":1540,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"hasProperty","static":false,"returns":{"types":["boolean"],"help":"True if the child has the property, otherwise false."},"help":"Checks if the child has the given property. Will scan up to 4 levels deep only.","line":679,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to check for the existance of the property on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"iterate","static":false,"returns":{"types":["any"],"help":"Returns either a numeric total (if RETURN_TOTAL was specified) or the child object."},"help":"Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.\\nMatched children can be sent to the optional callback, or simply returned or counted.\\nYou can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.","line":1446,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The child property to check, i.e. 'exists', 'alive', 'health'","optional":false,"default":null},{"name":"value","type":["any"],"help":"If child.key === this value it will be considered a match. Note that a strict comparison is used.","optional":false,"default":null},{"name":"returnType","type":["number"],"help":"How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.","optional":true,"default":"null"},{"name":"callbackContext","type":["object"],"help":"The context in which the function should be called (usually 'this').","optional":true,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"moveDown","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child down one place in this Group unless it's already at the top.","line":571,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move down in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"moveUp","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Moves the given child up one place in this Group unless it's already at the top.","line":547,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to move up in the Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"multiplyAll","static":false,"returns":null,"help":"Multiplies the given property by the amount on all children in this Group.\\nGroup.multiplyAll('x', 2) will x2 the child.x value.","line":988,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to multiply, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"next","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.","line":439,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"previous","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.","line":466,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"remove","static":false,"returns":{"types":["boolean"],"help":"true if the child was removed from this Group, otherwise false."},"help":"Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),\\nreset the Group cursor and optionally destroy the child.","line":1620,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to remove.","optional":false,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onRemovedFromGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeAll","static":false,"returns":null,"help":"Removes all children from this Group, setting the group properties of the children to `null`.\\nThe Group container remains on the display list.","line":1661,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on each child that is removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeBetween","static":false,"returns":null,"help":"Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.","line":1700,"public":true,"protected":false,"private":false,"parameters":[{"name":"startIndex","type":["number"],"help":"The index to start removing children from.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the Group.","optional":true,"default":null},{"name":"destroy","type":["boolean"],"help":"You can optionally call destroy on the child that was removed.","optional":true,"default":"false"},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the children will not dispatch their onRemovedFromGroup events.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"replace","static":false,"returns":{"types":["any"],"help":"Returns the oldChild that was replaced within this Group."},"help":"Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.","line":643,"public":true,"protected":false,"private":false,"parameters":[{"name":"oldChild","type":["any"],"help":"The child in this Group that will be replaced.","optional":false,"default":null},{"name":"newChild","type":["any"],"help":"The child to be inserted into this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"resetCursor","static":false,"returns":{"types":["any"],"help":"The child the cursor now points to."},"help":"Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.","line":415,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"Set the cursor to point to a specific index.","optional":true,"default":"0"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"reverse","static":false,"returns":null,"help":"Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.","line":615,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"sendToBack","static":false,"returns":{"types":["any"],"help":"The child that was moved."},"help":"Sends the given child to the bottom of this Group so it renders below all other children.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to send to the bottom of this Group.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"set","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"This function allows you to quickly set a property on a single child of this Group to a new value.\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":823,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["Phaser.Sprite"],"help":"The child to set the property on.","optional":false,"default":null},{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then the child will only be updated if alive=true.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then the child will only be updated if visible=true.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAll","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group to a new value.\\nThis call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.\\nIf you need that ability please see `Group.setAllChildren`.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":854,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setAllChildren","static":false,"returns":null,"help":"This function allows you to quickly set the same property across all children of this Group, and any child Groups, to a new value.\\n\\nIf this Group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.\\nUnlike with Group.setAll the property is NOT set on child Groups itself.\\n\\nThe operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.","line":889,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The property, as a string, to be set. For example: 'body.velocity.x'","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If set then only children with alive=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"checkVisible","type":["boolean"],"help":"If set then only children with visible=true will be updated. This includes any Groups that are children.","optional":true,"default":"false"},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setBounds","static":false,"returns":null,"help":"Updates the size of this world. Note that this doesn't modify the world x\/y coordinates, just the width and height.\\nThe Camera bounds and Physics bounds (if set) are also updated to match the new World bounds.","line":88,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Top left most corner of the world.","optional":false,"default":null},{"name":"width","type":["number"],"help":"New width of the game world in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"New height of the game world in pixels.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setProperty","static":false,"returns":{"types":["boolean"],"help":"True if the property was set, false if not."},"help":"Sets a property to the given value on the child. The operation parameter controls how the value is set.\\nOperation 0 means set the existing value to the given value, or if force is `false` create a new property with the given value.\\n1 will add the given value to the value already present.\\n2 will subtract the given value from the value already present.\\n3 will multiply the value already present by the given value.\\n4 will divide the value already present by the given value.","line":720,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"The child to set the property value on.","optional":false,"default":null},{"name":"key","type":["array"],"help":"An array of strings that make up the property that will be set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value that will be set.","optional":false,"default":null},{"name":"operation","type":["number"],"help":"Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.","optional":true,"default":"0"},{"name":"force","type":["boolean"],"help":"If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"shutdown","static":false,"returns":null,"help":"Destroyer of worlds.","line":137,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"sort","static":false,"returns":null,"help":"Call this function to sort the group according to a particular value and order.\\nFor example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.","line":1330,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["string"],"help":"The `string` name of the property you want to sort on. Defaults to the objects z-depth value.","optional":true,"default":"'z'"},{"name":"order","type":["number"],"help":"The `Group` constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.","optional":true,"default":"Phaser.Group.SORT_ASCENDING"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"subAll","static":false,"returns":null,"help":"Subtracts the amount from the given property on all children in this Group.\\nGroup.subAll('x', 10) will minus 10 from the child.x value.","line":972,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to decrement, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swap","static":false,"returns":null,"help":"Swaps the position of two children in this Group. Both children must be in this Group.\\nYou cannot swap a child with itself, or swap un-parented children.","line":495,"public":true,"protected":false,"private":false,"parameters":[{"name":"child1","type":["any"],"help":"The first child to swap.","optional":false,"default":null},{"name":"child2","type":["any"],"help":"The second child to swap.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"wrap","static":false,"returns":null,"help":"This will take the given game object and check if its x\/y coordinates fall outside of the world bounds.\\nIf they do it will reposition the object to the opposite side of the world, creating a wrap-around effect.\\nIf sprite has a P2 body then the body (sprite.body) should be passed as first parameter to the function.","line":156,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["Phaser.Sprite","Phaser.Image","Phaser.TileSprite","Phaser.Text"],"help":"The object you wish to wrap around the world bounds.","optional":false,"default":null},{"name":"padding","type":["number"],"help":"Extra padding added equally to the sprite.x and y coordinates before checking if within the world bounds. Ignored if useBounds is true.","optional":true,"default":"0"},{"name":"useBounds","type":["boolean"],"help":"If useBounds is false wrap checks the object.x\/y coordinates. If true it does a more accurate bounds check, which is more expensive.","optional":true,"default":"false"},{"name":"horizontal","type":["boolean"],"help":"If horizontal is false, wrap will not wrap the object.x coordinates horizontally.","optional":true,"default":"true"},{"name":"vertical","type":["boolean"],"help":"If vertical is false, wrap will not wrap the object.y coordinates vertically.","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"xy","static":false,"returns":null,"help":"Positions the child found at the given index within this Group to the given x and y coordinates.","line":596,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the child in the Group to set the position of.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The new x position of the child.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The new y position of the child.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Initialises the game world.","line":64,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[],"static":[]},"properties":{"public":[{"name":"_definedSize","type":["boolean"],"help":"","inlineHelp":"True if the World has been given a specifically defined size (i.e. from a Tilemap or direct in code) or false if it's just matched to the Game dimensions.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"alive","type":["boolean"],"help":"","inlineHelp":"The alive property is useful for Groups that are children of other Groups and need to be included\/excluded in checks like forEachAlive.","line":71,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in degrees, where 0 degrees = to the right.","line":1814,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"bounds","type":["Phaser.Rectangle"],"help":"The World has no fixed size, but it does have a bounds outside of which objects are no longer considered as being \"in world\" and you should use this to clean-up the display list and purge dead objects.\\nBy default we set the Bounds to be from 0,0 to Game.width,Game.height. I.e. it will match the size given to the game constructor with 0,0 representing the top-left of the display.\\nHowever 0,0 is actually the center of the world, and if you rotate or scale the world all of that will happen from 0,0.\\nSo if you want to make a game in which the world itself will rotate you should adjust the bounds so that 0,0 is the center point, i.e. set them to -1000,-1000,2000,2000 for a 2000x2000 sized world centered around 0,0.","inlineHelp":"Bound of this world that objects can not escape from.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"camera","type":["Phaser.Camera"],"help":"","inlineHelp":"Camera instance.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":116,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerX","type":["number"],"help":"","inlineHelp":"Gets the X position corresponding to the center point of the world.","line":269,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"centerY","type":["number"],"help":"","inlineHelp":"Gets the Y position corresponding to the center point of the world.","line":282,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"classType","type":["object"],"help":"The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.\\nWhen a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.","inlineHelp":"","line":91,"default":"Phaser.Sprite","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cursor","type":["any"],"help":"The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.\\nThe cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.","inlineHelp":"The current display object that the Group cursor is pointing to.","line":111,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBody","type":["boolean"],"help":"","inlineHelp":"If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with `Group.physicsBodyType`.","line":122,"default":"enableBody","public":true,"protected":false,"private":false,"readOnly":false},{"name":"enableBodyDebug","type":["boolean"],"help":"","inlineHelp":"If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. Only works for P2 bodies.","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists is true the Group is updated, otherwise it is skipped.","line":77,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"A Group that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Group to the Camera at its current world coordinates.","line":1834,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Gets or sets the current height of the game world. The world can never be smaller than the game (canvas) dimensions.","line":243,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"ignoreDestroy","type":["boolean"],"help":"","inlineHelp":"A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.","line":83,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"length","type":["number"],"help":"","inlineHelp":"The total number of children in this Group, regardless of their exists\/alive status.","line":1798,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"mask","type":["PIXI.Graphics"],"help":"Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"A name for this Group. Not used internally but useful for debugging.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onDestroy","type":["Phaser.Signal"],"help":"","inlineHelp":"This signal is dispatched when the parent is destoyed.","line":137,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["Phaser.Group","Phaser.Sprite"],"help":"","inlineHelp":"The parent of this Group.","line":96,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physicsBodyType","type":["number"],"help":"","inlineHelp":"If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pivot","type":["Phaser.Point"],"help":"","inlineHelp":"The pivot point of the Group container.","line":105,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"randomX","type":["number"],"help":"","inlineHelp":"Gets a random integer which is lesser than or equal to the current width of the game world.","line":295,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"randomY","type":["number"],"help":"","inlineHelp":"Gets a random integer which is lesser than or equal to the current height of the game world.","line":317,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation.\\nThis will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The angle of rotation given in radians.","line":1879,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"","inlineHelp":"The scale of the Group container.","line":100,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"total","type":["number"],"help":"","inlineHelp":"The total number of children in this Group who have a state of exists = true.","line":1783,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"The visible state of the Group. Non-visible Groups and all of their children are not rendered.","line":1884,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"Gets or sets the current width of the game world. The world can never be smaller than the game (canvas) dimensions.","line":218,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The x coordinate of the Group container.","line":1865,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates.\\nThis will have no impact on the x\/y coordinates of its children, but it will update their worldTransform and on-screen position.","inlineHelp":"The y coordinate of the Group container.","line":1872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}} \ No newline at end of file diff --git a/docgen/project/Phaser Doc Gen.dsk b/docgen/project/Phaser Doc Gen.dsk deleted file mode 100644 index 12f043a78..000000000 --- a/docgen/project/Phaser Doc Gen.dsk +++ /dev/null @@ -1,85 +0,0 @@ -[Info] -Version=14.0 -Comments= -Created=0 -LastUsed=41828.6571639468 - -[Groups] -Groups=1 - -[Files] -Group0=0 -File0=D:\wamp\www\phaser\docgen\src\ClassDesc.php -Cursor0.X=0 -Cursor0.Y=12 -WordWrap0=0 -Scroll0.0.X=0 -Scroll0.0.Y=0 -IsSplitted0=0 -ZIndex0=4 -Group1=0 -File1=D:\wamp\www\phaser\docgen\src\Processor.php -Cursor1.X=0 -Cursor1.Y=100 -WordWrap1=0 -Scroll1.0.X=0 -Scroll1.0.Y=61 -IsSplitted1=0 -ZIndex1=3 -Group2=0 -File2=D:\wamp\www\phaser\docgen\src\Block.php -Cursor2.X=0 -Cursor2.Y=77 -WordWrap2=0 -Scroll2.0.X=0 -Scroll2.0.Y=71 -IsSplitted2=0 -ZIndex2=5 -Group3=0 -File3=D:\wamp\www\phaser\docgen\json.php -Cursor3.X=0 -Cursor3.Y=22 -WordWrap3=0 -Scroll3.0.X=0 -Scroll3.0.Y=1 -IsSplitted3=0 -ZIndex3=2 -Group4=0 -File4=D:\wamp\www\phaser\docgen\src\Constant.php -Cursor4.X=0 -Cursor4.Y=45 -WordWrap4=0 -Scroll4.0.X=0 -Scroll4.0.Y=11 -IsSplitted4=0 -IsActive4=1 -ZIndex4=0 -Group5=0 -File5=D:\wamp\www\phaser\docgen\src\Method.php -Cursor5.X=0 -Cursor5.Y=20 -WordWrap5=0 -Scroll5.0.X=0 -Scroll5.0.Y=0 -IsSplitted5=0 -ZIndex5=1 -Files=6 - -[parameters] -value=LCw - -[workspace] -Phaser Doc Gen:Phaser Doc Gen=1 -Phaser Doc Gen:Phaser Doc Gen:output=1 -ActiveProject=Phaser Doc Gen - -[watches] -count=0 - -[Workset] -Worksets=0 -ActiveWorkset= - -[breakpoints] -bp_count=0 - diff --git a/docgen/project/Phaser Doc Gen.ppd b/docgen/project/Phaser Doc Gen.ppd deleted file mode 100644 index cb61e2d0b..000000000 --- a/docgen/project/Phaser Doc Gen.ppd +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docgen/project/Phaser Doc Gen.ppj b/docgen/project/Phaser Doc Gen.ppj deleted file mode 100644 index ec9dd3220..000000000 --- a/docgen/project/Phaser Doc Gen.ppj +++ /dev/null @@ -1,128 +0,0 @@ -[Debugger] -dbgsessions=1 -stopbeginning=1 -excset= -errlevel=3 - All errors and warnings -profwithdbg=0 -excign= -breakexc= -cp=System default encoding -tunnel= -readonlyed=0 -host=clienthost -custom=0 -errset= -sesstimeout=15 -blkout= -Custom.Debug.Settings=0 -showmaperrors=1 -breakerr= - -[PHPEdProject.Filters.Allow] -\= - -[Test.Suite] -/=> - -[PHPEdProject.Filters] -\= - -[Encoder] -excl=0 -asptags=0 -stoponerr=0 -obfusclevel=0 -extinfo=0 -phpdoc=1 -licensing=0 -compatibilitylevel=1 -copyall=1 -suppresssucc=0 -headertype=0 -lineinfo=0 -shorttags=1 -destinationtype=0 - -[PHPEdProject.Encodings] -\=UTF-8 - -[Wizard] -srunmode=1 -sprojectroot=D:\wamp\www\phaser\docgen -sremotewebroot=d:\wamp\www\phaser\docgen\ -swebrooturl=http://localhost/ - -[PHPEdProject.JSLibraries] -Count=0 - -[Testing] -TestingCustomLoader= -TestingCustomLoaderExtraArg= -TestingConfig= -FindTestMode=0 -TestingRoot= -EnableTesting=0 - -[PHPEdProject] -HideDirs=CVS;.svn -CvsRoot= -MappingLocal0=D:\wamp\www\phaser\docgen -ParserProp_CSS_SubLang=1 -UrlMappingCount=0 -CvsModule= -EncoderEnabled=0 -DefaultEncodingCount=1 -CvsPassw=KQ66584HSbX6s4CB8Z9rjbXL+NlON3xlm+MDMZPPfj0y+4yJwWdnFQ0TBeEI//zt0iuqOXGXnsW/QzORoi/snQ== -DriverID= -IncPath_count=0 -UsedPHPFrameworkPath= -RelativeRootDir=..\..\docgen -MappingMainIdx=0 -ParserProp_CSS_ParsePHP=0 -MappingURL0= -ParserProp_PHP_AspTags=0 -MappingPublishingRoot= -MappingRemote0= -CvsHost= -RunMode=1 -CvsMethod=pserver -CvsUser= -URL= -CvsCVSROOT=:pserver:@ -DefaultFile= -ChangeTime=0 -RemoteCliAccount= -ParserProp_JS_ParsePHP=0 -ParserProp_Override=1 -GUID={CF5D4786-6D94-4B0B-A2E6-44BE31187F34} -RemoteCliPhp= -CvsUseUtf8=0 -MappingCount=1 -ParserProp_AllowSingleAsteriskXDoc=1 -UsedPHPFrameworkId= -PublishingAllowFilterCount=1 -MappingRemoteDir= -DontPublishDirs=CVS;.svn -MappingPublishing0= -SourceControl=0 -ScriptRunTarget=1 -ParserProp_HTML_SubLang=2 -UsedPHPFrameworkChecked=0 -ParserPropPHPShortTags=0 -ParserProp_PHP_SubLang=3 -HideFiles=.gitignore;.cvsignore -CustomPropCount=0 -PublishingFilterCount=1 - -[Publishing] -publmap.main0=0 -publmap.publishingdriverid0= -DebuggerPublishingIdx=0 -publmap.publishing0.0= -count=1 -DfltPublishingIdx=0 -publmap.local0.0=D:\wamp\www\phaser\docgen -publmap.count0=1 -publmap.prjdriverid0= -caption0= - diff --git a/docgen/project/Phaser Doc Gen.ppw b/docgen/project/Phaser Doc Gen.ppw deleted file mode 100644 index ee1107d81..000000000 --- a/docgen/project/Phaser Doc Gen.ppw +++ /dev/null @@ -1,11 +0,0 @@ -[PHPEdWorkspace] -Unloaded0=0 -Drv_LastDir=D:\wamp\www\phaser\docgen -Drv_LastLocalDir=D:\wamp\www\phaser\docgen -Project0=D:\wamp\www\phaser\docgen\project\Phaser Doc Gen.ppj -Drv_LastFilterIndex=-1 -Drv_LastFilter= -ActiveProject=D:\wamp\www\phaser\docgen\project\Phaser Doc Gen.ppj -Drv_LastDrv= -ProjectCount=1 - diff --git a/docgen/project/Phaser Doc Gen.ppx b/docgen/project/Phaser Doc Gen.ppx deleted file mode 100644 index e6137184f..000000000 --- a/docgen/project/Phaser Doc Gen.ppx +++ /dev/null @@ -1 +0,0 @@ -<_root _check="0"><_ver ParserProp_Override="1" ParserProp_PHP_SubLang="3" ParserPropPHPShortTags="0" ParserProp_PHP_AspTags="0" ParserProp_JS_ParsePHP="0" ParserProp_CSS_ParsePHP="0">1221071<_rslv>Block.getTypeBoolean()Block.getTypeBoolean()Block.getTypeBoolean()Block.getTypeBoolean()<_prl><_prl><_rslv>$block.getLineContent()Parameter$block.getLineContent()<_prl><_rslv>.trim().explode()<_prl><_rslv>.substr()Parameter$block.cleanContent()ReturnType<_prl><_rslv>.explode().substr().substr()<_doc>fdBC49D460<_doc>fdC51E7137<_doc>fdD2EC468E<_hsh>/**\n * Processes the given JS source file.\n * \n * @param mixed $file\n * @return Processor\n *//**\n * Scans the given JS source file and extracts blocks from it\n *//**\n * The total number of blocks scanned.\n */<_rslv>mixedBlockConstantMethodProperty<_prl><_prl><_rslv>.explode()$block.cleanContent()<_prl><_rslv>.explode()<_rslv>Block.getTypeBoolean()Block.getTypeBoolean()Block.getTypeBoolean()Block.getTypeBoolean().explode().substr().substr()$block.getLineContent()Parameter$block.getLineContent().trim().explode().explode().substr()Parameter$block.cleanContent()ReturnType.explode()$block.cleanContent()$file$i$iBlock<_prl><_rslv>Processor<_grp><_tocheck/> \ No newline at end of file diff --git a/docgen/src/Block.php b/docgen/src/Block.php deleted file mode 100644 index 19bdaa0c4..000000000 --- a/docgen/src/Block.php +++ /dev/null @@ -1,161 +0,0 @@ -start = $start; - $this->end = $end; - $this->code = $code; - $this->content = $content; - - // preg_match("/(@.*){(\S*)}(.*) -(.*)/", $input_line, $output_array); - // this one captures a property even with a * at the start - - $this->isProperty = $this->getTypeBoolean('@property'); - $this->isMethod = $this->getTypeBoolean('@method'); - $this->isConst = $this->getTypeBoolean('@constant'); - $this->isClass = $this->getTypeBoolean('@class'); - } - - public function getTypeBoolean($scan) - { - for ($i = 0; $i < count($this->content); $i++) - { - preg_match("/(@\w*)/", $this->content[$i], $output); - - if ($output && $output[0] === $scan) - { - return true; - } - } - - return false; - } - - public function getLineContent($scan) - { - $line = $this->getLine($scan); - - if ($line !== false) - { - $pattern = '/.*' . $scan . ' (.*)/'; - - preg_match($pattern, $line, $output); - - if ($output) - { - return trim($output[1]); - } - } - - return false; - - } - - public function getTag($tag) - { - $line = $this->getLine($tag); - - if ($line !== false) - { - preg_match("/(@\w*) (.*)/", $line, $output); - - if ($output) - { - return trim($output[2]); - } - } - - return false; - - } - - public function getLine($scan) - { - $i = $this->getContentIndex($scan); - - if ($i > -1) - { - return $this->content[$i]; - } - else - { - return false; - } - } - - public function getContentIndex($scan, $offset = 0) - { - for ($i = $offset; $i < count($this->content); $i++) - { - preg_match("/(@\w*)/", $this->content[$i], $output); - - if ($output && $output[0] === $scan) - { - return $i; - } - } - - return -1; - } - - public function getLines($scan) - { - $output = []; - - for ($i = 0; $i < count($this->content); $i++) - { - preg_match("/(@\w*)/", $this->content[$i], $line); - - if ($line && $line[0] === $scan) - { - $output[] = $this->content[$i]; - } - } - - return $output; - } - - public function cleanContent() - { - $output = []; - - for ($i = 0; $i < count($this->content); $i++) - { - $line = trim($this->content[$i]); - - // remove * from the start - if (substr($line, 0, 1) === '*') - { - $line = substr($line, 1); - $line = trim($line); - } - - // Have we got a @ next? - if (substr($line, 0, 1) !== '@') - { - $output[] = $line; - } - } - - // Trim off the final element if empty - if (count($output) > 0 && $output[count($output) - 1] === '') - { - array_pop($output); - } - - return $output; - } - - } -?> \ No newline at end of file diff --git a/docgen/src/ClassDesc.php b/docgen/src/ClassDesc.php deleted file mode 100644 index a210c6ef2..000000000 --- a/docgen/src/ClassDesc.php +++ /dev/null @@ -1,108 +0,0 @@ -processor = $processor; - - if ($block->getTypeBoolean('@class') === false) - { - $this->corrupted = true; - return; - } - - $this->name = $block->getLineContent('@class'); - - if (substr($this->name, 0, 6) !== 'Phaser') - { - $this->name = 'PIXI.' . $this->name; - } - - $this->processor->log("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv"); - $this->processor->log("Class: $this->name"); - $this->processor->log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"); - - $params = $block->getLines('@param'); - - for ($i = 0; $i < count($params); $i++) - { - $this->parameters[] = new Parameter($this->processor, $params[$i]); - } - - if ($block->getTypeBoolean('@extends')) - { - $this->extends = $block->getLineContent('@extends'); - - if (substr($this->extends, 0, 6) !== 'Phaser' && substr($this->extends, 0, 4) !== 'PIXI') - { - $this->extends = 'PIXI.' . $this->extends; - } - } - - if ($block->getTypeBoolean('@constructor')) - { - $this->hasConstructor = true; - } - else - { - // Like Phaser.Math - $this->isStatic = true; - } - - // This is a problem because the @classdesc block is often multi-line, but repeated in the clear content too. - // So all the classes probably need tidying up before this part will work correctly. - - $this->help = $block->cleanContent(); - - } - - public function extendsFrom() - { - if ($this->extends !== '') - { - return true; - } - else - { - return false; - } - } - - public function getArray() - { - $params = []; - - for ($i = 0; $i < count($this->parameters); $i++) - { - $params[] = $this->parameters[$i]->getArray(); - } - - return array( - 'name' => $this->name, - 'extends' => $this->extends, - 'static' => $this->isStatic, - 'constructor' => $this->hasConstructor, - 'parameters' => $params, - 'help' => implode('\n', $this->help) - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/src/Constant.php b/docgen/src/Constant.php deleted file mode 100644 index d197f342e..000000000 --- a/docgen/src/Constant.php +++ /dev/null @@ -1,61 +0,0 @@ -processor = $processor; - - // Because zero offset + allowing for final line - $this->line = $block->end + 2; - - // Phaser.Cache.TEXTURE = 3; - $name = $block->code; - $period = strrpos($name, '.'); - $equals = strrpos($name, '='); - - if ($period > 0 && $equals > 0) - { - $len = $equals - $period - 1; - $name = substr($name, $period + 1, $len); - } - else if ($period > 0) - { - $name = substr($name, $period + 1, -1); - } - - $this->name = trim($name); - - $line = $block->getLine('@type'); - - if ($line && preg_match("/.*@type\s?{(\S*)}/", $line, $output)) - { - $this->types = explode('|', $output[1]); - } - } - - public function getArray() - { - return array( - 'name' => $this->name, - 'type' => $this->types[0], - 'help' => implode('\n', $this->help), - 'line' => $this->line - ); - - return $a; - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/src/Exclude.php b/docgen/src/Exclude.php deleted file mode 100644 index 619bac0d1..000000000 --- a/docgen/src/Exclude.php +++ /dev/null @@ -1,23 +0,0 @@ - \ No newline at end of file diff --git a/docgen/src/Method.php b/docgen/src/Method.php deleted file mode 100644 index a7d48b807..000000000 --- a/docgen/src/Method.php +++ /dev/null @@ -1,142 +0,0 @@ -processor = $processor; - - // Because zero offset + allowing for final line - $this->line = $block->end + 2; - - $name = $block->getLine('@method'); - - $equals = strpos($name, '#'); - - if ($equals > 0) - { - $name = substr($name, $equals + 1); - } - else - { - $equals = strrpos($name, '.'); - - if ($equals > 0) - { - $name = substr($name, $equals + 1); - } - else - { - // No # and no . so we'll assume "@method name" format - $equals = strrpos($name, ' '); - - if ($equals > 0) - { - $name = substr($name, $equals + 1); - } - } - } - - // $this->processor->log("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv"); - // $this->processor->log("Method: $name"); - // $this->processor->log("^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"); - - $this->name = $name; - - $params = $block->getLines('@param'); - - for ($i = 0; $i < count($params); $i++) - { - $this->parameters[] = new Parameter($this->processor, $params[$i]); - } - - if ($block->getTypeBoolean('@protected')) - { - $this->isPublic = false; - $this->isProtected = true; - } - else if ($block->getTypeBoolean('@private')) - { - $this->isPublic = false; - $this->isPrivate = true; - } - - if ($block->getTypeBoolean('@static')) - { - $this->isStatic = true; - } - - $this->title = array("name" => $this->name, "visibility" => $this->getVisibility()); - - $this->help = $block->cleanContent(); - - if ($block->getTypeBoolean('@return')) - { - $this->returns = new ReturnType($this->processor, $block->getLine('@return')); - } - - } - - public function getVisibility() - { - if ($this->isPublic) - { - return 'public'; - } - else if ($this->isProtected) - { - return 'protected'; - } - else if ($this->isPrivate) - { - return 'private'; - } - } - - public function getArray() - { - $params = []; - - foreach ($this->parameters as $key => $value) - { - $params[] = $value->getArray(); - } - - return array( - 'name' => $this->title['name'], - 'static' => $this->isStatic, - 'returns' => $this->returns, - 'help' => implode('\n', $this->help), - 'line' => $this->line, - 'public' => $this->isPublic, - 'protected' => $this->isProtected, - 'private' => $this->isPrivate, - 'parameters' => $params, - 'inherited' => $this->inherited, - 'inheritedFrom' => $this->inheritedFrom - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/src/Parameter.php b/docgen/src/Parameter.php deleted file mode 100644 index de0f92785..000000000 --- a/docgen/src/Parameter.php +++ /dev/null @@ -1,101 +0,0 @@ -processor = $processor; - - preg_match("/.*(@param)\s?{(\S*)} (\S*)( - ?)?(.*)/", $line, $output); - - // $this->processor->log("Parameter count: " . count($output)); - - if (count($output) > 2) - { - // $this->processor->log("parsePhaser parameter"); - $this->parsePhaser($output); - } - else - { - preg_match("/(@param)\s(\S*)\s{(\S*)}\s?(.*)?/", $line, $output); - - // $this->processor->log("parsePixi parameter - " . count($output)); - - if (count($output) > 0) - { - $this->parsePixi($output); - } - } - - } - - public function parsePhaser($output) - { - $name = $output[3]; - - // $this->processor->log("parameter: $name"); - - if ($name[0] === '[') - { - $this->optional = true; - $name = substr($name, 1, -1); - - // Default? - $equals = strpos($name, '='); - - if ($equals > 0) - { - $this->default = (string) substr($name, $equals + 1); - $name = substr($name, 0, $equals); - } - } - - $this->name = $name; - - $this->types = $this->processor->parseTypes($output[2], false, $name); - - $this->help[] = $output[5]; - - } - - public function parsePixi($output) - { - $this->name = $output[2]; - - // $this->processor->log("parameter: $this->name"); - - $this->types = $this->processor->parseTypes($output[3], true, $this->name); - - if (isset($output[4])) - { - $this->help[] = $output[4]; - } - - } - - public function getArray() - { - return array( - 'name' => $this->name, - 'type' => $this->types, - 'help' => implode('\n', $this->help), - 'optional' => $this->optional, - 'default' => $this->default - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/src/PhaserDocGen.php b/docgen/src/PhaserDocGen.php deleted file mode 100644 index 1497be5bd..000000000 --- a/docgen/src/PhaserDocGen.php +++ /dev/null @@ -1,155 +0,0 @@ -src = realpath('../src'); - - $this->uniqueTypes = []; - - $this->classes = []; - } - - public function start() - { - $this->files = $this->dirToArray($this->src); - } - - public function extend($classKey = '') - { - if ($classKey !== '') - { - // echo "Extending $classKey\n"; - $this->classes[$classKey]->extend(); - } - else - { - // This will go through each class and add in inherited properties, etc - foreach ($this->classes as $key => $processor) - { - if ($processor !== 'corrupted') - { - // echo "Extended $key\n"; - $processor->extend(); - } - } - } - } - - public function export($path, $classKey = '') - { - if ($classKey !== '') - { - $this->classes[$classKey]->export($path); - } - else - { - // This will go through each class and add in inherited properties, etc - foreach ($this->classes as $key => $processor) - { - if ($processor !== 'corrupted') - { - $processor->export($path); - echo "Exported $key\n"; - // echo $processor . "\n"; - } - } - } - } - - public function get($classKey) - { - if (array_key_exists($classKey, $this->classes)) - { - return $this->classes[$classKey]; - } - - return null; - } - - private function dirToArray($dir) - { - set_time_limit(60); - - $result = []; - $root = scandir($dir); - $dirs = array_diff($root, $this->ignore); - - foreach ($dirs as $key => $value) - { - $path = realpath($dir . DIRECTORY_SEPARATOR . $value); - - if (is_dir($path)) - { - $result[$value] = $this->dirToArray($path); - } - else - { - if (substr($value, -3) === '.js') - { - if (!in_array($value, $this->fileIgnore)) - { - $index = str_replace($this->src, "", $path); - $index = substr($index, 1); - $tempProcessor = new Processor($this, "../src/$index"); - - if ($tempProcessor->corrupted === false) - { - if ($tempProcessor->class) - { - $classKey = $tempProcessor->class->name; - } - else - { - $classKey = 'wtf' . rand(); - } - - // $classKey = substr($value, 0, -3); - // $classKey = str_replace(DIRECTORY_SEPARATOR, ".", $index); - $result[$classKey] = $index; - // echo "Class key: $classKey \n"; - $this->classes[$classKey] = $tempProcessor; - } - else - { - $this->classes[$index] = 'corrupted'; - // echo "CORRUPTED \n"; - } - - // Dump to log - // echo $index . "\n"; - } - else - { - // echo "Ignored: $value \n"; - } - } - else - { - // echo "NOT A JS FILE\n"; - } - } - } - - return $result; - - } - - } - -?> \ No newline at end of file diff --git a/docgen/src/Processor.php b/docgen/src/Processor.php deleted file mode 100644 index d7ffe568d..000000000 --- a/docgen/src/Processor.php +++ /dev/null @@ -1,624 +0,0 @@ -docgen = $docgen; - - $this->class = null; - $this->consts = []; - $this->methods = []; - $this->properties = []; - $this->file = $file; - - $this->corrupted = false; - - $this->methods['private'] = []; - $this->methods['protected'] = []; - $this->methods['public'] = []; - $this->methods['static'] = []; - - $this->properties['private'] = []; - $this->properties['protected'] = []; - $this->properties['public'] = []; - - $this->domTypes = [ - 'ArrayBuffer', - 'AudioContext', - 'CanvasRenderingContext2D', - 'DOMElement', - 'Event', - 'Float32Array', - 'HTMLCanvasElement', - 'HTMLElement', - 'Image', - 'ImageData', - 'KeyboardEvent', - 'MouseEvent', - 'Pointer', - 'PointerEvent', - 'TouchEvent', - 'Uint16Array', - 'Uint32Array', - 'Uint8ClampedArray', - 'XDomainRequest', - 'XMLHttpRequest' - ]; - - $this->dataTypes = [ - 'any', - 'array', - 'boolean', - 'function', - 'null', - 'number', - 'object', - 'string', - 'undefined' - ]; - - $this->scanFile(); - } - - /** - * Scans the given JS source file and extracts blocks from it - */ - private function scanFile() { - - $js = file($this->file); - - $scanningForOpen = true; - $scanningForClose = false; - - $openLine = 0; - $closeLine = 0; - $chunk = []; - - // Literally scan the JS file, line by line - for ($i = 0; $i < count($js); $i++) - { - $line = trim($js[$i]); - - if ($scanningForOpen && $line === "/**") - { - $scanningForOpen = false; - $scanningForClose = true; - $chunk = []; - $openLine = $i; - } - - if ($scanningForClose && $line === "*/") - { - $scanningForOpen = true; - $scanningForClose = false; - $closeLine = $i; - - // The first element is always the opening /** so remove it - array_shift($chunk); - - if (isset($js[$i + 1])) - { - $this->blocks[] = new Block($openLine, $closeLine, $js[$i + 1], $chunk); - } - } - else - { - $chunk[] = $line; - } - } - - // Process the data into our documentation types - for ($i = 0; $i < $this->total(); $i++) - { - if ($this->blocks[$i]->isClass) - { - // Some files like PIXI.Graphics have multiple class blocks within them - if ($this->class === null) - { - $tempClass = new ClassDesc($this, $this->blocks[$i]); - $this->class = $tempClass; - - if ($tempClass->corrupted) - { - $this->corrupted = true; - } - } - } - else if ($this->blocks[$i]->isConst) - { - $tempConst = new Constant($this, $this->blocks[$i]); - - $this->consts[$tempConst->name] = $tempConst; - } - else if ($this->blocks[$i]->isMethod) - { - $tempMethod = new Method($this, $this->blocks[$i]); - - if ($tempMethod->isPublic) - { - $this->methods['public'][$tempMethod->name] = $tempMethod; - } - else if ($tempMethod->isProtected) - { - $this->methods['protected'][$tempMethod->name] = $tempMethod; - } - else if ($tempMethod->isPrivate) - { - $this->methods['private'][$tempMethod->name] = $tempMethod; - } - else if ($tempMethod->isStatic) - { - $this->methods['static'][$tempMethod->name] = $tempMethod; - } - } - else if ($this->blocks[$i]->isProperty) - { - $tempProperty = new Property($this, $this->blocks[$i]); - - if ($tempProperty->corrupted === false) - { - if ($tempProperty->isPublic) - { - $this->properties['public'][$tempProperty->name] = $tempProperty; - } - else if ($tempProperty->isProtected) - { - $this->properties['protected'][$tempProperty->name] = $tempProperty; - } - else if ($tempProperty->isPrivate) - { - $this->properties['private'][$tempProperty->name] = $tempProperty; - } - } - } - } - - if ($this->class === null) - { - $this->corrupted = true; - } - - $this->sortArrays(); - - } - - public function parseTypes($output, $pixi, $name) - { - // Remove optional braces - if (substr($output, 0, 1) === "(") - { - $output = substr($output, 1, -1); - } - - $types = explode('|', $output); - - if (!is_array($types)) - { - $types = array($output); - } - - // @param {number[]|string[]} frames - An array of numbers or strings indicating which frames to play in which order. - // @param {(number[]|...number)} points - An array of 2d vectors that form the convex or concave polygon. - // Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...], - // or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers. - - foreach ($types as $key => $type) - { - trim($type); - - if (substr($type, -2) === "[]") - { - $tidy = substr($type, 0, -2); - $types[$key] = "array " . substr($type, 0, -2); - } - else if (strpos($type, '<') > 0) - { - // array - - $left = strpos($type, '<') + 1; - // $right = strpos($type, '>') - 1; - $tidy = substr($type, $left, -1); - - if ($tidy === 'Number' || $tidy === 'String') - { - $tidy = strtolower($tidy); - } - else if ($tidy === 'Point') - { - $tidy = 'Phaser.Point'; - } - else if ($tidy === 'Texture' || $tidy === 'DisplayObject') - { - $tidy = 'PIXI.' . $tidy; - } - - $types[$key] = 'array ' . $tidy; - } - else if (substr($type, 0, 5) === "Array") - { - $types[$key] = "array"; - } - else if ($type === "Number" || $type === "{Number}" || substr($type, 0, 7) === "Number " || $type === "Number..." || $type === "...number") - { - $types[$key] = "number"; - } - else if ($type === "String") - { - $types[$key] = "string"; - } - else if ($type === "Boolean") - { - $types[$key] = "boolean"; - } - else if ($type === "Function") - { - $types[$key] = "function"; - } - else if ($type === "Object") - { - $types[$key] = "object"; - } - else if ($type === "Null") - { - $types[$key] = "null"; - } - else if ($type === "Circle") - { - $types[$key] = "Phaser.Circle"; - } - else if ($type === "Point" || $type === "Point...") - { - $types[$key] = "Phaser.Point"; - } - else if ($type === "Line") - { - $types[$key] = "Phaser.Line"; - } - else if ($type === "Texture") - { - $types[$key] = "PIXI.Texture"; - } - else if ($type === "Polygon") - { - $types[$key] = "Phaser.Polygon"; - } - else if ($type === "Ellipse") - { - $types[$key] = "Phaser.Ellipse"; - } - else if ($type === "Rectangle") - { - $types[$key] = "Phaser.Rectangle"; - } - else if ($type === "Matrix") - { - $types[$key] = "PIXI.Matrix"; - } - else if ($type === "DisplayObject") - { - $types[$key] = "PIXI.DisplayObject"; - } - else if ($type === "Any" || $type === "{Any}" || $type === "*" || $type === "...*") - { - $types[$key] = "any"; - } - else - { - // Valid DOM types? - if (!in_array($type, $this->domTypes) && !in_array($type, $this->dataTypes)) - { - if ($pixi === null) - { - // It's a ReturnType but we don't know which sort - if (substr($type, 0, 7) !== 'Phaser.' && substr($type, 0, 5) !== 'PIXI.' && substr($type, 0, 3) !== 'p2.') - { - // Going to assume PIXI here as Phaser has the return types properly namespaced - $types[$key] = "PIXI.$type"; - } - } - else - { - // Not a DOM type, shall we add PIXI to the front? - if ($pixi) - { - if (substr($type, 0, 5) !== 'PIXI.') - { - $types[$key] = "PIXI.$type"; - } - } - else - { - if (substr($type, 0, 7) !== 'Phaser.' && substr($type, 0, 5) !== 'PIXI.' && substr($type, 0, 3) !== 'p2.') - { - $types[$key] = "wtf.$type"; - echo($name . '='); - var_dump($type); - } - } - } - } - } - - if (isset($this->docgen->uniqueTypes[$types[$key]])) - { - $this->docgen->uniqueTypes[$types[$key]] += 1; - } - else - { - $this->docgen->uniqueTypes[$types[$key]] = 1; - // echo($name . '=' . $type . "\n"); - // var_dump($name); - } - } - - return $types; - - } - - public function getPublicProperties() - { - return $this->properties['public']; - } - - public function getPublicMethods() - { - return $this->methods['public']; - } - - public function getArray() - { - $consts = []; - $methods = []; - $properties = []; - - foreach ($this->consts as $key => $value) - { - $consts[] = $value->getArray(); - } - - // Methods - - $methods['public'] = []; - $methods['protected'] = []; - $methods['private'] = []; - $methods['static'] = []; - - foreach ($this->methods['public'] as $key => $value) - { - $methods['public'][] = $value->getArray(); - } - - foreach ($this->methods['protected'] as $key => $value) - { - $methods['protected'][] = $value->getArray(); - } - - foreach ($this->methods['private'] as $key => $value) - { - $methods['private'][] = $value->getArray(); - } - - foreach ($this->methods['static'] as $key => $value) - { - $methods['static'][] = $value->getArray(); - } - - // Properties - - $properties['public'] = []; - $properties['protected'] = []; - $properties['private'] = []; - - foreach ($this->properties['public'] as $key => $value) - { - $properties['public'][] = $value->getArray(); - } - - foreach ($this->properties['protected'] as $key => $value) - { - $properties['protected'][] = $value->getArray(); - } - - foreach ($this->properties['private'] as $key => $value) - { - $properties['private'][] = $value->getArray(); - } - - return array( - 'class' => $this->class->getArray(), - 'consts' => $consts, - 'methods' => $methods, - 'properties' => $properties - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - public function export($path) - { - file_put_contents($path . $this->class->name . '.json', $this->getJSON()); - } - - public function getConstsArray() - { - $out = []; - - for ($i = 0; $i < count($this->consts); $i++) - { - $out[] = $this->consts[$i]->getArray(); - } - - return $out; - } - - public function extend() - { - // Quick bailout - if (!$this->class->extendsFrom()) - { - return; - } - - $proc = $this; - - do - { - $extends = $proc->class->extends; - $proc = $this->docgen->get($extends); - - if ($proc !== null) - { - // echo "\n\nextend found: " . $proc->getName() . "\n"; - $this->merge($proc); - } - else - { - // echo "\n\n --------> fatal extend: " . $extends . "\n"; - } - } - while ($proc->class->extendsFrom()); - - $this->sortArrays(); - - } - - public function sortArrays() - { - // Alphabetically sort the arrays based on the key - ksort($this->consts); - - ksort($this->methods['public']); - ksort($this->methods['protected']); - ksort($this->methods['private']); - ksort($this->methods['static']); - - ksort($this->properties['public']); - ksort($this->properties['protected']); - ksort($this->properties['private']); - } - - public function getMethodNames() - { - $output = []; - - foreach ($this->methods['public'] as $key => $method) - { - $output[$method->name] = true; - } - - return $output; - } - - public function getPropertyNames() - { - $output = []; - - foreach ($this->properties['public'] as $key => $property) - { - $output[$property->name] = true; - } - - return $output; - } - - public function merge($processor) - { - // We only want to merge in public methods and properties. - // Technically JavaScript merges in bloody everything, but for the sake of docs we'll keep them #public# only. - - $inheritedMethods = $processor->getPublicMethods(); - $currentMethods = $this->getMethodNames(); - - // Flag them as inherited - foreach ($inheritedMethods as $key => $method) - { - if (!array_key_exists($method->name, $currentMethods)) - { - $method->inherited = true; - $method->inheritedFrom = $processor->getName(); - $this->methods['public'][$method->name] = $method; - } - } - - $inheritedProperties = $processor->getPublicProperties(); - $currentProperties = $this->getPropertyNames(); - - // Flag them as inherited! - foreach ($inheritedProperties as $key => $property) - { - if (!array_key_exists($property->name, $currentProperties)) - { - $property->inherited = true; - $property->inheritedFrom = $processor->getName(); - $this->properties['public'][$property->name] = $property; - } - } - } - - /** - * The total number of blocks scanned. - */ - public function total() - { - return count($this->blocks); - } - - public function log($text) { - - $this->processLog[] = $text; - - } - - public function getLog() { - - return $this->processLog; - // return array_reverse($this->processLog); - - } - - public function getName() { - - return $this->class->name; - - } - - public function __toString() - { - if ($this->corrupted) - { - return "JSDoc Corrupted Class"; - } - else - { - return "Class: " . $this->class->name . ", Methods: " . count($this->methods['public']) . ", Properties: " . count($this->properties['public']); - } - } - - } -?> \ No newline at end of file diff --git a/docgen/src/Property.php b/docgen/src/Property.php deleted file mode 100644 index 6603baf2c..000000000 --- a/docgen/src/Property.php +++ /dev/null @@ -1,139 +0,0 @@ -processor = $processor; - - // Because zero offset + allowing for final line - $this->line = $block->end + 2; - - preg_match("/(@.*){(\S*)} (\S*)( - ?)?(.*)/", $block->getLine('@property'), $output); - - if (count($output) > 3) - { - $result = $this->parsePhaser($output, $block); - } - else - { - preg_match("/(@.*) (.*)/", $block->getLine('@property'), $output); - $result = $this->parsePixi($output, $block); - } - - if ($result === false) - { - // Bail out, tell the Process we've a duff Property here - $this->corrupted = true; - return false; - } - - if ($block->getTypeBoolean('@protected')) - { - $this->isPublic = false; - $this->isProtected = true; - } - else if ($block->getTypeBoolean('@private')) - { - $this->isPublic = false; - $this->isPrivate = true; - } - - if ($block->getTypeBoolean('@readonly') || $block->getTypeBoolean('@readOnly')) - { - $this->isReadOnly = true; - } - - $this->help = $block->cleanContent(); - - return true; - - } - - public function parsePhaser($output, $block) - { - $this->name = $output[3]; - $this->inlineHelp = $output[5]; - - $this->types = $this->processor->parseTypes($output[2], false, $this->name); - - // Default? - if ($block->getTypeBoolean('@default')) - { - preg_match("/= (.*);/", $block->code, $defaultType); - - if ($defaultType && isset($defaultType[1])) - { - $this->default = $defaultType[1]; - } - } - - return true; - - } - - public function parsePixi($output, $block) - { - if (isset($output[2])) - { - $this->name = $output[2]; - } - else - { - return false; - } - - if ($block->getTypeBoolean('@type')) - { - $this->types = $this->processor->parseTypes($block->getTag('@type'), true, $this->name); - } - - if ($block->getTypeBoolean('@default')) - { - $this->default = $block->getTag('@default'); - } - - return true; - - } - - public function getArray() - { - return array( - 'name' => $this->name, - 'type' => $this->types, - 'help' => implode('\n', $this->help), - 'inlineHelp' => $this->inlineHelp, - 'line' => $this->line, - 'default' => $this->default, - 'public' => $this->isPublic, - 'protected' => $this->isProtected, - 'private' => $this->isPrivate, - 'readOnly' => $this->isReadOnly - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/src/ReturnType.php b/docgen/src/ReturnType.php deleted file mode 100644 index 586a0a7a8..000000000 --- a/docgen/src/ReturnType.php +++ /dev/null @@ -1,36 +0,0 @@ -processor = $processor; - - if (preg_match("/.*@return\s?{(\S*)} ?(.*)/", $line, $output)) - { - // Don't know if this is a Pixi or a Phaser return type - // $this->types = $this->processor->parseTypes($output[1], null, ''); - $this->types = $processor->parseTypes($output[1], null, ''); - - $this->help = $output[2]; - } - } - - public function getArray() - { - return array( - 'type' => $this->types - ); - - } - - public function getJSON() - { - return json_encode($this->getArray()); - } - - } -?> \ No newline at end of file diff --git a/docgen/view.php b/docgen/view.php deleted file mode 100644 index 762feb858..000000000 --- a/docgen/view.php +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - Phaser Documentation Viewer: <?php echo $src ?> - - - - - Index - -

- -"; - print_r($data->getLog()); - echo ""; - - echo "
";
-    print_r($data->class->getArray());
-    echo "
"; - - if ($method) - { - echo "
";
-        print_r($data->methods[$method]->getArray());
-        echo "
"; - } - - if ($property) - { - echo "
";
-        print_r($data->properties[$property]->getArray());
-        echo "
"; - } -?> - -

Constants

- -
    -consts as $constName => $const) - { - echo "
  • {$const->name}
    • "; - } -?> -
- -

Methods

- -

Public

- - -

Protected

- - -

Private

- - -

Static

- - -

Properties

- -

Public

- - -

Protected

- - -

Private

- - - - - \ No newline at end of file diff --git a/docgen/wip/gen.php b/docgen/wip/gen.php deleted file mode 100644 index 3b796c32c..000000000 --- a/docgen/wip/gen.php +++ /dev/null @@ -1,598 +0,0 @@ - - - - - phaser doc gen - - - - - 
-start = $start;
-            $this->end = $end;
-            $this->code = $code;
-            $this->content = $content;
-
-            // preg_match("/(@.*){(\S*)}(.*) -(.*)/", $input_line, $output_array);
-            // this one captures a property even with a * at the start
-
-            $this->isProperty = $this->getTypeBoolean('@property');
-            $this->isMethod = $this->getTypeBoolean('@method');
-            $this->isConst = $this->getTypeBoolean('@constant');
-            $this->isClass = $this->getTypeBoolean('@class');
-        }
-
-        public function getTypeBoolean($scan)
-        {
-            for ($i = 0; $i < count($this->content); $i++)
-            {
-                preg_match("/(@\w*)/", $this->content[$i], $output);
-
-                if ($output && $output[0] === $scan)
-                {
-                    return true;
-                }
-            }
-
-            return false;
-        }
-
-        public function getLineContent($scan)
-        {
-            $line = $this->getLine($scan);
-
-            if ($line !== false)
-            {
-                $pattern = '/.*' . $scan . ' (.*)/';
-
-                preg_match($pattern, $line, $output);
-
-                if ($output)
-                {
-                    return trim($output[1]);
-                }
-            }
-
-            return false;
-
-        }
-
-        public function getLine($scan)
-        {
-            $i = $this->getContentIndex($scan);
-
-            if ($i > -1)
-            {
-                return $this->content[$i];
-            }
-            else
-            {
-                return false;
-            }
-        }
-
-        public function getContentIndex($scan, $offset = 0)
-        {
-            for ($i = $offset; $i < count($this->content); $i++)
-            {
-                preg_match("/(@\w*)/", $this->content[$i], $output);
-
-                if ($output && $output[0] === $scan)
-                {
-                    return $i;
-                }
-            }
-
-            return -1;
-        }
-
-        public function getLines($scan)
-        {
-            $output = [];
-
-            for ($i = 0; $i < count($this->content); $i++)
-            {
-                preg_match("/(@\w*)/", $this->content[$i], $line);
-
-                if ($line && $line[0] === $scan)
-                {
-                    $output[] = $this->content[$i];
-                }
-            }
-
-            return $output;
-        }
-
-        public function cleanContent()
-        {
-            $output = [];
-
-            for ($i = 0; $i < count($this->content); $i++)
-            {
-                $line = trim($this->content[$i]);
-
-                //  remove * from the start
-                if (substr($line, 0, 1) === '*')
-                {
-                    $line = substr($line, 1);
-                    $line = trim($line);
-                }
-
-                //  Have we got a @ next?
-                if (substr($line, 0, 1) !== '@')
-                {
-                    $output[] = $line;
-                }
-            }
-
-            //  Trim off the final element if empty
-            if (count($output) > 0 && $output[count($output) - 1] === '')
-            {
-                array_pop($output);
-            }
-
-            return $output;
-        }
-
-
-    }
-
-    class Parameter
-    {
-        public $name; // rect, copy, etc
-        public $types = []; // an array containing all possible types it can be: string, number, etc
-        public $help = [];
-        public $optional = false;
-        public $default = false; // assigned value is the default value
-
-        public function __construct($line)
-        {
-            preg_match("/.*(@param)\s?{(\S*)} (\S*)( - ?)?(.*)/", $line, $output);
-
-            $this->types = explode('|', $output[2]);
-            $this->help = $output[5];
-
-            $name = $output[3];
-
-            if ($name[0] === '[')
-            {
-                $this->optional = true;
-                $name = substr($name, 1, -1);
-
-                //  Default?
-                $equals = strpos($name, '=');
-
-                if ($equals > 0)
-                {
-                    $name = substr($name, 0, $equals - 1);
-                    $this->default = substr($name, $equals + 1);
-                }
-            }
-
-            $this->name = $name;
-        }
-
-    }
-
-    //  Because we can't have a class called "Class", grrr...
-    class PhaserClass
-    {
-        public $name; // Phaser.Sprite
-        public $parameters = []; // an array containing the parameters
-        public $help = [];
-        public $extends = '';
-
-        public $hasConstructor = false;
-        public $isStatic = false;
-
-        public function __construct($block)
-        {
-            $this->name = $block->getLineContent('@class');
-
-            $params = $block->getLines('@param');
-
-            for ($i = 0; $i < count($params); $i++)
-            {
-                $this->parameters[] = new Parameter($params[$i]);
-            }
-
-            if ($block->getTypeBoolean('@extends'))
-            {
-                $this->extends = $block->getLineContent('@extends');
-            }
-
-            if ($block->getTypeBoolean('@constructor'))
-            {
-                $this->hasConstructor = true;
-            }
-            else
-            {
-                //  Like Phaser.Math
-                $this->isStatic = true;
-            }
-
-            //  This is a problem because the @classdesc block is often multi-line, but repeated in the clear content too.
-            //  So all the classes probably need tidying up before this part will work correctly.
-
-            // $this->help = $block->cleanContent();
-
-        }
-
-    }
-
-    class Constant
-    {
-        public $name; // TEXTURE_ATLAS_JSON_ARRAY, PHYSICS_PHASER_JSON, etc
-        public $types = []; // an array containing the one single type the const can be
-        public $help = [];
-        public $line; // number, line number in the source file this is found on?
-
-        public function __construct($block)
-        {
-            //  Because zero offset + allowing for final line
-            $this->line = $block->end + 2;
-
-            //  Phaser.Cache.TEXTURE = 3;
-            $name = $block->code;
-            $period = strrpos($name, '.');
-            $equals = strrpos($name, '=');
-
-            if ($period > 0 && $equals > 0)
-            {
-                $len = $equals - $period - 1;
-                $name = substr($name, $period + 1, $len);
-            }
-            else if ($period > 0)
-            {
-                $name = substr($name, $period + 1, -1);
-            }
-
-            $this->name = trim($name);
-
-            $line = $block->getLine('@type');
-
-            if ($line && preg_match("/.*@type\s?{(\S*)}/", $line, $output))
-            {
-                $this->types = explode('|', $output[1]);
-            }
-        }
-
-    }
-
-    class ReturnType
-    {
-        public $types = []; // an array containing all possible types it can be: string, number, etc
-        public $help = [];
-
-        public function __construct($line)
-        {
-            if (preg_match("/.*@return\s?{(\S*)} ?(.*)/", $line, $output))
-            {
-                $this->types = explode('|', $output[1]);
-                $this->help = $output[2];
-            }
-        }
-
-    }
-
-    class Method
-    {
-        public $line; // number, line number in the source file this is found on?
-        public $name; // bringToTop, kill, etc
-        public $parameters = []; // an array containing the parameters
-        public $help = [];
-        public $returns = false;
-
-        public $isPublic = true;
-        public $isProtected = false;
-        public $isPrivate = false;
-
-        public function __construct($block)
-        {
-            //  Because zero offset + allowing for final line
-            $this->line = $block->end + 2;
-
-            $name = $block->getLine('@method');
-
-            $equals = strpos($name, '#');
-
-            if ($equals > 0)
-            {
-                $name = substr($name, $equals + 1);
-            }
-
-            $this->name = $name;
-
-            $params = $block->getLines('@param');
-
-            for ($i = 0; $i < count($params); $i++)
-            {
-                $this->parameters[] = new Parameter($params[$i]);
-            }
-
-            if ($block->getTypeBoolean('@protected'))
-            {
-                $this->isPublic = false;
-                $this->isProtected = true;
-            }
-            else if ($block->getTypeBoolean('@private'))
-            {
-                $this->isPublic = false;
-                $this->isPrivate = true;
-            }
-
-            $this->help = $block->cleanContent();
-
-            if ($block->getTypeBoolean('@return'))
-            {
-                $this->returns = new ReturnType($block->getLine('@return'));
-            }
-
-        }
-
-    }
-
-    class Property
-    {
-        public $line; // number, line number in the source file this is found on?
-        public $name; // visible, name, parent
-        public $types = []; // an array containing all possible types it can be: string, number, etc
-        public $default = false; // assigned value is the default value
-        public $help = [];
-        public $inlineHelp = '';
-
-        public $isPublic = true;
-        public $isProtected = false;
-        public $isPrivate = false;
-
-        public $isReadOnly = false;
-
-        public function __construct($block)
-        {
-            //  Because zero offset + allowing for final line
-            $this->line = $block->end + 2;
-
-            preg_match("/(@.*){(\S*)} (\S*)( - ?)?(.*)/", $block->getLine('@property'), $output);
-
-            $this->types = explode('|', $output[2]);
-            $this->name = $output[3];
-            $this->inlineHelp = $output[5];
-
-            if ($block->getTypeBoolean('@protected'))
-            {
-                $this->isPublic = false;
-                $this->isProtected = true;
-            }
-            else if ($block->getTypeBoolean('@private'))
-            {
-                $this->isPublic = false;
-                $this->isPrivate = true;
-            }
-
-            //  Default?
-            if ($block->getTypeBoolean('@default'))
-            {
-                preg_match("/= (.*);/", $block->code, $defaultType);
-                if ($defaultType && isset($defaultType[1]))
-                {
-                    $this->default = $defaultType[1];
-                }
-            }
-
-            $this->help = $block->cleanContent();
-
-            if ($block->getTypeBoolean('@readonly'))
-            {
-                $this->isReadOnly = true;
-            }
-
-        }
-
-    }
-
-    class ScanFile
-    {
-        public $filename = '';
-        public $js = '';
-
-        public $blocks;
-
-        public $consts = [];
-        public $properties = [];
-        public $methods = [];
-
-        public function __construct($file)
-        {
-            $this->filename = $file;
-            $js = file($file);
-
-            $scanningForOpen = true;
-            $scanningForClose = false;
-
-            $openLine = 0;
-            $closeLine = 0;
-            $chunk = [];
-
-            for ($i = 0; $i < count($js); $i++)
-            {
-                $line = trim($js[$i]);
-
-                if ($scanningForOpen && $line === "/**")
-                {
-                    $scanningForOpen = false;
-                    $scanningForClose = true;
-                    $chunk = [];
-                    $openLine = $i;
-                }
-
-                if ($scanningForClose && $line === "*/")
-                {
-                    $scanningForOpen = true;
-                    $scanningForClose = false;
-                    $closeLine = $i;
-
-                    //  The first element is always the opening /** so remove it
-                    array_shift($chunk);
-
-                    $this->blocks[] = new Block($openLine, $closeLine, $js[$i + 1], $chunk);
-                }
-                else
-                {
-                    $chunk[] = $line;
-                }
-            }
-        }
-
-        public function total()
-        {
-            return count($this->blocks);
-        }
-
-    }
-
-
-    // $blocks = [];
-
-    // $consts = [];
-    // $properties = [];
-    // $methods = [];
-
-    // $file = "../src/gameobjects/Sprite.js";
-    $file = "../src/loader/Cache.js";
-
-/*
-    $js = file($file);
-
-    $scanningForOpen = true;
-    $scanningForClose = false;
-
-    $openLine = 0;
-    $closeLine = 0;
-    $chunk = [];
-
-    for ($i = 0; $i < count($js); $i++)
-    {
-        $line = trim($js[$i]);
-
-        if ($scanningForOpen && $line === "/**")
-        {
-            $scanningForOpen = false;
-            $scanningForClose = true;
-            $chunk = [];
-            $openLine = $i;
-        }
-
-        if ($scanningForClose && $line === "*/")
-        {
-            $scanningForOpen = true;
-            $scanningForClose = false;
-            $closeLine = $i;
-
-            //  The first element is always the opening /** so remove it
-            array_shift($chunk);
-
-            $blocks[] = new Block($openLine, $closeLine, $js[$i + 1], $chunk);
-        }
-        else
-        {
-            $chunk[] = $line;
-        }
-    }
-*/
-
-    //  That's the whole file scanned, how many blocks did we get out of it?
-
-    echo count($blocks) . " blocks found\n\n";
-
-    echo "\nConstants:\n\n";
-
-    for ($i = 0; $i < count($blocks); $i++)
-    {
-        if ($blocks[$i]->isConst)
-        {
-            $const = new Constant($blocks[$i]);
-
-            echo "\n\n";
-            echo $const->name;
-            echo "\n";
-            print_r($const->types);
-            // print_r($method->help);
-        }
-    }
-
-    echo "\nMethods:\n\n";
-
-    for ($i = 0; $i < count($blocks); $i++)
-    {
-        if ($blocks[$i]->isMethod)
-        {
-            $method = new Method($blocks[$i]);
-
-            echo "\n\n";
-            echo $method->name;
-            echo "\n";
-            print_r($method->help);
-            print_r($method->parameters);
-            print_r($method->returns);
-        }
-    }
-
-
-    echo "\nProperties:\n\n";
-
-    for ($i = 0; $i < count($blocks); $i++)
-    {
-        if ($blocks[$i]->isProperty)
-        {
-            //  First things first - we know it's a property
-
-            echo "\n\n";
-
-            $property = new Property($blocks[$i]);
-
-            echo $property->name . "\n";
-
-            // print_r($property->types);
-
-            echo "Source code line " . $property->line . "\n";
-            echo "Default: " . $property->default . "\n";
-            echo "Help: " . "\n";
-            print_r($property->help);
-
-            echo "\n\n";
-
-            // echo $blocks[$i]->start . "\n";
-        }
-    }
-?>
-
- - - \ No newline at end of file diff --git a/docgen/wip/json.php b/docgen/wip/json.php deleted file mode 100644 index 994531863..000000000 --- a/docgen/wip/json.php +++ /dev/null @@ -1,25 +0,0 @@ -getConstsArray(); - - echo json_encode($raw); - -// echo $data->consts[0]->getJSON(); - - -?> \ No newline at end of file diff --git a/docgen/wip/output.php b/docgen/wip/output.php deleted file mode 100644 index 1a3816f82..000000000 --- a/docgen/wip/output.php +++ /dev/null @@ -1,53 +0,0 @@ -total() . " blocks found\n\n"; - // echo "\nConstants:\n\n"; - - for ($i = 0; $i < count($data->consts); $i++) - { - // echo $data->consts[$i]->getJSON() . ","; - } - -/* - echo "\nMethods:\n\n"; - - for ($i = 0; $i < count($data->methods); $i++) - { - $method = $data->methods[$i]; - echo "\n\n"; - echo $method->name; - echo "\n"; - print_r($method->help); - print_r($method->parameters); - print_r($method->returns); - } - - echo "\nProperties:\n\n"; - - for ($i = 0; $i < count($data->properties); $i++) - { - $property = $data->properties[$i]; - echo "\n\n"; - echo $property->name . "\n"; - // print_r($property->types); - echo "Source code line " . $property->line . "\n"; - echo "Default: " . $property->default . "\n"; - echo "Help: " . "\n"; - print_r($property->help); - echo "\n\n"; - } -*/ -?> \ No newline at end of file diff --git a/docgen/wip/process.php b/docgen/wip/process.php deleted file mode 100644 index 5724b651c..000000000 --- a/docgen/wip/process.php +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Phaser Documentation Generator v0.1 - - - - - 
-total() . " blocks found\n\n";
-
-/*
-    echo "\nConstants:\n\n";
-
-    for ($i = 0; $i < count($data->consts); $i++)
-    {
-        // print_r($data->consts[$i]->getJSON());
-       $const = $data->consts[$i];
-       echo "\n\n";
-       echo $const->name;
-       echo "\n";
-       print_r($const->types);
-    }
-*/
-
-    echo "\nMethods:\n\n";
-
-    for ($i = 0; $i < count($data->methods); $i++)
-    {
-        $method = $data->methods[$i];
-
-        if ($method->name === 'addMissingImage')
-        {
-            echo "\n\n";
-            print_r($method->title);
-            print_r($method->help);
-            print_r($method->parameters);
-            print_r($method->returns);
-        }
-
-    }
-
-/*
-    echo "\nProperties:\n\n";
-
-    for ($i = 0; $i < count($data->properties); $i++)
-    {
-        $property = $data->properties[$i];
-        echo "\n\n";
-        echo $property->name . "\n";
-        // print_r($property->types);
-        echo "Source code line " . $property->line . "\n";
-        echo "Default: " . $property->default . "\n";
-        echo "Help: " . "\n";
-        print_r($property->help);
-        echo "\n\n";
-    }
-*/
-?>
-
- - - \ No newline at end of file