mwg API
    Preparing search index...

    Class ActorAnimator

    The convention AnimatedSprite and GridMover never had: standing still, moving, and performing an action are the only three states a character's animation is ever in, and an action is the only one of the three that interrupts the other two rather than being interrupted by them.

    setMoving toggles between idle and move freely, as often as every frame - a grid character's walk cycle calls it once per update. playAction cuts in over whichever of those is currently showing, plays once, and - because an action animation must be registered non-looping ({ loop: false }) for this to close the loop - hands control back to idle or move automatically the instant it finishes, picking up whichever setMoving calls arrived while it was playing rather than whatever was true when it started. A second playAction while one is already running is ignored unless restart is passed, so an attack animation is not stuttered by a turn resolving faster than its swing.

    This owns the sprite's onFinish hook entirely; a game driving one through ActorAnimator should not also set onFinish itself.

    import { ActorAnimator, AnimatedSprite, SpriteSheet } from '@datamoc/mw_games/two-d/render';

    declare const sheet: SpriteSheet;

    const hero = new AnimatedSprite();
    hero.add('idle-down', sheet.pick(0), { fps: 2 });
    hero.add('move-down', sheet.range(1, 4), { fps: 10 });
    hero.add('action-down', sheet.range(5, 7), { fps: 12, loop: false });

    const animator = new ActorAnimator(hero, {
    	animationName: (state, facing) => `${state}-${facing}`,
    	variant: 'down',
    });

    animator.setMoving(true); // walk cycle starts
    animator.playAction(); // an attack swing cuts in over the walk cycle
    console.log(animator.state); // 'action' - overrides idle/move while it plays
    Index
    constructor
    state variantName
    playAction setMoving

    • Plays an action animation once - an attack, a use-item flourish, a wave. Idle/move resumes automatically when it finishes.

      Parameters

      • Optionalvariant: string
      • restart: boolean = false

        replay from the first frame even if this action is already playing; without it, a second call while one is already running is a no-op

      Returns void

    • Standing still or moving, and which way. Has no effect while an action is playing - the request is remembered and taken up the moment it finishes.

      Parameters

      • moving: boolean
      • Optionalvariant: string

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods