combatant.d.ts

import type { ClientBaseCombatant } from "./client-base-mixes.d.ts";

declare global {
    /**
     * 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 application which configures a Combatant.
     */
    class Combatant<
        TParent extends Combat | null,
        TTokenDocument extends TokenDocument<Scene | null> | null = TokenDocument<Scene | null> | null
    > extends ClientBaseCombatant<TParent> {
        constructor(data: PreCreate<foundry.documents.CombatantSource>, context?: DocumentConstructionContext<TParent>);

        /** The current value of the special tracked resource which pertains to this Combatant */
        resource: { value: number } | null;

        /* -------------------------------------------- */
        /*  Properties                                  */
        /* -------------------------------------------- */

        /**
         * Determine the image icon path that should be used to portray this Combatant in the combat tracker or
         * elsewhere
         */
        get img(): VideoFilePath;

        /**
         * 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 isOwner(): boolean;

        /** Is this Combatant entry currently visible in the Combat Tracker? */
        get isVisible(): boolean;

        /** A reference to the Actor document which this Combatant represents, if any */
        get actor(): NonNullable<TTokenDocument>["actor"];

        /** A reference to the Token document which this Combatant represents, if any */
        get token(): TTokenDocument;

        /** An array of User documents who have ownership of this Document */
        get players(): User[];

        /** Has this combatant been marked as defeated? */
        get isDefeated(): boolean;

        /* -------------------------------------------- */
        /*  Methods                                     */
        /* -------------------------------------------- */

        override testUserPermission(
            user: User,
            permission: DocumentOwnershipString | DocumentOwnershipLevel,
            { 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.
         * @return 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.
         * @return The Roll instance to use for the combatant.
         */
        rollInitiative(formula: string): Rolled<Roll>;

        override prepareDerivedData(): void;

        /** Update the value of the tracked resource for this Combatant. */
        updateResource(): { value: number } | null;

        /**
         * 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.
         * @return The initiative formula to use for this combatant.
         */
        _getInitiativeFormula(): string;
    }

    interface Combatant<
        TParent extends Combat | null,
        TTokenDocument extends TokenDocument<Scene | null> | null = TokenDocument<Scene | null> | null
    > extends ClientBaseCombatant<TParent> {
        _sheet: CombatantConfig<this>;
    }
}