@osbjs/osbjs/dist/Core/Storyboards/Storyboard.d.ts

a minimalist osu! storyboarding framework

import { Component } from '../Components';
import { IStoryboardLayers } from '../Interfaces';
export declare class Storyboard {
    path: string;
    filename: string;
    layers: IStoryboardLayers;
    constructor(filename: string, path?: string);
    protected _extractEachLayerOsbString(): {
        bg: string;
        fg: string;
        f: string;
        p: string;
        s: string;
        ov: string;
    };
    getOsbString(): string;
    protected _addToLayer(component: Component): void;
    /**
     * Register components to this storyboard. You can supply as many components as you want.
     * Note: later component will have higher z-index therefore it might appear on top of earlier components if their active time overlap.
     * @param components Component instances
     */
    registerComponents(...components: Component[]): void;
    /**
     * Generate storyboard. Call this after every component is registered.
     */
    generate(): void;
}