https://github.com/colyseus/clock
A simple clock/ticker implementation to track elapsed/delta time.
https://github.com/colyseus/clock
clock delta ticker time
Last synced: 4 months ago
JSON representation
A simple clock/ticker implementation to track elapsed/delta time.
- Host: GitHub
- URL: https://github.com/colyseus/clock
- Owner: colyseus
- License: mit
- Created: 2015-09-22T22:27:49.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T20:29:04.000Z (about 1 year ago)
- Last Synced: 2025-06-14T01:15:53.790Z (4 months ago)
- Topics: clock, delta, ticker, time
- Language: JavaScript
- Size: 31.3 KB
- Stars: 19
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @colyseus/clock
A simple clock/ticker implementation to track delta/elapsed time.
API
---
- `new Clock([useInterval=false])`
- `clock.start([useInterval=false])`
- `clock.stop()`
- `clock.tick()`
- `clock.elapsedTime`
- `clock.deltaTime`
- `clock.currentTime`
Usage example
---
There's two ways you can use clock.js: manual or automatic.
**Automatic**
By initializing `Clock` with `true` as the first argument, a interval will be
created, in which `tick()` is called 60 times per second.
```typescript
import Clock from '@colyseus/clock';
let clock = new Clock(true);
```
You can also call `start(true)` to create the interval.
```javascript
import Clock from '@colyseus/clock';
let clock = new Clock();
clock.start(true);
```
**Manual usage**
You call `tick()` manually in your existing loop.
```typescript
import Clock from '@colyseus/clock';
var clock = new Clock();
setInterval(function() {
clock.tick();
console.log("Delta time: ", clock.deltaTime);
console.log("Elapsed time: ", clock.elapsedTime);
console.log("Current time: ", clock.currentTime);
}, 1000 / 60);
```
License
---
MIT