Real time timers

Introduction¶

Start and counting timer by real-time timestamp.

Note

Not support pause, or timescale features.

Author: Rex
Member of scene, or game object

Live demos¶

Progress

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

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

Add real-time timers object

var realTimeTimers = scene.plugins.get('rexrealtimetimersplugin').add(config);

Import plugin¶

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

Install plugin in configuration of game

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

Add real-time timers object

var realTimeTimers = scene.plugins.get('rexRealTimeTimers').add(config);

Import class¶

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

Import class

import RealTimeTimers from 'phaser3-rex-plugins/plugins/realtimetimers.js';

Add real-time timers object

var realTimeTimers = new RealTimeTimers(config);

Create instance¶

var realTimeTimers = scene.plugins.get('rexRealTimeTimers').add({
    // startTimestamp: new Date().getTime(),
    // getTimestampCallback: functio() { return timestamp; }
});

getTimestampCallback : Custom callback of get current timestamp, optional.
- Default behavior is getting current timestamp from system.
startTimestamp : Start time, optional. Use this start-timestamp if getTimestampCallback is not given.
- Default value is current timestamp new Date().getTime().

Set start timestamp¶

Start-timestamp is set when creating this real-time timers object.

User still can change Start-timestamp by

realTimeTimers.setStartTimestamp(timestamp);

This changing won't affect existed timers.

Add a timer¶

realTimeTimers.addTimer(name, period);
// realTimeTimers.addTimer(name, period, data);
// realTimeTimers.addTimer(name, period, data, currentTimestamp);

name : Any name string of this timer.
period : Will expire after period time, in millisecond.
data : Any kind of custom data.
currentTimestamp : Start this time in current time, optional.
- undefined : Get current timestamp from getTimestampCallback callback.

or

realTimeTimers.addTimer(name, {
    day: dayCount,        // d: dayCount,
    hour: hourCount,      // h: hourCount,
    minute: minuteCount,  // m: minuteCount,
    second: secondCount,  // s: secondCount,
}, data, currentTimestamp);

Sum period by
- day, or d : Day count
- hour, or h : Hour count
- minute, or m : Minute count
- second, or s : Second count

Increase period¶

realTimeTimers.incTimerPeriod(name, period);

name : Any name string of this timer.
period : Will expire after period time, in millisecond.

or

realTimeTimers.incTimerPeriod(name, {
    day: dayCount,        // d: dayCount,
    hour: hourCount,      // h: hourCount,
    minute: minuteCount,  // m: minuteCount,
    second: secondCount,  // s: secondCount,
});

Will trigger 'update' event.

Expire timers¶

Get expired timers
```
var timers = realTimeTimers.getExpiredTimers();
// var timers = realTimeTimers.getExpiredTimers(currentTimestamp);
```
- timers : Array of expired timers. Each timer include these properties -
```
{
    name: name,
    start: timestamp,
    period: time
}
```
- currentTimestamp : Start this time in current time, optional.
  - undefined : Get current timestamp from getTimestampCallback callback.
Pop(get and remove) expired timers
```
var timers = realTimeTimers.popExpiredTimers();
// var timers = realTimeTimers.popExpiredTimers(currentTimestamp);
```
- currentTimestamp : Start this time in current time, optional.
  - undefined : Get current timestamp from getTimestampCallback callback.

Get progress of timer

var result = realTimeTimers.getTimersProgress()
// var result = realTimeTimers.getTimersProgress(currentTimestamp);

currentTimestamp : Start this time in current time, optional.
- undefined : Get current timestamp from getTimestampCallback callback.

result : Array of timer's progress. Include these properties -

{
    name: name,
    period: time,
    elapsed: time,
    progress: t    // elapsed/period
    timer: timerObject
}

timer : Timer object, can remove this timer object by
```
realTimeTimers.removeTimers(timer);
```

Get timers¶

Get last added timer
```
var timer = realtimetimers.lastTimer;
```

Get all timers

var timers = realtimetimers.getTimers();

Get timers by name.

var timers = realtimetimers.getTimers(name);

Amount of total timers
```
var amount = realtimetimers.length;
```

Remove timers¶

Remove timers by name
```
realtimetimers.removeTimers(name);
```
Remove timer object
```
realtimetimers.removeTimers(timer);
```
- timer : A timer object, or an array of timer objects.
Remove all timers
```
realtimetimers.clearTimers();
```

States¶

Get states in plain object
```
var states = realtimetimers.toJSON();
```
Get states in JSON string. Can store this JSON string into webstorage or server.
```
var s = JSON.stringify(realtimetimers);
```
Set states by plain object
```
realtimetimers.resetFromJSON(states)
```

Events¶

On add a timer

realtimetimers.on('add', function(timer, timers){ })

timer : Added timer.

{
    name: name,
    start: timestamp,
    period: time
}

timers : Total timers after adding.

On remove a timer

realtimetimers.on('remove', function(timer, timers){ })

timer : Removed timer.

{
    name: name,
    start: timestamp,
    period: time
}

timers : Total timers after removing.

On timers updated (add, remove, or increas period).

realtimetimers.on('update', function(timers){ 
    var s = JSON.stringify(realtimetimers);
    // Store current states to webstorage or server here.
})

timers : Total timers after updating.