@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/tours/setup-tour.d.mts

TypeScript type definitions for Foundry VTT

import type { Tour } from "../core/tour.d.mts";

declare global {
  class SetupTour extends Tour {
    constructor(
      config: SetupTour.Config,
      { id, namespace }?: { id?: SetupTour.Config["id"]; namespace?: SetupTour.Config["namespace"] },
    );
    config: SetupTour.Config;

    focusedApp: Application.Any;
    override get canStart(): boolean;
    override get steps(): Tour.Step[];
    protected override _preStep(): Promise<void>;
    private _installingASystem(): Promise<void>;
    private _creatingAWorld(): Promise<void>;
  }

  namespace SetupTour {
    interface Config extends Tour.Config {
      /**
       * Whether to close all open windows before beginning the tour.
       * @defaultValue `true`
       */
      closeWindows: boolean;
    }
  }

  /** @deprecated {@link SetupTour.Config | `SetupTour.Config`} */
  type SetupTourConfig = SetupTour.Config;
}