phaser/v2-community/resources/docgen/output/Phaser.Physics.Ninja.AABB.json

{"class":{"name":"Phaser.Physics.Ninja.AABB","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":"width","type":["number"],"help":"The width of this AABB.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of this AABB.","optional":false,"default":null}],"help":"Ninja Physics AABB constructor.\\nNote: This class could be massively optimised and reduced in size. I leave that challenge up to you."},"consts":[],"methods":{"public":[{"name":"collideAABBVsAABB","static":false,"returns":null,"help":"Collides this AABB against a AABB.","line":346,"public":true,"protected":false,"private":false,"parameters":[{"name":"aabb","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB to collide against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideAABBVsTile","static":false,"returns":null,"help":"Collides this AABB against a Tile.","line":418,"public":true,"protected":false,"private":false,"parameters":[{"name":"tile","type":["Phaser.Physics.Ninja.Tile"],"help":"The Tile to collide against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"collideWorldBounds","static":false,"returns":null,"help":"Collides this AABB against the world bounds.","line":304,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Destroys this AABB's reference to Body and System","line":1002,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"integrate","static":false,"returns":null,"help":"Updates this AABBs position.","line":113,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"projAABB_22DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":716,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_22DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 22 Degree tile collision.","line":636,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_45Deg","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 45 Degree tile collision.","line":583,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_67DegB","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":848,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_67DegS","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves 67 Degree tile collision.","line":769,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_Concave","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Concave tile collision.","line":949,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_Convex","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Convex tile collision.","line":899,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_Full","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Full tile collision.","line":505,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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":"projAABB_Half","static":false,"returns":{"types":["number"],"help":"The result of the collision."},"help":"Resolves Half tile collision.","line":524,"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":"obj","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB 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 AABB for debugging purposes.","line":1017,"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 AABB's position to render at.","optional":false,"default":null},{"name":"yOffset","type":["number"],"help":"Y offset from AABB'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":"reportCollisionVsBody","static":false,"returns":null,"help":"Process a body collision and apply the resulting forces. Still very much WIP and doesn't work fully. Feel free to fix!","line":242,"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 AABB collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reportCollisionVsWorld","static":false,"returns":null,"help":"Process a world collision and apply the resulting forces.","line":138,"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 AABB collided with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resolveTile","static":false,"returns":{"types":["boolean"],"help":"True if the collision was processed, otherwise false."},"help":"Resolves tile collision.","line":481,"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":"body","type":["Phaser.Physics.Ninja.AABB"],"help":"The AABB involved in the collision.","optional":false,"default":null},{"name":"tile","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":"aabbTileProjections","type":["object"],"help":"","inlineHelp":"All of the collision response handlers.","line":86,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"The height.","line":64,"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":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pos","type":["Phaser.Point"],"help":"","inlineHelp":"The position of this object.","line":35,"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":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"velocity","type":["Phaser.Point"],"help":"","inlineHelp":"The velocity of this object.","line":81,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"The width.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"xw","type":["number"],"help":"","inlineHelp":"Half the height.","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"oH","type":["number"],"help":"","inlineHelp":"Internal var.","line":70,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"oV","type":["number"],"help":"","inlineHelp":"Internal var.","line":76,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}