Class BeetPx

Number of frames processed since game started. It gets reset to 0 when BeetPx.restart is called. It counts update calls, not draw calls.

Usually you would use e.g. $timer instead of this low-level API.

Number of frames processed since game started, excluding the frames which happened during an active game pause. It gets reset to 0 when BeetPx.restart is called. It counts update calls, not draw calls.

Usually you would use e.g. $timer instead of this low-level API.

The effective FPS (frames per second) of render calls. This does not count the update calls.

This value is used (with some averaging, to avoid quickly changing number) in the FPS display, which is active in debug mode if BpxEngineConfig's debugMode.fpsDisplay.enabled is set to true.

Restarts the entire game.

It is important to properly set the game initialization logic through the BeetPx.setOnStarted, so the $.restart() will result with a properly restarted game.

An example usage would be to implement a game pause menu, with the "restart the game" as one of available options.

The method to set a draw callback which is called every time the browser has a chance to repaint the canvas (requestAnimationFrame is used under the hood).

The draw callback is one of 2 recommended places to use BeetPxDraw methods within (the other one is the on-started callback set by BeetPx.setOnStarted).

Example

$.setOnStarted(() => {
  // ...
});

$.setOnUpdate(() => {
  // ...
});

$.setOnDraw(() => {
  $d.clearCanvas($rgb_blue);
  $d.pixel($v(10,20), $rgb_red);
});

$.start({
  // ...
});
Copy

See

BpxEngineConfig.fixedTimestep

The method to set an on-started callback which is called every time the game is (re-)started.

While the game starts only once, it can be restarted many time with use of BeetPx.restart. In such case, the callback is useful for clearing up the game state, so nothing from the previous gameplay remains.

The timers, animations, and music restart on their own, there is no manual action needed.

The on-started callback is one of 2 recommended places to use BeetPxDraw methods within (the other one is the draw callback set by BeetPx.setOnDraw).

Example

const inputManager = MySpecialInputManager();
let gameLogic: MyComplexGameLogic;

$.setOnStarted(() => {
  gameLogic = new MyComplexGameLogic();
  inputManager.reset();
});

$.setOnUpdate(() => {
  // ...
});

$.setOnDraw(() => {
  // ...
});

$.start({
  // ...
});
Copy

The method to set an update callback which is called on every iteration of the game loop, on a fixed timestep.

Example

const speed = 6;
let player;

$.setOnStarted(() => {
  // ...
});

$.setOnUpdate(() => {
  player.setPosition(
    player.position.mul($.getPressedDirection()).mul(speed)
  );
});

$.setOnDraw(() => {
  // ...
});

$.start({
  // ...
});
Copy

See

BpxEngineConfig.fixedTimestep

The method which starts the game.

You are supposed to set BeetPx.setOnStarted, BeetPx.setOnUpdate, and BeetPx.setOnDraw before this one.

Example

$.setOnStarted(() => {
  // ...
});

$.setOnUpdate(() => {
  // ...
});

$.setOnDraw(() => {
  // ...
});

$.start({
  gameId: "my-game",
  // ...
});
Copy

The canvas size as set in BpxEngineConfig's canvasSize.

Gives access to the main global AudioContext.

Typically, you wouldn't have to access to method on your own. But it might prove useful to have it in some unexpected scenario.

Checks if the audio is globally muted.

Mutes the audio globally.

The global mute/unmute logic is independent from BeetPx.mutePlayback and BeetPx.unmutePlayback.

Mutes a given playback, denoted by its BpxAudioPlaybackId.

Pauses a given playback, denoted by its BpxAudioPlaybackId.

Resumes a given paused playback, denoted by its BpxAudioPlaybackId.

Start to play a given sound, once.

Start to play a given sound, looped.

Start to play a given sound, defined by a sequence of audio samples.

See

BpxSoundSequence

Completely stops a given playback, denoted by its BpxAudioPlaybackId.

Un-mutes the audio globally.

The global mute/unmute logic is independent from BeetPx.mutePlayback and BeetPx.unmutePlayback.

Un-mutes a given playback, denoted by its BpxAudioPlaybackId.

Retrieves a previously fetched image.

Usually, you wouldn't need to directly call this method, as the image retrieval happens under the hood for operations like sprite drawing.

