Class: Circle

Phaser.Physics.Ninja. Circle

new Circle(body, x, y, radius)

Ninja Physics Circle constructor. Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.

Parameters:
Name Type Description
body Phaser.Physics.Ninja.Body

The body that owns this shape.

x number

The x coordinate to create this shape at.

y number

The y coordinate to create this shape at.

radius number

The radius of this Circle.

Source:
src/physics/ninja/Circle.js line 18

Members

body

Properties:
Name Type Description
system Phaser.Physics.Ninja.Body

A reference to the body that owns this shape.

Source:
src/physics/ninja/Circle.js line 24

circleTileProjections : object

All of the collision response handlers.

Type:
  • object
Source:
src/physics/ninja/Circle.js line 90

<readonly> height : number

The height.

Type:
  • number
Source:
src/physics/ninja/Circle.js line 68

oldpos : Phaser.Point

The position of this object in the previous update.

Type:
Source:
src/physics/ninja/Circle.js line 39

pos : Phaser.Point

The position of this object.

Type:
Source:
src/physics/ninja/Circle.js line 34

radius : number

The radius of this circle shape.

Type:
  • number
Source:
src/physics/ninja/Circle.js line 44

system : Phaser.Physics.Ninja

A reference to the physics system.

Type:
Source:
src/physics/ninja/Circle.js line 29

velocity : Phaser.Point

The velocity of this object.

Type:
Source:
src/physics/ninja/Circle.js line 85

<readonly> width : number

The width.

Type:
  • number
Source:
src/physics/ninja/Circle.js line 62

<readonly> xw : number

Half the width.

Type:
  • number
Source:
src/physics/ninja/Circle.js line 50

<readonly> yw

Properties:
Name Type Description
xw number

Half the height.

Source:
src/physics/ninja/Circle.js line 56

Methods

collideCircleVsTile(t)

Collides this Circle with a Tile.

Parameters:
Name Type Description
t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 251
Returns:

True if they collide, otherwise false.

Type
boolean

collideWorldBounds()

Collides this Circle against the world bounds.

Source:
src/physics/ninja/Circle.js line 209

destroy()

Destroys this Circle's reference to Body and System

Source:
src/physics/ninja/Circle.js line 2634

integrate()

Updates this Circles position.

Source:
src/physics/ninja/Circle.js line 112

projCircle_22DegB(x, y, oH, oV, obj, t)

Resolves 22 Degree tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 1732
Returns:

The result of the collision.

Type
number

projCircle_22DegS(x, y, oH, oV, obj, t)

Resolves 22 Degree tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 1437
Returns:

The result of the collision.

Type
number

projCircle_45Deg(x, y, oH, oV, obj, t)

Resolves 45 Degree tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 453
Returns:

The result of the collision.

Type
number

projCircle_67DegB(x, y, oH, oV, obj, t)

Resolves 67 Degree tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 2326
Returns:

The result of the collision.

Type
number

projCircle_67DegS(x, y, oH, oV, obj, t)

Resolves 67 Degree tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 2038
Returns:

The result of the collision.

Type
number

projCircle_Concave(x, y, oH, oV, obj, t)

Resolves Concave tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 724
Returns:

The result of the collision.

Type
number

projCircle_Convex(x, y, oH, oV, obj, t)

Resolves Convex tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 959
Returns:

The result of the collision.

Type
number

projCircle_Full(x, y, oH, oV, obj, t)

Resolves Full tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 340
Returns:

The result of the collision.

Type
number

projCircle_Half(x, y, oH, oV, obj, t)

Resolves Half tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 1202
Returns:

The result of the collision.

Type
number

render(context, xOffset, yOffset, color, filled)

Render this circle for debugging purposes.

Parameters:
Name Type Description
context object

The context to render to.

xOffset number

X offset from circle's position to render at.

yOffset number

Y offset from circle's position to render at.

color string

color of the debug shape to be rendered. (format is css color string).

filled boolean

Render the shape as solid (true) or hollow (false).

Source:
src/physics/ninja/Circle.js line 2645

reportCollisionVsWorld(px, py, dx, dy, obj)

Process a world collision and apply the resulting forces.

Parameters:
Name Type Description
px number

The tangent velocity

py number

The tangent velocity

dx number

Collision normal

dy number

Collision normal

obj number

Object this Circle collided with

Source:
src/physics/ninja/Circle.js line 133

resolveCircleTile(x, y, oH, oV, obj, t)

Resolves tile collision.

Parameters:
Name Type Description
x number

Penetration depth on the x axis.

y number

Penetration depth on the y axis.

oH number

Grid / voronoi region.

oV number

Grid / voronoi region.

obj Phaser.Physics.Ninja.Circle

The Circle involved in the collision.

t Phaser.Physics.Ninja.Tile

The Tile involved in the collision.

Source:
src/physics/ninja/Circle.js line 314
Returns:

The result of the collision.

Type
number

phaser-ce@2.20.1 is on GitHub and NPM

Documentation generated by JSDoc 3.6.11 on 2024-10-05 using Tomorrow.