Class BpxAnimatedSprite

A definition of an animated sprite, which can later be used (indirectly) for drawing by BeetPxDraw.sprite.

It has a form of a collection sprites, originated from the same sprite sheet.

Example

let myAnimation: BpxAnimatedSprite;

$.setOnStarted(() => {
  myAnimation = $aspr("spritesheet.png")(8, 8, [
    [0,0],
    [8,0],
    [16,0],
  ]);
});

$d.setOnDraw(() => {
  $d.sprite(myAnimation.current, $v(10));
});

Remarks

Under the hood this class uses BpxTimer to integrate the animation progression with the game loop.

See

$aspr

Static factories

from

Accessors

current

Methods

pause restart resume

Properties

imageUrl size type

Static factories

Staticfrom

  • from(imageUrl, w, h, xys, opts?): BpxAnimatedSprite

  • Parameters

    • imageUrl: string
    • w: number
    • h: number
    • xys: [x: number, y: number][]
    • Optionalopts: {
          frameDuration?: number;
          onGamePause?: "pause" | "ignore";
          paused?: boolean;
      }
      • OptionalframeDuration?: number
      • OptionalonGamePause?: "pause" | "ignore"
      • Optionalpaused?: boolean

    Returns BpxAnimatedSprite

    See

    $aspr

Accessors

current

Methods

pause

restart

resume

Properties

ReadonlyimageUrl

imageUrl: string

Readonlysize

size: BpxVector2d

Readonlytype

type: "animated" = "animated"

A property helpful for TypeScript type inference, when distinguishing from other types of sprites.

Example

const s: BpxSprite | BpxAnimatedSprite = getSprite();
if (s.type === "static") {
  // s is BpxSprite here
} else if (s.type === "animated") {
  // s is BpxAnimatedSprite here
} else {
  $u.assertUnreachable(s);
}

Settings

On This Page

Static factories
Accessors
Methods
Properties