fvtt-types

import type { ValueOf } from "#utils"; /** * A Tour that shows a series of guided steps. */ declare class Tour { /** * Construct a Tour by providing a configuration. * @param config - The configuration of the Tour * @param options - Additional options for configuring the tour (default: `{}`) */ constructor(config: Tour.Config, options?: Tour.ConstructorOptions); static STATUS: Tour.STATUS; /** * Indicates if a Tour is currently in progress. */ static get tourInProgress(): boolean; /** * Returns the active Tour, if any */ static get activeTour(): Tour | null; /** * Handle a movement action to either progress or regress the Tour * @param movementDirections - The Directions being moved in */ static onMovementAction(movementDirections: string[]): true | void; /** * Configuration of the tour. This object is cloned to avoid mutating the original configuration. */ config: Tour.Config; /** * The HTMLElement which is the focus of the current tour step. */ targetElement: HTMLElement | undefined | null; /** * The HTMLElement that fades out the rest of the screen */ fadeElement: HTMLElement | undefined; /** * The HTMLElement that blocks input while a Tour is active */ overlayElement: HTMLElement | undefined; /** * Padding around a Highlighted Element * @defaultValue `10` */ static HIGHLIGHT_PADDING: number; /** * The unique identifier of the tour */ get id(): string; set id(value: string); /** * The human-readable title for the tour. */ get title(): string; /** * The human-readable description of the tour. */ get description(): string | undefined; /** * The package namespace for the tour. */ get namespace(): string; set namespace(value: string); /** * The key the Tour is stored under in game.tours, of the form `${namespace}.${id}` */ get key(): string; /** * The configuration of tour steps */ get steps(): Tour.Step[]; /** * Return the current Step, or null if the tour has not yet started. */ get currentStep(): Tour.Step | null; /** * The index of the current step; -1 if the tour has not yet started, or null if the tour is finished. */ get stepIndex(): number | null; /** * Returns True if there is a next TourStep */ get hasNext(): boolean; /** * Returns True if there is a previous TourStep */ get hasPrevious(): boolean; /** * Return whether this Tour is currently eligible to be started? * This is useful for tours which can only be used in certain circumnstances, like if the canvas is active. */ get canStart(): boolean; /** * The current status of the Tour */ get status(): Tour.STATUS; /** * Advance the tour to a completed state. */ complete(): Promise<void>; /** * Exit the tour at the current step. */ exit(): void; /** * Reset the Tour to an un-started state. */ reset(): Promise<void>; /** * Start the Tour at its current step, or at the beginning if the tour has not yet started. */ start(): Promise<void>; /** * Progress the Tour to the next step. */ next(): Promise<void>; /** * Reward the Tour to the previous step. */ previous(): Promise<void>; /** * Progresses to a given Step * @param stepIndex - The step to progress to */ progress(stepIndex: number): Promise<void>; /** * Query the DOM for the target element using the provided selector * @param selector - A CSS selector * @returns The target element, or null if not found */ protected _getTargetElement(selector: string): Element | null; /** * Creates and returns a Tour by loading a JSON file * @param filepath - The path to the JSON file * @remarks Returns `new this()` so needs an override per subclass. */ static fromJSON(filepath: string): Promise<Tour>; /** * Set-up operations performed before a step is shown. * @abstract */ protected _preStep(): Promise<void>; /** * Clean-up operations performed after a step is completed. * @abstract */ protected _postStep(): Promise<void>; /** * Renders the current Step of the Tour */ protected _renderStep(): Promise<void>; /** * Reloads the Tour's current step from the saved progress * @internal */ _reloadProgress(): void; #tour: true; } declare namespace Tour { /** Tour configuration data */ interface Config { /** The namespace this Tour belongs to. Typically, the name of the package which implements the tour should be used */ namespace: string; /** A machine-friendly id of the Tour, must be unique within the provided namespace */ id: string; /** A human-readable name for this Tour. Localized. */ title: string; /** The list of Tour Steps */ steps: Tour.Step[]; /** A human-readable description of this Tour. Localized. */ description?: string | undefined; /** A map of localizations for the Tour that should be merged into the default localizations */ localization?: foundry.helpers.Localization.Translations | undefined; /** Whether the Tour is restricted to the GM only. Defaults to false. */ restricted?: boolean | undefined; /** Whether the Tour should be displayed in the Manage Tours UI. Defaults to false. */ display?: boolean | undefined; /** Whether the Tour can be resumed or if it always needs to start from the beginning. Defaults to false. */ canBeResumed?: boolean | undefined; /** A list of namespaced Tours that might be suggested to the user when this Tour is completed. The first non-completed Tour in the array will be recommended. */ suggestedNextTours?: string[] | undefined; } /** A step in a Tour */ interface Step { /** A machine-friendly id of the Tour Step */ id: string; /** The title of the step, displayed in the tooltip header */ title: string; /** Raw HTML content displayed during the step */ content: string; /** A DOM selector which denotes an element to highlight during this step. If omitted, the step is displayed in the center of the screen. */ selector?: string | undefined; /** How the tooltip for the step should be displayed relative to the target element. If omitted, the best direction will be attempted to be auto-selected. */ tooltipDirection?: foundry.helpers.interaction.TooltipManager.TOOLTIP_DIRECTIONS | undefined; /** Whether the Step is restricted to the GM only. Defaults to false. */ restricted?: boolean | undefined; /** Activates a particular sidebar tab. Usable in `SidebarTour` instances. */ sidebarTab?: string | undefined; /** Activates a particular canvas layer and its respective control group. Usable in `CanvasTour` instances */ layer?: string | undefined; /** Activates a particular tool. Usable in `CanvasTour` instances. */ tool?: string | undefined; } type Status = ValueOf<STATUS>; interface ConstructorOptions { /** A tour ID that supercedes `TourConfig#id` */ id: string; /** A tour namespace that supercedes `TourConfig#namespace` */ namespace: string; } interface STATUS { readonly UNSTARTED: "unstarted"; readonly IN_PROGRESS: "in-progress"; readonly COMPLETED: "completed"; } } export default Tour;