bard-legends-framework 0.10.9 → 0.12.0

package/dist/utilities/animator/state-animation/slide-state-animation.test.js

@@ -0,0 +1,301 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const game_entities_1 = require("../../../game-entities");
+const animations_1 = require("../animations");
+const slide_state_animation_1 = require("./slide-state-animation");
+(0, vitest_1.describe)('SlideStateAnimation', () => {
+    let stateAnimation;
+    let heap = [];
+    (0, vitest_1.beforeEach)(async () => {
+        if (stateAnimation) {
+            stateAnimation.destroy();
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+        }
+        heap = [];
+        stateAnimation = new slide_state_animation_1.SlideStateAnimation({ duration: 4, animation: new animations_1.AnimationLineer() })
+            .onStateChange((state, index) => heap.push({ state, index }))
+            .onValueChange((value, index) => heap.push({ value, index }))
+            .attachToRoot();
+    });
+    (0, vitest_1.describe)('Creation', () => {
+        (0, vitest_1.test)('initial values', () => {
+            (0, vitest_1.expect)(stateAnimation).toBeDefined();
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+        (0, vitest_1.test)('initial state default', () => {
+            stateAnimation.setIndex(0);
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 0 },
+                { value: 0, index: 0 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+        (0, vitest_1.test)('initial state instant', () => {
+            stateAnimation.setIndex(0, { instant: true });
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 0 },
+                { value: 0, index: 0 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+        (0, vitest_1.test)('setting same index', () => {
+            stateAnimation.setIndex(0);
+            heap = [];
+            stateAnimation.setIndex(0);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+    });
+    (0, vitest_1.describe)('Slide Next', () => {
+        (0, vitest_1.beforeEach)(() => {
+            stateAnimation.setIndex(0);
+            heap = [];
+            stateAnimation.setIndex(1);
+        });
+        (0, vitest_1.test)('initial state', () => {
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 1 },
+                { value: 1, index: 1 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+        (0, vitest_1.test)('during the animation', async () => {
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.25, index: 0 },
+                { value: 0.75, index: 1 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+        (0, vitest_1.test)('end of the animation', async () => {
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(3);
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 0 },
+                { value: 0, index: 1 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+        (0, vitest_1.test)('animating again', async () => {
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            heap = [];
+            stateAnimation.setIndex(2);
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 2 },
+                { value: 1, index: 2 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+        (0, vitest_1.test)('setting same index', async () => {
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            heap = [];
+            stateAnimation.setIndex(1);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+    });
+    (0, vitest_1.describe)('Slide Previous', () => {
+        (0, vitest_1.beforeEach)(() => {
+            stateAnimation.setIndex(1);
+            heap = [];
+            stateAnimation.setIndex(0);
+        });
+        (0, vitest_1.test)('initial state', () => {
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 0 },
+                { value: -1, index: 0 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+        (0, vitest_1.test)('during the animation', async () => {
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 0 },
+                { value: -1, index: 0 },
+                { value: 0.25, index: 1 },
+                { value: -0.75, index: 0 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+        });
+        (0, vitest_1.test)('end of the animation', async () => {
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(3);
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 1 },
+                { value: 0, index: 0 }
+            ]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+        });
+    });
+    (0, vitest_1.describe)('Reverting', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setIndex(0);
+        });
+        (0, vitest_1.test)('forward reverting', async () => {
+            stateAnimation.setIndex(1);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setIndex(0);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.25, index: 0 },
+                { value: 0.75, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 1 },
+                { value: 0, index: 0 }
+            ]);
+        });
+        (0, vitest_1.test)('backward reverting', async () => {
+            stateAnimation.setIndex(-1);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setIndex(0);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: 0.25, index: 0 },
+                { value: -0.75, index: -1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: -1 },
+                { value: 0, index: 0 }
+            ]);
+        });
+        (0, vitest_1.test)('re-reverting', async () => {
+            stateAnimation.setIndex(1);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setIndex(0);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.25, index: 0 },
+                { value: 0.75, index: 1 }
+            ]);
+            heap = [];
+            stateAnimation.setIndex(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.75, index: 0 },
+                { value: 0.25, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 0 },
+                { value: 0, index: 1 }
+            ]);
+        });
+        (0, vitest_1.test)('setting same index', async () => {
+            stateAnimation.setIndex(1);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setIndex(0);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            heap = [];
+            stateAnimation.setIndex(0);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+        });
+    });
+    (0, vitest_1.describe)('Re-targeting', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setIndex(0);
+            stateAnimation.setIndex(2);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+        });
+        (0, vitest_1.test)('changing target in transitioning', async () => {
+            stateAnimation.setIndex(1);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.75, index: 0 },
+                { value: 0.25, index: 2 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 0 },
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 1 },
+                { value: 0, index: 2 },
+                { value: -1, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: 0.25, index: 2 },
+                { value: -0.75, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(3);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 2 },
+                { value: 0, index: 1 }
+            ]);
+        });
+        (0, vitest_1.test)('changing target in reverting', async () => {
+            stateAnimation.setIndex(0);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            heap = [];
+            stateAnimation.setIndex(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('reverting');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 2 },
+                { state: slide_state_animation_1.SlideStateAnimationState.appear, index: 1 },
+                { value: 0, index: 0 },
+                { value: 1, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('transitioning');
+            (0, vitest_1.expect)(heap).toEqual([
+                { value: -0.25, index: 0 },
+                { value: 0.75, index: 1 }
+            ]);
+            heap = [];
+            game_entities_1.UpdateCycle.triggerUpdateTick(3);
+            (0, vitest_1.expect)(stateAnimation['stateAnimation']['animationState']).toBe('idle');
+            (0, vitest_1.expect)(heap).toEqual([
+                { state: slide_state_animation_1.SlideStateAnimationState.disappear, index: 0 },
+                { value: 0, index: 1 }
+            ]);
+        });
+    });
+    (0, vitest_1.describe)('Error Cases:', () => {
+        (0, vitest_1.test)('index must be an integer', async () => {
+            (0, vitest_1.expect)(() => stateAnimation.setIndex(0.25)).toThrowError('SlideStateAnimation: index must be an integer!');
+        });
+    });
+});
+//# sourceMappingURL=slide-state-animation.test.js.map

