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

package/src/foundry/client/pixi/placeables/light.d.ts

@@ -1,126 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * An AmbientLight is an implementation of PlaceableObject which represents a dynamic light source within the Scene.
-   */
-  class AmbientLight extends PlaceableObject<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>> {
-    constructor(document: InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>);
-
-    /**
-     * A reference to the PointSource object which defines this light source area of effect
-     */
-    source: LightSource;
-
-    /**
-     * A reference to the ControlIcon used to configure this light
-     * @defaultValue `undefined`
-     */
-    controlIcon: ControlIcon | undefined;
-
-    static override embeddedName: 'AmbientLight';
-
-    override get bounds(): NormalizedRectangle;
-
-    /**
-     * A convenience accessor to the LightData configuration object
-     */
-    get config(): foundry.data.LightData;
-
-    /**
-     * Test whether a specific AmbientLight source provides global illumination
-     */
-    get global(): boolean;
-
-    /**
-     * The maximum radius in pixels of the light field
-     */
-    get radius(): number;
-
-    /**
-     * Get the pixel radius of dim light emitted by this light source
-     */
-    get dimRadius(): number;
-
-    /**
-     * Get the pixel radius of bright light emitted by this light source
-     */
-    get brightRadius(): number;
-
-    /**
-     * Return whether the light source is currently visible in the scene
-     */
-    get isVisible(): boolean;
-
-    override draw(): Promise<this>;
-
-    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
-
-    /**
-     * Draw the ControlIcon for the AmbientLight
-     * @internal
-     */
-    protected _drawControlIcon(): ControlIcon;
-
-    override refresh(): this;
-
-    /**
-     * Refresh the display of the ControlIcon for this AmbientLight source
-     */
-    refreshControl(): void;
-
-    /**
-     * The named identified for the source object associated with this light
-     */
-    get sourceId(): string;
-
-    /**
-     * Update the source object associated with this light
-     * @param options - (default: `{}}`)
-     */
-    updateSource(options?: AmbientLight.UpdateSourceOptions | undefined): void;
-
-    protected override _onCreate(
-      data: foundry.data.AmbientLightData['_source'],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdate(
-      changed: DeepPartial<foundry.data.AmbientLightData['_source']>,
-      options?: DocumentModificationOptions,
-      userId?: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    protected override _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
-
-    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
-
-    protected override _onClickRight(event: PIXI.InteractionEvent): Promise<this>;
-
-    protected override _onDragLeftStart(event: PIXI.InteractionEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-    protected override _onDragLeftCancel(event: MouseEvent): void;
-  }
-
-  namespace AmbientLight {
-    interface UpdateSourceOptions {
-      /**
-       * Defer refreshing the LightingLayer to manually call that refresh later.
-       * @defaultValue `false`
-       */
-      defer?: boolean | undefined;
-
-      /**
-       * Indicate that this light source has been deleted.
-       * @defaultValue `false`
-       */
-      deleted?: boolean | undefined;
-    }
-  }
-}

package/src/foundry/client/pixi/placeables/note.d.ts

@@ -1,67 +0,0 @@
-import type { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { HoverInOptions } from '../placeable';
-
-declare global {
-  /**
-   * A Note is an implementation of PlaceableObject which represents an annotated location within the Scene.
-   * Each Note links to a JournalEntry document and represents its location on the map.
-   */
-  class Note extends PlaceableObject<InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>> {
-    static override embeddedName: 'Note';
-
-    override get bounds(): Rectangle;
-
-    /**
-     * The associated JournalEntry which is described by this note
-     */
-    get entry(): InstanceType<ConfiguredDocumentClassForName<'JournalEntry'>>;
-
-    /**
-     * The text label used to annotate this Note
-     */
-    get text(): string;
-
-    /**
-     * The Map Note icon size
-     */
-    get size(): number;
-
-    /**
-     * Determine whether the Note is visible to the current user based on their perspective of the Scene.
-     * Visibility depends on permission to the underlying journal entry, as well as the perspective of controlled Tokens.
-     * If Token Vision is required, the user must have a token with vision over the note to see it.
-     */
-    get isVisible(): boolean;
-
-    override draw(): Promise<this>;
-
-    /**
-     * Draw the ControlIcon for the Map Note
-     */
-    protected _drawControlIcon(): ControlIcon;
-
-    /**
-     * Draw the map note Tooltip as a Text object
-     */
-    protected _drawTooltip(): PreciseText;
-
-    /**
-     * Define a PIXI TextStyle object which is used for the tooltip displayed for this Note
-     */
-    protected _getTextStyle(): PIXI.TextStyle;
-
-    override refresh(): this;
-
-    protected override _onUpdate(changed: DeepPartial<foundry.data.NoteData['_source']>): void;
-
-    protected override _canHover(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): true;
-
-    protected override _canView(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): boolean;
-
-    protected override _onHoverIn(event: PIXI.InteractionEvent, options?: HoverInOptions): false | void;
-
-    protected override _onHoverOut(event: PIXI.InteractionEvent): false | void;
-
-    protected override _onClickLeft2(event: PIXI.InteractionEvent): void;
-  }
-}

package/src/foundry/client/pixi/placeables/sound.d.ts

@@ -1,131 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * An AmbientSound is an implementation of PlaceableObject which represents a dynamic audio source within the Scene.
-   */
-  class AmbientSound extends PlaceableObject<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>> {
-    constructor(document: InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>);
-
-    /**
-     * The Sound which manages playback for this AmbientSound effect
-     */
-    sound: Sound | null;
-
-    /**
-     * A SoundSource object which manages the area of effect for this ambient sound
-     */
-    source: SoundSource;
-
-    static override embeddedName: 'AmbientSound';
-
-    /**
-     * Create a Sound used to play this AmbientSound object
-     * @internal
-     */
-    protected _createSound(): Sound | null;
-
-    /**
-     * Is this ambient sound is currently audible based on its hidden state and the darkness level of the Scene?
-     */
-    get isAudible(): boolean;
-
-    override get bounds(): Rectangle;
-
-    /**
-     * The named identified for the source object associated with this ambient sound
-     */
-    get sourceId(): string;
-
-    /**
-     * A convenience accessor for the sound radius in pixels
-     */
-    get radius(): number;
-
-    /**
-     * Toggle playback of the sound depending on whether or not it is audible
-     * @param isAudible - Is the sound audible?
-     * @param volume    - The target playback volume
-     * @param options   - Additional options which affect sound synchronization
-     */
-    sync(isAudible: boolean, volume: number, options?: Partial<AmbientSound.SyncOptions>): void;
-
-    override clear(): this;
-
-    override draw(): Promise<this>;
-
-    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
-
-    /**
-     * Draw the graphical preview of the audio source area of effect
-     * @internal
-     */
-    drawField(): PIXI.Container;
-
-    /**
-     * Draw the ControlIcon for the AmbientLight
-     * @internal
-     */
-    protected _drawControlIcon(): ControlIcon;
-
-    override refresh(): this;
-
-    /**
-     * Refresh the display of the ControlIcon for this AmbientSound source
-     */
-    refreshControl(): void;
-
-    /**
-     * Compute the field-of-vision for an object, determining its effective line-of-sight and field-of-vision polygons
-     * @param options - (default: `{}`)
-     */
-    updateSource(options?: AmbientSound.UpdateSourceOptions | undefined): void;
-
-    protected override _onCreate(
-      data: foundry.data.AmbientSoundData['_source'],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdate(
-      changed: DeepPartial<foundry.data.AmbientSoundData['_source']>,
-      options?: DocumentModificationOptions,
-      userId?: string
-    ): void;
-
-    protected override _onDelete(...args: Parameters<PlaceableObject['_onDelete']>): void;
-
-    protected override _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
-
-    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
-
-    protected override _onClickRight(event: PIXI.InteractionEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
-  }
-
-  namespace AmbientSound {
-    interface SyncOptions {
-      /**
-       * A duration in milliseconds to fade volume transition
-       * @defaultValue `250`
-       */
-      fade: number;
-    }
-
-    interface UpdateSourceOptions {
-      /**
-       * Defer refreshing the SoundsLayer to manually call that refresh later.
-       * @defaultValue `false`
-       */
-      defer?: boolean | undefined;
-
-      /**
-       * Indicate that this SoundSource has been deleted.
-       * @defaultValue `false`
-       */
-      deleted?: boolean | undefined;
-    }
-  }
-}

package/src/foundry/client/pixi/placeables/template.d.ts

@@ -1,153 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * A type of Placeable Object which highlights an area of the grid as covered by some area of effect.
-   * @see {@link MeasuredTemplateDocument}
-   * @see {@link TemplateLayer}
-   */
-  class MeasuredTemplate extends PlaceableObject<
-    InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>
-  > {
-    /**
-     * The geometry shape used for testing point intersection
-     * @defaultValue `undefined`
-     */
-    shape: PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle | undefined;
-
-    /**
-     * The tiling texture used for this template, if any
-     */
-    texture: PIXI.Texture | undefined;
-
-    /**
-     * The template graphics
-     * @defaultValue `undefined`
-     */
-    template: PIXI.Graphics | undefined;
-
-    /**
-     * The UI frame container which depicts Token metadata and status, displayed in the ControlsLayer.
-     * @defaultValue `new ObjectHUD(this)`
-     */
-    hud: MeasuredTemplate.ObjectHUD;
-
-    /**
-     * Internal property used to configure the control border thickness
-     * @defaultValue `3`
-     * @internal
-     */
-    protected _borderThickness: number;
-
-    static override embeddedName: 'MeasuredTemplate';
-
-    override get bounds(): Rectangle;
-
-    /**
-     * A convenience accessor for the border color as a numeric hex code
-     */
-    get borderColor(): string | number;
-
-    /**
-     * A convenience accessor for the fill color as a numeric hex code
-     */
-    get fillColor(): string | number;
-
-    /**
-     * A flag for whether the current User has full ownership over the MeasuredTemplate document.
-     */
-    get owner(): boolean;
-
-    override draw(): Promise<this>;
-
-    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
-
-    /**
-     * Draw the HUD container which provides an interface for managing this template
-     * @internal
-     */
-    protected _drawHUD(): MeasuredTemplate.InitializedObjectHUD;
-
-    /**
-     * Draw the ControlIcon for the MeasuredTemplate
-     * @internal
-     */
-    protected _drawControlIcon(): ControlIcon;
-
-    /**
-     * Draw the Text label used for the MeasuredTemplate
-     * @internal
-     */
-    protected _drawRulerText(): PreciseText;
-
-    override refresh(): this;
-
-    /**
-     * Get a Circular area of effect given a radius of effect
-     * @internal
-     */
-    protected _getCircleShape(distance: number): PIXI.Circle;
-
-    /**
-     * Get a Conical area of effect given a direction, angle, and distance
-     * @internal
-     */
-    protected _getConeShape(direction: number, angle: number, distance: number): PIXI.Polygon;
-
-    /**
-     * Get a Rectangular area of effect given a width and height
-     * @internal
-     */
-    protected _getRectShape(direction: number, distance: number): NormalizedRectangle;
-
-    /**
-     * Get a rotated Rectangular area of effect given a width, height, and direction
-     * @internal
-     */
-    protected _getRayShape(direction: number, distance: number, width: number): PIXI.Polygon;
-
-    /**
-     * Update the displayed ruler tooltip text
-     * @internal
-     */
-    protected _refreshRulerText(): void;
-
-    /**
-     * Highlight the grid squares which should be shown under the area of effect
-     */
-    highlightGrid(): void;
-
-    override rotate(angle: number, snap: number): Promise<this>;
-
-    protected override _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    protected override _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    protected override _onUpdate(
-      data: DeepPartial<InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>['data']['_source']>,
-      options?: DocumentModificationOptions,
-      userId?: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-  }
-
-  namespace MeasuredTemplate {
-    interface ObjectHUD extends globalThis.ObjectHUD {
-      /**
-       * Template control icon
-       */
-      icon?: ControlIcon;
-
-      /**
-       * Ruler text tooltip
-       */
-      ruler?: PreciseText;
-    }
-
-    type InitializedObjectHUD = RequiredProps<ObjectHUD, 'icon' | 'ruler'>;
-  }
-}