https://github.com/azerion/phaser-web-workers

A simple Phaser plugin that allows you to easily integrate Web Workers in your game
https://github.com/azerion/phaser-web-workers

pathfinding phaser phaser-plugin workers

Last synced: 5 days ago
JSON representation

A simple Phaser plugin that allows you to easily integrate Web Workers in your game

• Host: GitHub
• URL: https://github.com/azerion/phaser-web-workers
• Owner: azerion
• License: mit
• Created: 2016-12-08T08:53:39.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T14:58:29.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T13:07:30.293Z (6 months ago)
• Topics: pathfinding, phaser, phaser-plugin, workers
• Language: TypeScript
• Size: 178 KB
• Stars: 50
• Watchers: 4
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# phaser-web-workers

A simple Phaser plugin that allows you to easily integrate Web Workers in your game, this is ideal for offloading cpu intensive work (pathfinding, maybe physics?) to a seperate browser thread.

Currently still in alpha-phase and not yet feature complete.

Getting Started

---------------

First you want to get a fresh copy of the plugin. You can get it from this repo or from npm, ain't that handy.

```

npm install @azerion/phaser-web-workers --save-dev

```

Next up you'd want to add it to your list of js sources you load into your game

```html

 

```

After adding the script to the page you can activate it by enabling the plugin:

```javascript

game.add.plugin(PhaserWebWorkers.Plugin);

```

Usage

-----

As this is a simple wrapper (including preloading) of workers, not a lot of exciting stuff needs to happen in order to get this set up.

First step is to preload the worker whenever you do you usual preloading:

```javascript

        function preload() {

            //Preload the file we'd like to use as a worker

            game.load.worker('myWorker', 'worker.js');

        }

```

After that it's just a matter of creating the worker, assigning a listener and send it some data.

The worker is configured to handle the incomming data (or errors) and responed whenever it's done processing.

```javascript

//Create the worker from cache

var worker = game.make.worker('myWorker');

//Assign the message listener

worker.onMessage.add(function (e) {

    console.log('received worker data!', e);

});           

//Assign the error listener

worker.onError.add(function (e) {

    console.log('Oh no, something went wrong!', e);

});

```

Don't forget to destroy your worker when your done with it (they take a decent amount of memory):

```javascript

worker.destroy();

```

Why use a Webworker?

--------------------

Webworkers are ideal for doing heavy computations whilst not locking up your game. The browser accomplishes this by running everything a worker does in a seperate thread. So you can offload your fancy stuff like pathfinding.

Browser Support

---------------

[Almost everywhere](http://caniuse.com/#feat=webworkers)

Disclaimer

----------

We at Azerion just love playing and creating awesome games. We aren't affiliated with Phaser.io. We just needed some awesome web worker compatibility in our awesome HTML5 games. Feel free to use it for enhancing your own awesome games!

Phaser Web Workers is distributed under the MIT license. All 3rd party libraries and components are distributed under their

respective license terms.