Class: RigidBody

Name	Description	Arguments
bodyEnter	Body starts colliding with another	`(otherBody: RigidBody, collision: Object)`
bodyInside	Body is currently colliding with another. Triggered every frame after the initial collision. In other words, it won't trigger the same frame as `bodyEnter` but will every subsequent frame the bodies are still colliding	`(otherBody: RigidBody, collision: Object)`
bodyExit	Triggered the frame bodies stop colliding	`(otherBody: RigidBody, collision: Object)`
beforeUpdate	Triggered every frame before forces are applied to the body's velocity and then cleared. Best used to apply forces to the body. It's only called when the body is in the world	None
duringUpdate	Triggered every frame before the body's position is updated using its velocity. Best used to clear forces from the body. It's only called when the body is in the world	None
add	Triggered before the body is added to the world	None
delete	Triggered before the body is removed from the world	None

Constructor

new RigidBody(Game, vertices, position, options)

Creates a new RigidBody

Parameters:

Name	Type	Description
`Game`	Game	Game object the body should be simulated in; If you're creating a RigidBody from a game object, like `game.Bodies.Rectangle(...)`, then you must omit this parameter.
`vertices`	Array	Array of `vec` representing the body's vertices
`position`	vec	Position of the body
`options`	Object	RigidBody options

Source: physics/RigidBody.js, line 26

Example

// Includes all RigidBody options
new RigidBody(game, [new vec(0, 0), new vec(10, 0), new vec(10, 10), new vec(0, 10)], new vec(0, 0), {
	mass: 1,
	restitution: 0.1,

	frictionAir: 0.05,
	frictionAngular: 0.01,
	friction: 0.1,

	round: 0,
	roundQuality: 20,

	isStatic: false,
	isSensor: false,
	hasCollisions: true,
	collisionFilter: {
		layer: 0xFFFFFF,
		mask: 0xFFFFFF,
	},
});

Extends

Node

Members

(readonly) nodeType

Indicates type of node. In this case, "RigidBody"

Overrides: Node#nodeType
Source: physics/RigidBody.js, line 91

(readonly) mass :Number

Type:

Number

Source: physics/RigidBody.js, line 101

restitution :Number

Bounciness

Type:

Number

Source: physics/RigidBody.js, line 106

frictionAir :Number

How much the body is always slowed down

Type:

Number

Source: physics/RigidBody.js, line 111

frictionAngular :Number

How much body's rotation is always slowed down

Type:

Number

Source: physics/RigidBody.js, line 116

friction :Number

Type:

Number

Source: physics/RigidBody.js, line 120

(readonly) isStatic :Boolean

If the body is static (unmoving). Change through setStatic

Type:

Boolean

Source: physics/RigidBody.js, line 129

isSensor :Boolean

If the body acts like a sensor, detecting collisions while not hitting anything

Type:

Boolean

Source: physics/RigidBody.js, line 134

(readonly) hasCollisions :Boolean

If the body has any collisions. Change through setCollisions

Type:

Boolean

Source: physics/RigidBody.js, line 140

collisionFilter :Object

What bodies it can collide with. The layer is like what collision group the body belongs to and the mask is what layers the body will collide with. They are compared using their bits to indicate what layer it is in/collides with.
Another way to visualize it looking at the bits:
Layer: 0 1 0 1
Mask 1: 0 0 0 1 <-- collides
Mask 2: 0 0 1 0 <-- doesn't collide
Mask 3: 1 1 1 0 <-- collides
In other words, if layer & mask != 0 (bitwise and) for either of the bodies in the collision, the bodies can collide

Type:

Object

Source: physics/RigidBody.js, line 166

Example

// In every layer, collides with everything (the default)
body.collisionFilter = {
	layer: 0xFFFFFF,
	mask:  0xFFFFFF,
}
// In first 2 layers, collides only with 2nd layer
// So it would collide with itself and any body that has a mask in layers 1 or 2
body.collisionFilter = {
	layer: 0b0011,
	mask:  0b0010,
}

(readonly) position :vec

Position of the node

Type:

Overrides: Node#position
Source: node/Node.js, line 36
To Do: Implement getPosition method and make this private

(readonly) angle :number

Angle, in radians

Type:

number

Overrides: Node#angle
Source: node/Node.js, line 43
To Do: Implement getAngle method and make this private

(readonly) children :Set

Children of the node To modify, use addChild or removeChild.

Type:

Overrides: Node#children
Source: node/Node.js, line 50

Methods

add() → {RigidBody}

Adds the body to its world

Overrides: Node#add
Source: physics/RigidBody.js, line 273

Returns:

this

Type:: RigidBody

delete() → {RigidBody}

Removes the body from its world

Overrides: Node#delete
Source: physics/RigidBody.js, line 286

Returns:

this

Type:: RigidBody

addPolygonRender(options, containeropt) → {RigidBody}

Adds a polygon render to body

Parameters:

Name	Type	Attributes	Default	Description
`options`	Object			Polygon Render options
`container`	PIXI.Container	<optional>	this.Game.Render.app.stage	Container polygon render is added to. Defaults to the main render container of the game the body is in.

Source: physics/RigidBody.js, line 318

Returns:

this

Type:: RigidBody

Example

body.addPolygonRender({
	layer: 0, // Render layer, higher means it is rendered "closer" to the camera and above other objects, like CSS z-index
	visible: true,
	alpha: 1, // Opacity, between 0-1
	
	// All colors can be a hex code, rgb, rgba, or "transparent"
	background: "#ffffff80", // fill color

	border: "#ff0000", // border color
	borderWidth: 3, // How thick border is, set to 0 to disable border
	lineCap: "butt", // How border should end. Doesn't do anything for closed bodies
	lineJoin: "miter", // How border's corners should look. Same options as ctx.lineJoin property
	
	round: 0, // How rounded the polygon should look. Only works for Rectangles
});

addSprite(options, containeropt) → {RigidBody}

Adds a sprite to body

Parameters:

Name	Type	Attributes	Default	Description
`options`	Object			Sprite options
`container`	PIXI.Container	<optional>	this.Game.Render.app.stage	Container sprite is added to. Defaults to the main render container of the game the body is in.

Source: physics/RigidBody.js, line 352

Returns:

this

Type:: RigidBody

Example

body.addSprite(Render.app.stage, {
	layer: 0, // number

	visible: true,
	alpha: 1, // number between [0, 1]
	src: "path/to/sprite.png",
	
	scale: new vec(1, 1),
	width:  undefined, // number, defaults to fit body if a Rectangle or Circle, or width of image if not
	height: undefined, // number, defaults to fit body if a Rectangle or Circle, or height of image if not
});

addSpritesheet(container, options) → {RigidBody}

Adds a new Spritesheet to body

Parameters:

Name	Type	Description
`container`	PIXI.Container	Container the Spritesheet is added to
`options`	Object	Spritesheet options

Source: physics/RigidBody.js, line 372

Returns:

this

Type:: RigidBody

setStatic(isStatic)

Changes if the body is static

Parameters:

Name	Type	Description
`isStatic`	boolean	If the body should be static

Source: physics/RigidBody.js, line 391

setMass(mass)

Changes the body's mass to a new value

Parameters:

Name	Type	Description
`mass`	number

Source: physics/RigidBody.js, line 423

setCollisions(hasCollisions)

Changes if the body can collide with other bodies

Parameters:

Name	Type	Description
`hasCollisions`	boolean	Whether the body can collide with other bodies

Source: physics/RigidBody.js, line 433

containsPoint(point) → {boolean}

Finds if a point is inside the body's collision shapes

Parameters:

Name	Type	Description
`point`	vec	Point to query

Source: physics/RigidBody.js, line 462

Returns:

If the point is inside the body's vertices

Type:: boolean

setPosition(position)

Instantly sets body's position to position

Parameters:

Name	Type	Description
`position`	vec	Position the body should be

Overrides: Node#setPosition
Source: physics/RigidBody.js, line 477

Example

body.setPosition(new vec(100, 100)); // Sets body's position to (100, 100)

setVelocity(velocity)

Instantly changes the body's velocity to a specific value

Parameters:

Name	Type	Description
`velocity`	vec	Velocity the body should have

Source: physics/RigidBody.js, line 487

setAngularVelocity(velocity)

Instantly changes the body's angular velocity to a specific value

Parameters:

Name	Type	Description
`velocity`	number	Angular velocity the body should have

Source: physics/RigidBody.js, line 501

applyForce(force, deltaopt)

Applies a force to the body, ignoring mass. The body's velocity changes by force * delta

Parameters:

Name	Type	Attributes	Default	Description
`force`	vec			Amount of force to be applied, in px / sec^2
`delta`	number	<optional>	Engine.delta	Amount of time that the force is applied, in seconds. Set to 1 if applying instantaneous force

Source: physics/RigidBody.js, line 515

applyTorque(force, deltaopt)

Applies a rotational force (torque) to the body, ignoring mass. The body's angular velocity changes by force * delta

Parameters:

Name	Type	Attributes	Default	Description
`force`	number			Amount of torque to be applied, in radians / sec^2
`delta`	number	<optional>	Engine.delta	Amount of time that the force is applied, in seconds. Set to 1 if applying instantaneous force

Source: physics/RigidBody.js, line 527

on(event, callback)

Bind a callback to an event

Parameters:

Name	Type	Description
`event`	string	Name of the event
`callback`	function	Callback run when event is fired

Overrides: Node#on
Source: physics/RigidBody.js, line 575

off(event, callback)

Unbinds a callback from an event

Parameters:

Name	Type	Description
`event`	string	Name of the event
`callback`	function	Function to unbind

Overrides: Node#off
Source: physics/RigidBody.js, line 588

trigger(event, …args)

Triggers an event, firing all bound callbacks

Parameters:

Name	Type	Attributes	Description
`event`	string		Name of the event
`args`	*	<repeatable>	Arguments passed to callbacks

Overrides: Node#trigger
Source: physics/RigidBody.js, line 599

isAdded() → {Boolean}

Gets if the node is added

Overrides: Node#isAdded
Source: node/Node.js, line 101

Returns:

if the node is added

Type:: Boolean

addChild(…children)

Adds all children to this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children added

Overrides: Node#addChild
Source: node/Node.js, line 113

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode);

removeChild(…children)

Removes all children from this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children removed

Overrides: Node#removeChild
Source: node/Node.js, line 127

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode); // node.children: Set {childNode}
node.removeChild(childNode); // node.children: Set {}

translate(positionDelta)

Shifts this node's position by positionDelta

Parameters:

Name	Type	Description
`positionDelta`	vec	Amount to shift the position

Overrides: Node#translate
Source: node/Node.js, line 148

setAngle(angle)

Sets the node's angle to angle

Parameters:

Name	Type	Description
`angle`	number	Angle body should be in radians

Overrides: Node#setAngle
Source: node/Node.js, line 162

Example

node.setAngle(Math.PI); // Sets node's angle to Pi radians, or 180 degrees

translateAngle(angle)

Rotates the body by angle- Relative

Parameters:

Name	Type	Description
`angle`	number	Amount the body should be rotated, in radians

Overrides: Node#translateAngle
Source: node/Node.js, line 174