@rbxts/tutorial-ui-highlight/out/TutorialUiHightlight.d.ts

A React-based tutorial UI highlighting system for Roblox TypeScript projects. Create interactive tutorials with customizable overlay highlighting and step-by-step guidance.

import React from "@rbxts/react";
export declare namespace TutorialUiHightlight {
    interface IStepData {
        BgColor3: Color3;
        BgTransparency: number;
        CanClickCenter: boolean;
    }
    interface IPartData {
        Position: UDim2;
        Size: UDim2;
        AnchorPoint: Vector2;
    }
    interface IPartsData {
        TopLeft: IPartData;
        Top: IPartData;
        TopRight: IPartData;
        Right: IPartData;
        BottomRight: IPartData;
        Bottom: IPartData;
        BottomLeft: IPartData;
        Left: IPartData;
        Center: IPartData;
    }
    function ReportGuiInstance(instance: GuiBase2d, id: string): void;
    function RemoveGuiInstance(id: string): void;
    function Resolve(id: string): void;
    function IsTutorialActive(): boolean;
    /**Atom subscribable version of IsTutorialActive */
    function IsTutorialActiveAtom(): boolean;
    function SetGlobalConfig(config: IStepData): void;
    function SetStepConfig(step: string, config: IStepData): void;
    function SetTutorial(steps: string[]): void;
    function StopTutorial(): void;
    function GetStepConfig(step?: string): IStepData;
    function useCurrentTutorialStep(): string | undefined;
    function useIsTutorialActive(): boolean;
    function useGuiBounds(id?: string): Rect;
    function useParts(gui_bounds: Rect): IPartsData;
    function useReportUiRectRef<T extends GuiBase2d = GuiBase2d>(id: string, ref?: React.MutableRefObject<T | undefined>): (v?: T) => void;
}