Examples of how to run a Matter.js engine
Runner example
Browser
A basic example for running a previously created Matter.Engine
(see Getting started):
- (function run() {
- window.requestAnimationFrame(run);
- Engine.update(engine, 1000 / 60);
- })();
See also the source of Matter.Runner that provides some more advanced features.
Node
When using node you can use setInterval instead of window.requestAnimationFrame
:
- setInterval(function() {
- Engine.update(engine, 1000 / 60);
- }, 1000 / 60);
Using Matter.Runner
There is an included runner called Matter.Runner.This module is an optional utility which provides a game loop, that handles continuously updating a Matter.Engine
for you. It is intended for development and debugging purposes, but may also be suitable for simple games.
Documentation
See the documentation for Matter.Runner.
Usage
The simplest way is to use the Engine.run
helper:
- var engine = Engine.create();
- Engine.run(engine);
Alternatively you can create a runner directly:
- var runner = Runner.create();
- Runner.run(runner, engine);
Options
A number of options may be passed to Matter.Runner.create
:
- var runner = Runner.create({
- delta: 1000 / 60,
- isFixed: false,
- enabled: true
- });