@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.1-beta

package/src/foundry/client/data/documents/combat.d.mts

@@ -0,0 +1,315 @@
+import type { ConstructorOf, InexactPartial } from "../../../../types/utils.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
+
+declare global {
+  namespace Combat {
+    type ConfiguredClass = Document.ConfiguredClassForName<"Combat">;
+    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Combat">;
+
+    /* eslint-disable @typescript-eslint/no-empty-object-type */
+    interface DatabaseOperations
+      extends DocumentDatabaseOperations<
+        Combat,
+        {},
+        { direction: -1 | 1; worldTime: { delta: number }; turnEvents: boolean },
+        {}
+      > {}
+    /* eslint-enable @typescript-eslint/no-empty-object-type */
+
+    interface InitiativeOptions {
+      /**
+       * A non-default initiative formula to roll. Otherwise the system default is used.
+       * @defaultValue `null`
+       */
+      formula?: string | null;
+
+      /**
+       * Update the Combat turn after adding new initiative scores to keep the turn on the same Combatant.
+       * @defaultValue `true`
+       */
+      updateTurn?: boolean;
+
+      /**
+       * Additional options with which to customize created Chat Messages
+       * @defaultValue `{}`
+       */
+      messageOptions?: foundry.documents.BaseChatMessage.ConstructorData;
+    }
+
+    interface HistoryData {
+      round: number | null;
+      turn: number | null;
+      tokenId: string | null;
+      combatantId: string | null;
+    }
+
+    type CONFIG_SETTING = "combatTrackerConfig";
+  }
+
+  /**
+   * The client-side Combat document which extends the common BaseCombat model.
+   *
+   * @see {@link Combats}                       The world-level collection of Combat documents
+   * @see {@link Combatant}                     The Combatant embedded document which exists within a Combat document
+   * @see {@link CombatConfig}                  The Combat configuration application
+   */
+  class Combat extends ClientDocumentMixin(foundry.documents.BaseCombat) {
+    /**
+     * @param data - Initial data provided to construct the Combat document
+     */
+    constructor(
+      data?: ConstructorParameters<ConstructorOf<foundry.documents.BaseCombat>>[0],
+      context?: ConstructorParameters<ConstructorOf<foundry.documents.BaseCombat>>[1],
+    );
+
+    /** Track the sorted turn order of this combat encounter */
+    turns: Combatant.ConfiguredInstance[];
+
+    /** Record the current round, turn, and tokenId to understand changes in the encounter state */
+    current: Combat.HistoryData;
+
+    /** Track the previous round, turn, and tokenId to understand changes in the encounter state */
+    previous: Combat.HistoryData;
+
+    /**
+     * The configuration setting used to record Combat preferences
+     * Default: `"combatTrackerConfig"`
+     */
+    static CONFIG_SETTING: string;
+
+    /** Get the Combatant who has the current turn. */
+    get combatant(): this["turns"][number] | undefined;
+
+    /**
+     * Get the Combatant who has the next turn.
+     */
+    get nextCombatant(): Combatant.ConfiguredInstance | undefined;
+
+    /** Return the object of settings which modify the Combat Tracker behavior */
+    // Type is copied here to avoid recursion issue
+    get settings(): ClientSettings.SettingInitializedType<"core", Combat.CONFIG_SETTING>;
+
+    /** Has this combat encounter been started? */
+    get started(): boolean;
+
+    get visible(): true;
+
+    /** Is this combat active in the current scene? */
+    get isActive(): boolean;
+
+    /**
+     * Set the current Combat encounter as active within the Scene.
+     * Deactivate all other Combat encounters within the viewed Scene and set this one as active
+     * @param options - Additional context to customize the update workflow
+     */
+    activate(options?: Document.OnUpdateOptions<"Combat">): Promise<Combat.ConfiguredInstance[]>;
+
+    override prepareDerivedData(): void;
+
+    /**
+     * Get a Combatant using its Token id
+     * @param token - A Token ID or a TokenDocument instance
+     * @returns An array of Combatants which represent the Token.
+     */
+    getCombatantsByToken(token: string | TokenDocument): Combatant.ConfiguredInstance[];
+
+    /**
+     * Get a Combatant that represents the given Actor or Actor ID.
+     * @param actorOrId - An Actor ID or an Actor instance.
+     */
+    getCombatantsByActor(actorOrId: string | Actor): Combatant.ConfiguredInstance[];
+
+    /** Begin the combat encounter, advancing to round 1 and turn 1 */
+    startCombat(): Promise<this>;
+
+    /** Advance the combat to the next round */
+    nextRound(): Promise<this>;
+
+    /** Rewind the combat to the previous round */
+    previousRound(): Promise<this>;
+
+    /** Advance the combat to the next turn */
+    nextTurn(): Promise<this>;
+
+    /** Rewind the combat to the previous turn */
+    previousTurn(): Promise<this>;
+
+    /** Display a dialog querying the GM whether they wish to end the combat encounter and empty the tracker */
+    endCombat(): Promise<this>;
+
+    /** Toggle whether this combat is linked to the scene or globally available. */
+    toggleSceneLink(): Promise<this>;
+
+    /** Reset all combatant initiative scores, setting the turn back to zero */
+    resetAll(): Promise<this>;
+
+    /**
+     * Roll initiative for one or multiple Combatants within the Combat document
+     * @param ids     - A Combatant id or Array of ids for which to roll
+     * @param options - Additional options which modify how initiative rolls are created or presented.
+     *                  default `{}`
+     * @returns A promise which resolves to the updated Combat document once updates are complete.
+     */
+    rollInitiative(ids: string | string[], options?: Combat.InitiativeOptions): Promise<this>;
+
+    /**
+     * Roll initiative for all combatants which have not already rolled
+     * @param options - Additional options forwarded to the Combat.rollInitiative method
+     *                  default `{}`
+     */
+    rollAll(options?: Combat.InitiativeOptions): Promise<this>;
+
+    /**
+     * Roll initiative for all non-player actors who have not already rolled
+     * @param options - Additional options forwarded to the Combat.rollInitiative method
+     *                  default `{}`
+     */
+    rollNPC(options?: Combat.InitiativeOptions): Promise<this>;
+
+    /**
+     * Assign initiative for a single Combatant within the Combat encounter.
+     * Update the Combat turn order to maintain the same combatant as the current turn.
+     * @param id    - The combatant ID for which to set initiative
+     * @param value - A specific initiative value to set
+     */
+    setInitiative(id: string, value: number): Promise<void>;
+
+    /** Return the Array of combatants sorted into initiative order, breaking ties alphabetically by name. */
+    setupTurns(): this["turns"];
+
+    /**
+     * Debounce changes to the composition of the Combat encounter to de-duplicate multiple concurrent Combatant changes.
+     * If this is the currently viewed encounter, re-render the CombatTracker application.
+     */
+    debounceSetup: () => ReturnType<typeof foundry.utils.debounce>;
+
+    /**
+     * Update active effect durations for all actors present in this Combat encounter.
+     */
+    updateCombatantActors(): void;
+
+    /**
+     * Loads the registered Combat Theme (if any) and plays the requested type of sound.
+
+   * If multiple exist for that type, one is chosen at random.
+     * @param announcement - The announcement that should be played: "startEncounter", "nextUp", or "yourTurn".
+     */
+    protected _playCombatSound(announcement: foundry.CONST.COMBAT_ANNOUNCEMENTS): void;
+
+    /**
+     * Define how the array of Combatants is sorted in the displayed list of the tracker.
+     * This method can be overridden by a system or module which needs to display combatants in an alternative order.
+     * By default sort by initiative, next falling back to name, lastly tie-breaking by combatant id.
+     * @internal
+     */
+    protected _sortCombatants(a: Combatant.ConfiguredInstance, b: Combatant.ConfiguredInstance): number;
+
+    /**
+     * Refresh the Token HUD under certain circumstances.
+     * @param documents - A list of Combatant documents that were added or removed.
+     */
+    protected _refreshTokenHUD(documents: Array<Combatant>): void;
+
+    /**
+     * @privateRemarks _onCreate, _onUpdate, and _onDelete  are all overridden but with no signature changes.
+     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
+     */
+
+    protected override _onCreateDescendantDocuments(
+      parent: ClientDocument,
+      collection: string,
+      documents: ClientDocument[],
+      result: unknown[],
+      options: Document.OnCreateOptions<"Combatant"> & InexactPartial<{ combatTurn: number; turnEvents: boolean }>,
+      userId: string,
+    ): void;
+
+    protected override _onUpdateDescendantDocuments(
+      parent: ClientDocument,
+      collection: string,
+      documents: ClientDocument[],
+      changes: unknown[],
+      options: Document.OnUpdateOptions<"Combatant"> & InexactPartial<{ combatTurn: number; turnEvents: boolean }>,
+      userId: string,
+    ): void;
+
+    protected override _onDeleteDescendantDocuments(
+      parent: ClientDocument,
+      collection: string,
+      documents: ClientDocument[],
+      ids: string,
+      options: Document.OnDeleteOptions<"Combatant"> & InexactPartial<{ combatTurn: number; turnEvents: boolean }>,
+      userId: string,
+    ): void;
+
+    #onModifyCombatants();
+
+    /**
+     * Get the current history state of the Combat encounter.
+     * @param combatant - The new active combatant
+     */
+    protected _getCurrentState(combatant: Combatant): Combat.HistoryData;
+
+    /**
+     * Manage the execution of Combat lifecycle events.
+     * This method orchestrates the execution of four events in the following order, as applicable:
+     * 1. End Turn
+     * 2. End Round
+     * 3. Begin Round
+     * 4. Begin Turn
+     * Each lifecycle event is an async method, and each is awaited before proceeding.
+     * @param adjustedTurn - Optionally, an adjusted turn to commit to the Combat.
+     */
+    protected _manageTurnEvents(adjustedTurn: number): Promise<void>;
+
+    /**
+     * A workflow that occurs at the end of each Combat Turn.
+     * This workflow occurs after the Combat document update, prior round information exists in this.previous.
+     * This can be overridden to implement system-specific combat tracking behaviors.
+     * This method only executes for one designated GM user. If no GM users are present this method will not be called.
+     * @param combatant - The Combatant whose turn just ended
+     */
+    protected _onEndTurn(combatant: Combatant): Promise<void>;
+
+    /**
+     * A workflow that occurs at the end of each Combat Round.
+     * This workflow occurs after the Combat document update, prior round information exists in this.previous.
+     * This can be overridden to implement system-specific combat tracking behaviors.
+     * This method only executes for one designated GM user. If no GM users are present this method will not be called.
+     */
+    protected _onEndRound(): Promise<void>;
+
+    /**
+     * A workflow that occurs at the start of each Combat Round.
+     * This workflow occurs after the Combat document update, new round information exists in this.current.
+     * This can be overridden to implement system-specific combat tracking behaviors.
+     * This method only executes for one designated GM user. If no GM users are present this method will not be called.
+     */
+    protected _onStartRound(): Promise<void>;
+
+    /**
+     * A workflow that occurs at the start of each Combat Turn.
+     * This workflow occurs after the Combat document update, new turn information exists in this.current.
+     * This can be overridden to implement system-specific combat tracking behaviors.
+     * This method only executes for one designated GM user. If no GM users are present this method will not be called.
+     * @param combatant - The Combatant whose turn just started
+     */
+    protected _onStartTurn(combatant: Combatant): Promise<void>;
+
+    /**
+     * @deprecated Since v11 until v13. Use {@link Combat#updateCombatantActors} instead.
+     */
+    updateEffectDurations(): void;
+
+    /**
+     * @deprecated Since v12. Use {@link Combat#getCombatantsByActor} instead.
+     */
+    getCombatantByActor(actor: Actor): Combatant[];
+
+    /**
+     * @deprecated Since v12. Use {@link Combat#getCombatantsByActor} instead.
+     */
+    getCombatantByToken(token: Token): Combatant[];
+  }
+}

