@pbuk/game-loop
v1.0.0
Published
Game loop for browser
Downloads
2
Readme
game-loop
A game loop for browser.
Quick start
Include game-loop from CDN.
<script src="https://cdn.jsdelivr.net/npm/@pbuk/game-loop@1"></script>
Create the callbacks that define the game.
const config = {
// Things that stay the same.
};
const getInitialState = (config) => {
return {
// Things that change.
};
};
const update = ({ config, state, frameLength, runTime, gameState }) => {
// Update state (don't change anything else).
};
const render = ({ config, state, frameLength, runTime, gameState }) => {
// Update all displays (don't change anything).
};
Create and manage the game loop.
// Set up the game and call `update` and `render` once with gameState = 'notStarted'.
const { start, stop, reset } = GameLoop.createGame({ config, getInitialState, update, render });
// Starts the game running, or resumes after `stop()`.
start();
// Stops the game (can be resumed with `start()`).
stop();
// Stops the game and resets the state to the initial state.
reset();