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

a minimalist osu! storyboarding framework

import { Component } from '../Core';
import { Beatmap, Circle, Slider } from '../Beatmap';
import { IHitObjectHighlightOptions } from './Interfaces';
export declare class HitObjectHighlight extends Component {
    name: string;
    osbPath: string;
    startTime: number;
    endTime: number;
    beatmap: Beatmap;
    circles: Circle[];
    sliders: Slider[];
    beat: number;
    options: {
        startScale: number;
        endScale: number;
        fadeDuration: number;
        beatDivisor: number;
        followSliderPath: boolean;
    };
    /**
     * Highlight every objects inbetween 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 `hl.png` is in it, then it should be `sb/hl.png`
     * @param startTime times in milliseconds/timestamp indicate the start time of the section you want to highlight.
     * @param endTime times in milliseconds/timestamp indicate the end time of the section you want to highlight.
     * @param beatmap `Beatmap` instance of difficulty you want to use
     * @param options Additional options.
     */
    constructor(osbPath: string, startTime: number | string, endTime: number | string, beatmap: Beatmap, options?: IHitObjectHighlightOptions);
    generate(): void;
}