package/src/foundry/client/data/documents/combatant.d.mts

@@ -0,0 +1,90 @@
+import type Document from "../../../common/abstract/document.d.mts";
+import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
+
+declare global {
+  namespace Combatant {
+    type ConfiguredClass = Document.ConfiguredClassForName<"Combatant">;
+    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Combatant">;
+
+    interface DatabaseOperations extends DocumentDatabaseOperations<Combatant> {}
+  }
+
+  /**
+   * The client-side Combatant document which extends the common BaseCombatant model.
+   *
+   * @see {@link Combat}                    The Combat document which contains Combatant embedded documents
+   * @see {@link CombatantConfig}        The Combatant configuration application
+   */
+  class Combatant extends ClientDocumentMixin(foundry.documents.BaseCombatant) {
+    /**
+     * The token video source image (if any)
+     */
+    _videoSrc: string | null;
+
+    /** The current value of the special tracked resource which pertains to this Combatant */
+    resource: `${number}` | number | boolean | null;
+
+    /**
+     * A convenience alias of Combatant#parent which is more semantically intuitive
+     */
+    get combat(): Combat.ConfiguredInstance | null;
+
+    /** This is treated as a non-player combatant if it has no associated actor and no player users who can control it */
+    get isNPC(): boolean;
+
+    override get visible(): boolean;
+
+    /** A reference to the Actor document which this Combatant represents, if any */
+    get actor(): Actor.ConfiguredInstance | null;
+
+    /** A reference to the Token document which this Combatant represents, if any */
+    get token(): TokenDocument.ConfiguredInstance | null;
+
+    /** An array of User documents who have ownership of this Document */
+    get players(): User.ConfiguredInstance[];
+
+    /**
+     * Has this combatant been marked as defeated?
+     */
+    get isDefeated(): boolean;
+
+    override testUserPermission(
+      user: foundry.documents.BaseUser,
+      permission: keyof typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
+      { exact }?: { exact?: boolean },
+    ): boolean;
+
+    /**
+     * Get a Roll object which represents the initiative roll for this Combatant.
+     * @param formula -  An explicit Roll formula to use for the combatant.
+     * @returns The Roll instance to use for the combatant.
+     */
+    getInitiativeRoll(formula?: string): Roll;
+
+    /**
+     * Roll initiative for this particular combatant.
+     * @param formula - A dice formula which overrides the default for this Combatant.
+     * @returns The updated Combatant.
+     */
+    rollInitiative(formula: string): Promise<this | undefined>;
+
+    override prepareDerivedData(): void;
+
+    /**
+     * Update the value of the tracked resource for this Combatant.
+     */
+    updateResource(): this["resource"];
+
+    /**
+     * Acquire the default dice formula which should be used to roll initiative for this combatant.
+     * Modules or systems could choose to override or extend this to accommodate special situations.
+     * @returns  The initiative formula to use for this combatant.
+     */
+    protected _getInitiativeFormula(): string;
+
+    /**
+     * @deprecated since v9
+     */
+    get isVisible(): boolean;
+  }
+}

