fvtt-types/src/foundry/client/applications/hud/tile-hud.d.mts

TypeScript type definitions for Foundry VTT

import type BasePlaceableHUD from "./placeable-hud.d.mts";
import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
import type { Identity } from "#utils";
import type { Tile } from "#client/canvas/placeables/_module.d.mts";

declare module "#configuration" {
  namespace Hooks {
    interface ApplicationV2Config {
      TileHUD: TileHUD.Any;
    }
  }
}

/**
 * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects.
 * The TileHUD implementation can be configured and replaced via {@link CONFIG.Tile.hudClass}.
 * @remarks TODO: Stub
 */
declare class TileHUD<
  RenderContext extends TileHUD.RenderContext = TileHUD.RenderContext,
  Configuration extends TileHUD.Configuration = TileHUD.Configuration,
  RenderOptions extends TileHUD.RenderOptions = TileHUD.RenderOptions,
> extends HandlebarsApplicationMixin(BasePlaceableHUD)<
  Tile.Implementation,
  RenderContext,
  Configuration,
  RenderOptions
> {}

declare namespace TileHUD {
  interface Any extends AnyTileHUD {}
  interface AnyConstructor extends Identity<typeof AnyTileHUD> {}

  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, BasePlaceableHUD.RenderContext {}
  interface Configuration extends HandlebarsApplicationMixin.Configuration, BasePlaceableHUD.Configuration {}
  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, BasePlaceableHUD.RenderOptions {}
}

declare abstract class AnyTileHUD extends TileHUD<TileHUD.RenderContext, TileHUD.Configuration, TileHUD.RenderOptions> {
  constructor(...args: never);
}

export default TileHUD;