osbtools/src/storyboarding/sbAnimation.ts

A set of tools for working with osu! storyboards

import { ESbElementLoopType, ESbElementType } from "../types/enums";
import { TStoryboardElementAnimationData, TStoryboardElementData, TUnstrictStoryboardElementData } from "../types/types";
import SbSprite from "./sbSprite";

class SbAnimation extends SbSprite {
	type = ESbElementType.Animation;
	#frameCount: number = 0;
	#frameDelay: number = 0;
	#loopType?: string = ESbElementLoopType.LoopForever;

	constructor({
		path,
		layer,
		origin,
		defaultPosition,
		frameCount,
		frameDelay,
		loopType = ESbElementLoopType.LoopForever
	}: TUnstrictStoryboardElementData & TStoryboardElementAnimationData) {
		super({ path, layer, origin, defaultPosition });

		this.#frameCount = frameCount;
		this.#frameDelay = frameDelay;
		this.#loopType = loopType;
	}

	getFrameCount() {
		return this.#frameCount;
	}

	getFrameDelay() {
		return this.#frameDelay;
	}

	getLoopType() {
		return this.#loopType;
	}

	getTitle(data: TStoryboardElementData): string {
		const { layer, origin, path, defaultPosition } = data;

		return [
			this.type,
			layer,
			origin,
			`"${path}"`,
			defaultPosition.toString(),
			this.#frameCount,
			this.#frameDelay,
			this.#loopType
		].join(",");
	}
}

export default SbAnimation;