

Gashapon

Introduction¶

Pick random item from box.

Author: Rex
Member of scene, or game object

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

scene.load.plugin('rexgashaponplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexgashaponplugin.min.js', true);

Add gashapon object

var gashapon = scene.plugins.get('rexgashaponplugin').add(config);

Import plugin¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Install plugin in configuration of game

import GashaponPlugin from 'phaser3-rex-plugins/plugins/gashapon-plugin.js';
var config = {
    // ...
    plugins: {
        global: [{
            key: 'rexGashapon',
            plugin: GashaponPlugin,
            start: true
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add gashapon object

var gashapon = scene.plugins.get('rexGashapon').add(config);

Import class¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Import class

import Gashapon from 'phaser3-rex-plugins/plugins/gashapon.js';

Add gashapon object
```
var gashapon = new Gashapon(config);
```

Create instance¶

var gashapon = scene.plugins.get('rexGashapon').add({
    mode: 'shuffle',  // 0|'shuffle'|1|'random
    items: {  // name:count
        a:1, 
        b:2, 
        c:3 
    },
    reload: true,     // true|false
    rnd: undefined,
});

mode :
- 'shuffle', or 0 : pick item from box without put it back.
- 'random', or 1 : pick item from box then put it back.
reload : set true to reload items when box is empty for shuffle mode.
items : initial items in box
rnd : Use random data generator to generate result.
- undefined : Use Math.random() to generate result.
- Phaser.Math.RND : Use pre-defined random data generator.

Pick item¶

Pick a random item¶

var item = gashapon.next();

return null if pick nothing

Pick specific item¶

var item = gashapon.next('a');

return null if pick nothing

Last picked item¶

var item = gashapon.result;

Set item¶

gashapon.setItem('a', 1);
// gashapon.setItem('a', 1).setItem('b', 2).setItem('c', 3);

Add item¶

gashapon.addItem('a',1);

Remove item¶

gashapon.removeItem('a');
// gashapon.removeItem('b').gashapon.removeItem('c');

Remove all items¶

gashapon.removeAllItems();

Current status¶

Get current status¶

var status = gashapon.toJSON();

Clone object¶

var status = gashapon.toJSON();
var gashapon2 = new Gashapon(status);

Overwrite current status¶

var status = gashapon.toJSON();
// gashapon.next()...
gashapon.resetFromJSON(status);

Get items¶

For each item¶

gashapon.eachItem(function(name, count){
    console.log(name + ": " + count);
});

Get items¶

var items = gashapon.getItems();

Set random generator¶

gashapon.setRND(rnd);

rnd : Use random data generator to generate result.
- undefined : Use Math.random() to generate result.
- Phaser.Math.RND : Use pre-defined random data generator.