phaser/resources/docgen/output/Phaser.Physics.Ninja.Circle.json

{"class":{"name":"Phaser.Physics.Ninja.Circle","extends":"","static":false,"constructor":true,"parameters":[{"name":"body","type":["Phaser.Physics.Ninja.Body"],"help":"The body that owns this shape.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate to create this shape at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to create this shape at.","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of this Circle.","optional":false,"default":null}],"help":"Ninja Physics Circle constructor.\\nNote: This class could be massively optimised and reduced in size. I leave that challenge up to you."},"consts":[],"methods":{"public":[{"name":"collideCircleVsTile","static":false,"returns":{"types":["boolean"],"help":"True if they collide, otherwise false."},"help":"Collides this Circle with a Tile.","line":255,"public":true,"protected":false,"private":false,"parameters":[{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideWorldBounds","static":false,"returns":null,"help":"Collides this Circle against the world bounds.","line":212,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this Circle's reference to Body and System","line":2617,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integrate","static":false,"returns":null,"help":"Updates this Circles position.","line":117,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"projCircle_22DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":1731,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_22DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":1439,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_45Deg","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 45 Degree tile collision.","line":459,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_67DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":2319,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_67DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":2034,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Concave","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Concave tile collision.","line":729,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Convex","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Convex tile collision.","line":963,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Full","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Full tile collision.","line":347,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"projCircle_Half","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Half tile collision.","line":1205,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render this circle for debugging purposes.","line":2632,"public":true,"protected":false,"private":false,"parameters":[{"name":"context","type":["object"],"help":"The context to render to.","optional":false,"default":null},{"name":"xOffset","type":["number"],"help":"X offset from circle's position to render at.","optional":false,"default":null},{"name":"yOffset","type":["number"],"help":"Y offset from circle's position to render at.","optional":false,"default":null},{"name":"color","type":["string"],"help":"color of the debug shape to be rendered. (format is css color string).","optional":false,"default":null},{"name":"filled","type":["boolean"],"help":"Render the shape as solid (true) or hollow (false).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsWorld","static":false,"returns":null,"help":"Process a world collision and apply the resulting forces.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"px","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"py","type":["number"],"help":"The tangent velocity","optional":false,"default":null},{"name":"dx","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"dy","type":["number"],"help":"Collision normal","optional":false,"default":null},{"name":"obj","type":["number"],"help":"Object this Circle collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resolveCircleTile","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves tile collision.","line":322,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Penetration depth on the x axis.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Penetration depth on the y axis.","optional":false,"default":null},{"name":"oH","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"oV","type":["number"],"help":"Grid \/ voronoi region.","optional":false,"default":null},{"name":"obj","type":["Phaser.Physics.Ninja.Circle"],"help":"The Circle involved in the collision.","optional":false,"default":null},{"name":"t","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile involved in the collision.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"circleTileProjections","type":["object"],"help":"","inlineHelp":"All of the collision response handlers.","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"oldpos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object in the previous update.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"radius","type":["number"],"help":"","inlineHelp":"The radius of this circle shape.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"system","type":["Phaser.Physics.Ninja"],"help":"","inlineHelp":"A reference to the physics system.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity of this object.","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width.","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"xw","type":["number"],"help":"","inlineHelp":"Half the height.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"oH","type":["number"],"help":"","inlineHelp":"Internal var.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"oV","type":["number"],"help":"","inlineHelp":"Internal var.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}