← All Docs

Animation Documentation

Animation Documentation Source Code

These functions are helper functions for handling tilebased animations in BeepMini. They are used by the Actors and Vfx systems to manage and render animations based on delta time.

Animation Methods

b8.Animation.frame(animation, startTime)

Get the current frame of an animation. This is used internally to automatically determine what frame to draw. This uses delta time to determine the current frame.

Parameters

  • animation (string): The animation to get the frame for.
  • startTime (number|null): The start time of the animation. If null, uses the core start time.

Returns

  • (number): The frame to draw for the animation.

b8.Animation.get(animation)

Get animation by id.

Parameters

  • animation (string): The animation id.

Returns

  • (Object|undefined): The animation object, or undefined if not found.

b8.Animation.shouldLoop(anim, startTime)

Checks if the animation has finished looping.

Parameters

  • anim (Object): The animation object.
  • startTime (number): The start time of the animation.

Returns

  • (boolean): - Returns true if the animation should continue, false if it has finished looping.

More BeepMini Docs

A* Documentation

Actors Documentation

Animation Documentation

App Intro Documentation

Async Documentation

Cart API

Core Functions

ECS (Entity Component System) Documentation

Game Math Documentation

Game State

Image Processing

Input Documentation

Inventory API

Joystick Documentation

Menu Documentation

Music Documentation

Particle System Documentation

Passcodes Documentation

Path Documentation

Public API

Random Numbers Documentation

SFX Documentation

Scene Documentation

Text Renderer

Textmode

Tilemap Documentation

Utilities Documentation

Visual Effects Documentation

B8:// Make BeepMini Games