phaser/resources/docgen/output/Phaser.Math.json

1 line
36 KiB
JSON
Raw Normal View History

{"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":""},"h