World

class World extends Container

an object representing the physic world, and responsible for managing and updating all childs and physics

Constructor

new World(x: number, y: number, width: number, height: number) → {}

Parameters:
Name	Type	Attributes	Default	Description
x	number	<optional>	0	position of the container (accessible via the inherited pos.x property)
y	number	<optional>	0	position of the container (accessible via the inherited pos.y property)
width	number	<optional>	game.viewport.width	width of the container
height	number	<optional>	game.viewport.height	height of the container

Summary

Properties from World

Application	app = undefined
Set<Body>	bodies
QuadTree	broadphase
Vector2d	fps = 60
Vector2d	gravity = <0,0.98>
boolean	preRender = false

Methods from World

World	addBody(body: Body)
World	removeBody(body: Body)
	reset()
boolean	reset(dt: number)

Properties inherited from Container

boolean	autoDepth = true
boolean	autoSort = true
Color	backgroundColor = (0, 0, 0, 0.0)
boolean	clipping = false
boolean	enableChildBoundsUpdate = false
boolean	root = false
string	sortOn = me.game.sortOn

Properties inherited from Renderable

number	alpha = 1.0
boolean	alwaysUpdate = false
Container \| Entity	ancestor = undefined
ObservableVector2d	anchorPoint = <0.5,0.5>
boolean	autoTransform = true
string	blendMode = "normal"
Body	body
Matrix2d	currentTransform
boolean	floating = false
string	GUID
boolean	inViewport = false
boolean	isDirty = false
boolean	isFlippedX
boolean	isFlippedY
boolean	isFloating
boolean	isKinematic = true
boolean	isPersistent = false
Rect \| RoundRect \| Polygon \| Line \| Ellipse	mask = undefined
string	name = ""
Function	onVisibilityChange = undefined
ObservableVector3d	pos
Color	tint = (255, 255, 255)
boolean	updateWhenPaused = false

Properties inherited from Rect

number	bottom
number	centerX
number	centerY
number	height
number	left
number	right
number	top
number	width

Properties inherited from Polygon

Array<Vector2d>

points

Methods inherited from Container

Renderable	addChild(child: Renderable, z: number)
Renderable	addChildAt(child: Renderable, index: number)
	forEach(callback: Function, thisArg: object)
Renderable	getChildAt(index: number)
Renderable	getChildByGUID(guid: string \| RegExp \| number \| boolean)
Array<Renderable>	getChildByName(name: string \| RegExp \| number \| boolean)
Array<Renderable>	getChildByProp(prop: string, value: string \| RegExp \| number \| boolean)
Array<Renderable>	getChildByType(classType: object)
number	getChildIndex(child: Renderable)
Array<Renderable>	getChildren()
Renderable	getNextChild(child: Renderable)
boolean	hasChild(child: Renderable)
	moveDown(child: Renderable)
	moveToBottom(child: Renderable)
	moveToTop(child: Renderable)
	moveUp(child: Renderable)
	onChildChange(index: number)
	removeChild(child: Renderable, keepalive: boolean)
	removeChildNow(child: Renderable, keepalive: boolean)
	setChildsProperty(prop: string, value: object, recursive: boolean)
	sort(recursive: boolean)
	swapChildren(child: Renderable, child2: Renderable)
	protected draw(renderer: CanvasRenderer \| WebGLRenderer, viewport: Camera2d)
boolean	protected update(dt: number)

Methods inherited from Renderable

number	angleTo(target: Renderable \| Vector2d \| Vector3d)
number	distanceTo(target: Renderable \| Vector2d \| Vector3d)
Renderable	flipX(flip: boolean)
Renderable	flipY(flip: boolean)
Vector2d	getAbsolutePosition()
Bounds	getBounds()
number	getOpacity()
Renderable	lookAt(target: Renderable \| Vector2d \| Vector3d)
boolean	onCollision(response: ResponseObject, other: Renderable)
	onDestroyEvent()
	postDraw(renderer: CanvasRenderer \| WebGLRenderer)
	preDraw(renderer: CanvasRenderer \| WebGLRenderer)
Renderable	rotate(angle: number, v: Vector2d \| ObservableVector2d)
Renderable	scale(x: number, y: number)
Renderable	scaleV(v: Vector2d)
	setOpacity(alpha: number)
Renderable	transform(m: Matrix2d)

Methods inherited from Rect

Rect	centerOn(x: number, y: number)
Rect	clone()
boolean	contains(point: Vector2d)
Rect	copy(rect: Rect)
boolean	equals(rect: Rect)
boolean	isFinite()
boolean	overlaps(rect: Rect)
Rect	resize(w: number, h: number)
Rect	setShape(x: number, y: number, w: number \| Vector2d<Array>, h: number)
Polygon	toPolygon()
Rect	union(rect: Rect)

Methods inherited from Polygon

Array	getIndices()
boolean	isConvex()
Polygon	recalc()
Polygon	setVertices(vertices: Array<Vector2d>)
	shift(x: number, y: number)
Polygon	to2d()
Polygon	toIso()
Polygon	translate(v: Vector2d)

Public Properties

app world.js:31

app: Application = undefined

the application (game) this physic world belong to

bodies world.js:74

bodies: Set<Body>

the active physic bodies in this simulation

broadphase world.js:83

broadphase: QuadTree

the instance of the game world quadtree used for broadphase

fps world.js:38

fps: Vector2d = 60

the rate at which the game world is updated, may be greater than or lower than the display fps

See: timer.maxfps

gravity world.js:50

gravity: Vector2d = <0,0.98>

world gravity

preRender world.js:60

preRender: boolean = false

Specify the rendering method for tile layers.
if false visible part of the layers are rendered dynamically,
if true the entire layers are first rendered into an offscreen canvas.
the "best" rendering method depends of your game (amount of layer, layer size, amount of tiles per layer, etc.)
note : rendering method is also configurable per layer by adding this property to your layer (in Tiled).

Public Methods

addBody world.js:122

addBody(body: Body) → {World}

Add a physic body to the game world

Parameters:
Name	Type	Description
body	Body

Returns:
Type	Description
World	this game world

See: Container.addChild

removeBody world.js:136

removeBody(body: Body) → {World}

Remove a physic body from the game world

Parameters:
Name	Type	Description
body	Body

Returns:
Type	Description
World	this game world

See: Container.removeChild

reset world.js:102

reset() → {}

reset the game world

reset world.js:168

reset(dt: number) → {boolean}

update the game world

Parameters:
Name	Type	Description
dt	number	the time passed since the last frame update

Returns:
Type	Description
boolean	true if the word is dirty