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

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