See

BpxEngineConfig'a assets

Retrieves a previously fetched JSON.

Right now there is no API which would make use of the fetched JSON under the hood.

Example use case for this method is when you develop your game level in LDtk and want to read the level's file in the game code.

See

BpxEngineConfig'a assets

Retrieves a previously fetched sound.

Usually, you wouldn't need to directly call this method, as the sound retrieval happens under the hood for operations like music playing.

See

BpxEngineConfig'a assets

The type of a browser detected by the engine. It is tightly related to the gamepad mapping detection.

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/input-tester

A set of game input events captures since the last game loop iteration.

Typically you wouldn't need to use those this method unless dealing with custom even handling.

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/input-tester

Returns a 2D vector where:

• X=-1 means the up is pressed,
• X=0 means neither up nor down is pressed or both are pressed at the same time,
• X=1 means the down is pressed,
• Y=-1 means the left is pressed,
• Y=0 means neither left nor right is pressed or both are pressed at the same time,
• Y=1 means the right is pressed.

Example

this.position += $.getPressedDirection().mul(this.speed);
Copy

Tells what input methods were used in the last game loop iteration.

Might be used to render in-game indications what button to press, with their sprites chosen based on which input method was recently used.

Tells whether any of the game buttons is pressed right now.

See

For a list of available game buttons check BpxGameButtonName

Tells whether a given button is pressed right now.

Allows to enable repeating for a given button. Repeating means if the user presses the button for a longer timer, the "just pressed" state is detected first after firstRepeatFrames frames, then repetitively after loopedRepeatFrames frames.

Tells whether any of the game buttons changed from released to pressed in the recent game loop iteration.

See

For a list of available game buttons check BpxGameButtonName

Tells whether a given game button changed from released to pressed in the recent game loop iteration.

Tells whether a given game button changed from pressed to released in the recent game loop iteration.

Whether the game pause is active.

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/pause-and-restart

Pauses the game. This works only if BpxEngineConfig.gamePause's available is set to true.

The game pauses is by default toggled with the "menu" button, but this method allows you to add other ways of activating the pause.

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/pause-and-restart

Resumes the game. This works only if BpxEngineConfig.gamePause's available is set to true.

The game pauses is by default toggled with the "menu" button, but this method allows you to add other ways of deactivating the pause.

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/pause-and-restart

Whether the game pause was activated in the most recent game loop iteration. * *

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/pause-and-restart * *

Whether the game pause was deactivated in the most recent game loop iteration. * *

See

https://github.com/beetrootpaul/beetpx-examples/tree/main/pause-and-restart * *

Allows to completely remove the previously persisted data.

Allows to bring back the previously persisted data.

The stored data is kept in the localStorage. It means it will be there as long as you the same web browser (with the same user profile active) on the same machine, without clearing the website's data.

Allows to persist some data between separate game runs.

The stored data is kept in the localStorage. It means it will be there as long as you the same web browser (with the same user profile active) on the same machine, without clearing the website's data.

Tells whether it is possible to enter full screen on the current device and browser.

It might be used e.g. for implementing a pause menu action to toggle full screen.

Tells whether the game is currently in a full screen mode.

It might be used e.g. for implementing a pause menu action to toggle full screen.

Requests the game to either enter or exit the full screen mode.

It might be used e.g. for implementing a pause menu action to toggle full screen.

Prints to the console on the debug level, with use of console.debug. This one is run only in the debug mode.

You can implement BpxPrintDebug on a given object if you want it to be printed out in a custom way.

See

• BpxEngineConfig.debugMode
• BpxPrintDebug

Prints to the console on the error level, with use of console.error.

You can implement BpxPrintDebug on a given object if you want it to be printed out in a custom way.

See

BpxPrintDebug

Prints to the console on the info level, with use of console.info.

You can implement BpxPrintDebug on a given object if you want it to be printed out in a custom way.

See

BpxPrintDebug

Prints to the console on the warn level, with use of console.warn.

You can implement BpxPrintDebug on a given object if you want it to be printed out in a custom way.

See

BpxPrintDebug

Let's you know whether the debug mode is on or off. To be used in combination with:

• BpxEngineConfig's debugMode.available set to true
• ; key used to toggle the debug mode on/off