phaser/resources/docgen/output/PIXI.Polygon.json

{"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":[]}}