package/src/foundry/client/data/documents/drawing.d.mts

@@ -0,0 +1,24 @@
+import type Document from "../../../common/abstract/document.d.mts";
+import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
+
+declare global {
+  namespace DrawingDocument {
+    type ConfiguredClass = Document.ConfiguredClassForName<"Drawing">;
+    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Drawing">;
+
+    interface DatabaseOperations extends DocumentDatabaseOperations<DrawingDocument> {}
+  }
+
+  /**
+   * The client-side Drawing document which extends the common BaseDrawing model.
+   *
+   * @see {@link Scene}               The Scene document type which contains Drawing embedded documents
+   * @see {@link DrawingConfig}       The Drawing configuration application
+   */
+  class DrawingDocument extends CanvasDocumentMixin(foundry.documents.BaseDrawing) {
+    /**
+     * Is the current User the author of this drawing?
+     */
+    get isAuthor(): boolean;
+  }
+}

package/src/foundry/client/data/documents/fog-exploration.d.mts

@@ -0,0 +1,51 @@
+import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { DatabaseGetOperation } from "../../../common/abstract/_types.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
+
+declare global {
+  namespace FogExploration {
+    type ConfiguredClass = Document.ConfiguredClassForName<"FogExploration">;
+    type ConfiguredInstance = Document.ConfiguredInstanceForName<"FogExploration">;
+
+    interface DatabaseOperations
+      extends DocumentDatabaseOperations<
+        FogExploration,
+        { loadFog: boolean },
+        { loadFog: boolean },
+        { loadFog: boolean }
+      > {}
+  }
+
+  /**
+   * The client-side FogExploration document which extends the common BaseFogExploration model.
+   */
+  class FogExploration extends ClientDocumentMixin(foundry.documents.BaseFogExploration) {
+    /**
+     * Obtain the fog of war exploration progress for a specific Scene and User.
+     * @param query      - Parameters for which FogExploration document is retrieved
+     * @param options    - Additional options passed to DatabaseBackend#get.
+     *                     (default: `{}`)
+     * @returns
+     */
+    static load(
+      query?: InexactPartial<{
+        /** A certain Scene ID **/
+        scene: string;
+        /** A certain User ID **/
+        user: string;
+      }>,
+      options?: InexactPartial<DatabaseGetOperation>,
+    ): Promise<FogExploration | null>;
+
+    /**
+     * Transform the explored base64 data into a PIXI.Texture object
+     */
+    getTexture(): PIXI.Texture | null;
+
+    /**
+     * @privateRemarks _onCreate, _onUpdate, and _onDelete are all overridden but with no signature changes.
+     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
+     */
+  }
+}