package/dist/utilities/animator/state-animation/state-animation.d.ts

@@ -0,0 +1,33 @@
+import { Attachable } from 'actions-lib';
+import { AnimatorAnimation } from '../animations';
+export interface StateAnimationOptions {
+    readonly duration: number;
+    readonly animation: AnimatorAnimation;
+}
+type AnimationState = 'idle' | 'transitioning' | 'reverting';
+export declare class StateAnimation<T> extends Attachable {
+    private animator;
+    private options;
+    private value;
+    private state;
+    private nextState;
+    private queuedState;
+    private animationState;
+    get currentState(): {
+        value: number;
+        state: T | undefined;
+        nextState: T | undefined;
+        queuedState: T | undefined;
+        animationState: AnimationState;
+    };
+    constructor(partialOptions?: Partial<StateAnimationOptions>);
+    setState(state: T, options?: {
+        instant?: boolean;
+    }): void;
+    private onComplete;
+    private onStateChangeAction;
+    private onValueChangeAction;
+    onStateChange(callback: (state: T, nextState?: T) => void): this;
+    onValueChange(callback: (value: number) => void): this;
+}
+export {};

package/dist/utilities/animator/state-animation/state-animation.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateAnimation = void 0;
+const actions_lib_1 = require("actions-lib");
+const animations_1 = require("../animations");
+const animator_1 = require("../animator/animator");
+class StateAnimation extends actions_lib_1.Attachable {
+    get currentState() {
+        return {
+            value: this.value,
+            state: this.state,
+            nextState: this.nextState,
+            queuedState: this.queuedState,
+            animationState: this.animationState
+        };
+    }
+    constructor(partialOptions) {
+        super();
+        this.animationState = 'idle';
+        this.onStateChangeAction = new actions_lib_1.Action();
+        this.onValueChangeAction = new actions_lib_1.Action();
+        this.options = { duration: 500, animation: animations_1.Animations.lineer, ...partialOptions };
+        this.value = 0;
+        this.animator = new animator_1.Animator(this, 'value', {
+            duration: this.options.duration,
+            animation: this.options.animation,
+            reAnimateHandling: animator_1.ReAnimateHandlingType.completePrevious,
+            completeAnimationsHandling: animator_1.CompleteAnimationsHandlingType.stayInCurrentState
+        })
+            .onComplete((key, value) => this.onComplete(value))
+            .onChange(() => {
+            this.value = this.value === 1 ? 0 : this.value;
+            this.onValueChangeAction.trigger(this.value);
+        })
+            .attach(this);
+    }
+    setState(state, options) {
+        if (this.state === undefined) {
+            this.state = state;
+            this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+            this.onValueChangeAction.trigger(this.value);
+        }
+        else if (options?.instant) {
+            this.animator.completeAnimations();
+            this.animationState = 'idle';
+            this.state = state;
+            this.nextState = undefined;
+            this.value = 0;
+            this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+            this.onValueChangeAction.trigger(this.value);
+        }
+        else {
+            switch (this.animationState) {
+                case 'idle':
+                    if (state !== this.state) {
+                        this.animationState = 'transitioning';
+                        this.nextState = state;
+                        this.value = 0;
+                        this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+                        this.onValueChangeAction.trigger(this.value);
+                        this.animator.animate({ value: 1 }).attachToRoot(); // TODO
+                    }
+                    break;
+                case 'transitioning':
+                    if (state !== this.nextState) {
+                        if (state === this.state) {
+                            this.animationState = 'reverting';
+                            this.animator.animate({ value: 0 }, { duration: this.value * this.options.duration }).attachToRoot(); // TODO
+                        }
+                        else {
+                            this.queuedState = state;
+                        }
+                    }
+                    break;
+                case 'reverting':
+                    if (state !== this.state) {
+                        if (state === this.nextState) {
+                            this.animationState = 'transitioning';
+                            this.animator.animate({ value: 1 }, { duration: (1 - this.value) * this.options.duration }).attachToRoot(); // TODO
+                        }
+                        else {
+                            this.queuedState = state;
+                        }
+                    }
+                    break;
+            }
+        }
+    }
+    onComplete(value) {
+        switch (this.animationState) {
+            case 'transitioning':
+                if (value === 1) {
+                    if (this.queuedState !== undefined) {
+                        this.animationState = 'transitioning';
+                        this.state = this.nextState;
+                        this.nextState = this.queuedState;
+                        this.queuedState = undefined;
+                        this.value = 0;
+                        this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+                        this.animator.animate({ value: 1 }).attachToRoot(); // TODO
+                    }
+                    else {
+                        this.animationState = 'idle';
+                        this.state = this.nextState;
+                        this.nextState = undefined;
+                        this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+                    }
+                }
+                break;
+            case 'reverting':
+                if (this.state === undefined) {
+                    throw new Error('StateAnimation: state must be defined when reverting!');
+                }
+                if (value === 0) {
+                    if (this.queuedState !== undefined) {
+                        this.animationState = 'transitioning';
+                        this.nextState = this.queuedState;
+                        this.queuedState = undefined;
+                        this.value = 0;
+                        this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+                        this.animator.animate({ value: 1 }).attachToRoot(); // TODO
+                    }
+                    else {
+                        this.animationState = 'idle';
+                        this.nextState = undefined;
+                        this.value = 0;
+                        this.onStateChangeAction.trigger({ state: this.state, nextState: this.nextState });
+                    }
+                }
+                break;
+            case 'idle':
+                // Do nothing
+                break;
+        }
+    }
+    onStateChange(callback) {
+        this.onStateChangeAction.subscribe(value => callback(value.state, value.nextState)).attach(this);
+        return this;
+    }
+    onValueChange(callback) {
+        this.onValueChangeAction.subscribe(value => callback(value)).attach(this);
+        return this;
+    }
+}
+exports.StateAnimation = StateAnimation;
+//# sourceMappingURL=state-animation.js.map

package/dist/utilities/animator/state-animation/state-animation.test.d.ts

@@ -0,0 +1 @@
+export {};