Class: World

Constructor

new World(options)

Parameters:

Name Type Description

options

object

World options

Properties

Name	Type	Attributes	Default	Description
`gravity`	vec	<optional>	vec(0, 500)	Gravity in pixels / second
`gridSize`	number	<optional>	500	Size of broadphase grid in pixels

Source: node/World.js, line 12

Extends

Node

Members

(readonly) nodeType

Type of node, ie Node or RigidBody

Overrides: Node#nodeType
Source: node/Node.js, line 28

(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() → {Node}

Adds this node and its children, triggering the add event

Overrides: Node#add
Source: node/Node.js, line 70

Returns:

this

Type:: Node

delete() → {Node}

Removes this node and its children, triggering the delete event

Overrides: Node#delete
Source: node/Node.js, line 85

Returns:

this

Type:: Node

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 {}

setPosition(position)

Sets this node's position to position

Parameters:

Name	Type	Description
`position`	vec	Position the node should be set to

Overrides: Node#setPosition
Source: node/Node.js, line 139

Example

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

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

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: node/Node.js, line 202

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: node/Node.js, line 215

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: node/Node.js, line 226