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

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