package/src/foundry/client/data/documents/folder.d.mts

@@ -0,0 +1,123 @@
+import type { DeepPartial, InexactPartial } from "../../../../types/utils.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
+
+declare global {
+  namespace Folder {
+    type ConfiguredClass = Document.ConfiguredClassForName<"Folder">;
+    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Folder">;
+
+    interface DatabaseOperations extends DocumentDatabaseOperations<Folder> {}
+
+    interface ExportToCompendiumOptions {
+      /** Update existing entries in the Compendium pack, matching by name */
+      updateByName?: boolean | undefined;
+    }
+  }
+
+  /**
+   * The client-side Folder document which extends the common BaseFolder model.
+   *
+   * @see {@link Folders}            The world-level collection of Folder documents
+   * @see {@link FolderConfig}       The Folder configuration application
+   */
+  class Folder extends ClientDocumentMixin(foundry.documents.BaseFolder) {
+    /**
+     * The depth of this folder in its sidebar tree
+     *
+     * @remarks For folders that have been populated by the {@link SidebarDirectory}, this is always be defined
+     */
+    depth?: number;
+
+    /**
+     * An array of other Folders which are the displayed children of this one. This differs from the results of
+     * {@link Folder.getSubfolders} because reports the subset of child folders which  are displayed to the current User
+     * in the UI.
+     */
+    children: Folder.ConfiguredInstance[];
+
+    /**
+     * Return whether the folder is displayed in the sidebar to the current User.
+     */
+    displayed: boolean;
+
+    /**
+     * The array of the Document instances which are contained within this Folder,
+     * unless it's a Folder inside a Compendium pack, in which case it's the array
+     * of objects inside the index of the pack that are contained in this Folder.
+     */
+    get contents(): this["type"] extends Document.Type ? Document.ConfiguredInstanceForName<this["type"]>[] : never;
+
+    set contents(value);
+
+    /**
+     * The reference to the Document type which is contained within this Folder.
+     */
+    get documentClass(): this["type"] extends Document.Type ? Document.ConfiguredClassForName<this["type"]> : never;
+
+    /**
+     * The reference to the WorldCollection instance which provides Documents to this Folder,
+     * unless it's a Folder inside a Compendium pack, in which case it's the index of the pack.
+     * A world Folder containing CompendiumCollections will have neither.
+     */
+    // TODO: Compendium Pack index
+    get documentCollection(): this["pack"] extends string ? unknown : undefined;
+
+    /**
+     * Return whether the folder is currently expanded within the sidebar interface.
+     */
+    get expanded(): boolean;
+
+    /**
+     * Return the list of ancestors of this folder, starting with the parent.
+     */
+    get ancestors(): Folder.ConfiguredInstance[];
+
+    /**
+     * @privateRemarks _preCreate overridden but with no signature changes.
+     * For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
+     */
+
+    static createDialog<T extends Document.AnyConstructor>(
+      this: T,
+      data?: DeepPartial<Document.ConstructorDataFor<T> | (Document.ConstructorDataFor<T> & Record<string, unknown>)>,
+      context?: InexactPartial<Omit<FolderConfig.Options, "resolve">>,
+    ): Promise<Document.ToConfiguredInstance<T> | null | undefined>;
+
+    /**
+     * Export all Documents contained in this Folder to a given Compendium pack.
+     * Optionally update existing Documents within the Pack by name, otherwise append all new entries.
+     * @param pack    - A Compendium pack to which the documents will be exported
+     * @param options - Additional options which customize how content is exported. See {@link ClientDocument#toCompendium}
+     *                  (default: `{}`)
+     * @returns The updated Compendium Collection instance
+     */
+    exportToCompendium<Metadata extends CompendiumCollection.Metadata>(
+      pack: CompendiumCollection<Metadata>,
+      options?: Folder.ExportToCompendiumOptions,
+    ): Promise<CompendiumCollection<Metadata>>;
+
+    /**
+     * Provide a dialog form that allows for exporting the contents of a Folder into an eligible Compendium pack.
+     * @param pack    - A pack ID to set as the default choice in the select input
+     * @param options - Additional options passed to the Dialog.prompt method
+     *                  (default: `{}`)
+     * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
+     */
+    exportDialog(pack: string, options?: DialogOptions): Promise<void>;
+
+    /**
+     * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
+     * @param recursive - Identify child folders recursively, if false only direct children are returned
+     *                    (default: `false`)
+     * @returns An array of Folder documents which are subfolders of this one
+     */
+    getSubfolders(recursive?: boolean): Folder.ConfiguredInstance[];
+
+    /**
+     * Get the Folder documents which are parent folders of the current folder or any if its parents.
+     * @returns An array of Folder documents which are parent folders of this one
+     */
+    getParentFolders(): Folder.ConfiguredInstance[];
+  }
+}

package/src/foundry/client/data/documents/index.d.mts

@@ -0,0 +1,30 @@
+import "./active-effect.d.mts";
+import "./actor-delta.d.mts";
+import "./actor.d.mts";
+import "./adventure.d.mts";
+import "./ambient-light.d.mts";
+import "./ambient-sound.d.mts";
+import "./card.d.mts";
+import "./cards.d.mts";
+import "./chat-message.d.mts";
+import "./combat.d.mts";
+import "./combatant.d.mts";
+import "./drawing.d.mts";
+import "./fog-exploration.d.mts";
+import "./folder.d.mts";
+import "./item.d.mts";
+import "./journal-entry.d.mts";
+import "./journal-entry-page.d.mts";
+import "./macro.d.mts";
+import "./measured-template.d.mts";
+import "./note.d.mts";
+import "./playlist-sound.d.mts";
+import "./playlist.d.mts";
+import "./scene.d.mts";
+import "./setting.d.mts";
+import "./table-result.d.mts";
+import "./table.d.mts";
+import "./tile.d.mts";
+import "./token.d.mts";
+import "./user.d.mts";
+import "./wall.d.mts";