@osbjs/osbjs/dist/PrebuiltComponents/Background.d.ts

a minimalist osu! storyboarding framework

import { Component } from '../Core';
import { IBackgroundOptions } from './Interfaces';
export declare class Background extends Component {
    name: string;
    startTime: number;
    endTime: number;
    osbPath: string;
    folderPath: string;
    options: {
        opacity: number;
        fadeDuration: number;
    };
    /**
     * Set background between start and end time.
     * @param osbPath relative path to image file.
     * For example, if you have a folder named `sb` inside your beatmap folder and your `image.jpg` is in it, then it should be `sb/image.jpg`
     * @param folderPath full path to beatmap folder.
     * @param startTime times in milliseconds/timestamp indicate when the image will be shown.
     * @param endTime times in milliseconds/timestamp indicate when the image will be shown.
     * @param options Additional options.
     */
    constructor(osbPath: string, folderPath: string, startTime: number | string, endTime: number | string, options?: IBackgroundOptions);
    generate(): void;
}