phaser/v2/resources/docgen/output/Phaser.Circle.json

1 line
12 KiB
JSON
Raw Normal View History

{"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 d