@league-of-foundry-developers/foundry-vtt-types 0.8.9-9 → 9.245.0

package/src/foundry/common/data/data.mjs/ambientLightData.d.ts

@@ -1,41 +1,23 @@
 import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
 import { DocumentData } from '../../abstract/module.mjs';
-import * as CONST from '../../constants.mjs';
 import { BaseAmbientLight } from '../../documents.mjs';
 import * as fields from '../fields.mjs';
-import { AnimationData, AnimationDataConstructorData } from './animationData';
-import { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation';
+import type { LightData, LightDataConstructorData } from './lightData.js';
 
 interface AmbientLightDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  t: DocumentField<CONST.SourceType> & {
-    type: String;
+  _id: fields.DocumentId;
+  x: fields.RequiredNumber;
+  y: fields.RequiredNumber;
+  rotation: FieldReturnType<fields.AngleField, { default: 0 }>;
+  walls: FieldReturnType<fields.BooleanField, { default: true }>;
+  vision: fields.BooleanField;
+  config: DocumentField<LightData> & {
+    type: typeof LightData;
     required: true;
-    default: 'l';
-    validate: (t: unknown) => boolean;
-    validationError: 'Invalid {name} {field} which must be a value in CONST.SOURCE_TYPES';
+    default: Record<string, never>;
   };
-  x: typeof fields.REQUIRED_NUMBER;
-  y: typeof fields.REQUIRED_NUMBER;
-  rotation: FieldReturnType<typeof fields.ANGLE_FIELD, { default: 0 }>;
-  dim: typeof fields.REQUIRED_NUMBER;
-  bright: typeof fields.REQUIRED_NUMBER;
-  angle: typeof fields.ANGLE_FIELD;
-  tintColor: typeof fields.COLOR_FIELD;
-  tintAlpha: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.25 }>;
-  lightAnimation: DocumentField<AnimationData> & {
-    type: typeof AnimationData;
-    required: true;
-    default: {};
-  };
-  darknessThreshold: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0 }>;
-  darkness: DocumentField<DarknessActivation> & {
-    type: typeof DarknessActivation;
-    required: true;
-    default: {};
-  };
-  hidden: typeof fields.BOOLEAN_FIELD;
-  flags: typeof fields.OBJECT_FIELD;
+  hidden: fields.BooleanField;
+  flags: fields.ObjectField;
 }
 
 interface AmbientLightDataProperties {
@@ -44,12 +26,6 @@ interface AmbientLightDataProperties {
    */
   _id: string | null;
 
-  /**
-   * The source type in CONST.SOURCE_TYPES which defines the behavior of this light
-   * @defaultValue `'l'`
-   */
-  t: CONST.SourceType;
-
   /**
    * The x-coordinate position of the origin of the light
    * @defaultValue `0`
@@ -69,50 +45,22 @@ interface AmbientLightDataProperties {
   rotation: number;
 
   /**
-   * The radius of dim light emitted in distance units, negative values produce darkness
-   * @defaultValue `0`
+   * Whether or not this light source is constrained by Walls
+   * @defaultValue `true`
    */
-  dim: number;
+  walls: boolean;
 
   /**
-   * The radius of bright light emitted in distance units, negative values produce blackness
-   * @defaultValue `0`
-   */
-  bright: number;
-
-  /**
-   * The angle of emission of the light source in degrees
-   * @defaultValue `360`
-   */
-  angle: number;
-
-  /**
-   * An optional color string which applies coloration to the resulting light source
-   */
-  tintColor?: string | null;
-
-  /**
-   * The intensity of coloration applied to this light source, a number between 0 and 1
-   * @defaultValue `0.25`
-   */
-  tintAlpha: number;
-
-  /**
-   * A data object which configures token light animation settings, if one is applied
-   * @defaultValue `{}`
-   */
-  lightAnimation: AnimationData;
-
-  /**
-   * A value of the Scene darkness level, above which this light source will be active
-   * @defaultValue `0`
+   * Whether or not this light source provides a source of vision
+   * @defaultValue `false`
    */
-  darknessThreshold: number;
+  vision: boolean;
 
   /**
-   * @defaultValue `{}`
+   * Light configuration data
+   * @defaultValue `new LightData({})`
    */
-  darkness: DarknessActivation;
+  config: LightData;
 
   /**
    * Is the light source currently hidden?
@@ -131,104 +79,77 @@ interface AmbientLightDataConstructorData {
   /**
    * The _id which uniquely identifies this BaseAmbientLight embedded document
    */
-  _id?: string | null;
-
-  /**
-   * The source type in CONST.SOURCE_TYPES which defines the behavior of this light
-   * @defaultValue `'l'`
-   */
-  t?: CONST.SourceType | null;
+  _id?: string | null | undefined;
 
   /**
    * The x-coordinate position of the origin of the light
    * @defaultValue `0`
    */
-  x?: number | null;
+  x?: number | null | undefined;
 
   /**
    * The y-coordinate position of the origin of the light
    * @defaultValue `0`
    */
-  y?: number | null;
+  y?: number | null | undefined;
 
   /**
    * The angle of rotation for the tile between 0 and 360
    * @defaultValue `0`
    */
-  rotation?: number | null;
-
-  /**
-   * The radius of dim light emitted in distance units, negative values produce darkness
-   * @defaultValue `0`
-   */
-  dim?: number | null;
+  rotation?: number | null | undefined;
 
   /**
-   * The radius of bright light emitted in distance units, negative values produce blackness
-   * @defaultValue `0`
+   * Whether or not this light source is constrained by Walls
+   * @defaultValue `true`
    */
-  bright?: number | null;
+  walls?: boolean | null | undefined;
 
   /**
-   * The angle of emission of the light source in degrees
-   * @defaultValue `360`
-   */
-  angle?: number | null;
-
-  /**
-   * An optional color string which applies coloration to the resulting light source
-   */
-  tintColor?: string | null;
-
-  /**
-   * The intensity of coloration applied to this light source, a number between 0 and 1
-   * @defaultValue `0.25`
-   */
-  tintAlpha?: number | null;
-
-  /**
-   * A data object which configures token light animation settings, if one is applied
-   * @defaultValue `{}`
-   */
-  lightAnimation?: AnimationDataConstructorData | null;
-
-  /**
-   * A value of the Scene darkness level, above which this light source will be active
-   * @defaultValue `0`
+   * Whether or not this light source provides a source of vision
+   * @defaultValue `false`
    */
-  darknessThreshold?: number | null;
+  vision?: boolean | null | undefined;
 
   /**
-   * @defaultValue `{}`
+   * Light configuration data
+   * @defaultValue `new LightData({})`
    */
-  darkness?: DarknessActivationConstructorData | null;
+  config?: LightDataConstructorData | null | undefined;
 
   /**
    * Is the light source currently hidden?
    * @defaultValue `false`
    */
-  hidden?: boolean | null;
+  hidden?: boolean | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'AmbientLight'> | null;
+  flags?: ConfiguredFlags<'AmbientLight'> | null | undefined;
 }
 
 /**
  * The data schema for a AmbientLight embedded document.
  * @see BaseAmbientLight
  */
-export declare class AmbientLightData extends DocumentData<
+export class AmbientLightData extends DocumentData<
   AmbientLightDataSchema,
   AmbientLightDataProperties,
   PropertiesToSource<AmbientLightDataProperties>,
   AmbientLightDataConstructorData,
   BaseAmbientLight
 > {
+  /** @override */
   static defineSchema(): AmbientLightDataSchema;
+
+  /** @override */
+  _initializeSource(data: AmbientLightDataConstructorData): PropertiesToSource<AmbientLightDataProperties>;
+
+  /** @override */
+  protected _initialize(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface AmbientLightData extends AmbientLightDataProperties {}
+export interface AmbientLightData extends AmbientLightDataProperties {}

package/src/foundry/common/data/data.mjs/ambientSoundData.d.ts

@@ -5,54 +5,38 @@ import * as fields from '../fields.mjs';
 import { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation';
 
 interface AmbientSoundDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  type: DocumentField<string> & {
-    type: typeof String;
-    required: true;
-    default: typeof documents.BaseAmbientSound['metadata']['types'][0];
-    validate: (t: unknown) => t is ValueOf<typeof documents.BaseAmbientSound['metadata']['types']>;
-    validationError: 'Invalid {name} {field} which must be a value in BaseAmbientSound.metadata.types';
-  };
-  x: typeof fields.REQUIRED_NUMBER;
-  y: typeof fields.REQUIRED_NUMBER;
-  radius: typeof fields.REQUIRED_NUMBER;
-  path: typeof fields.AUDIO_FIELD;
-  repeat: typeof fields.BOOLEAN_FIELD;
-  volume: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.5 }>;
-  easing: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
-  hidden: typeof fields.BOOLEAN_FIELD;
+  _id: fields.DocumentId;
+  x: fields.RequiredNumber;
+  y: fields.RequiredNumber;
+  radius: fields.NonnegativeNumberField;
+  path: fields.AudioField;
+  repeat: fields.BooleanField;
+  volume: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
+  walls: FieldReturnType<fields.BooleanField, { default: true }>;
+  easing: FieldReturnType<fields.BooleanField, { default: true }>;
+  hidden: fields.BooleanField;
   darkness: DocumentField<DarknessActivation> & {
     type: typeof DarknessActivation;
     required: true;
-    default: {};
+    default: Record<string, never>;
   };
-  flags: typeof fields.OBJECT_FIELD;
+  flags: fields.ObjectField;
 }
 
 interface AmbientSoundDataProperties {
   /**
    * The _id which uniquely identifies this AmbientSound document
+   * @defaultValue `null`
    */
   _id: string | null;
 
-  /**
-   * @defaultValue `documents.BaseAmbientSound.metadata.types[0]`
-   */
-  type: ValueOf<typeof documents.BaseAmbientSound['metadata']['types']>;
-
-  /**
-   * @defaultValue `0`
-   */
+  /** @defaultValue `0` */
   x: number;
 
-  /**
-   * @defaultValue `0`
-   */
+  /** @defaultValue `0` */
   y: number;
 
-  /**
-   * @defaultValue `0`
-   */
+  /** @defaultValue `0` */
   radius: number;
 
   /**
@@ -72,19 +56,16 @@ interface AmbientSoundDataProperties {
    */
   volume: number;
 
-  /**
-   * @defaultValue `true`
-   */
+  /** @defaultValue `true` */
+  walls: boolean;
+
+  /** @defaultValue `true` */
   easing: boolean;
 
-  /**
-   * @defaultValue `false`
-   */
+  /** @defaultValue `false` */
   hidden: boolean;
 
-  /**
-   * @defaultValue `{}`
-   */
+  /** @defaultValue `new DarknessActivation({})` */
   darkness: DarknessActivation;
 
   /**
@@ -97,84 +78,75 @@ interface AmbientSoundDataProperties {
 interface AmbientSoundDataConstructorData {
   /**
    * The _id which uniquely identifies this AmbientSound document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
-  /**
-   * @defaultValue `documents.BaseAmbientSound.metadata.types[0]`
-   */
-  type?: ValueOf<typeof documents.BaseAmbientSound['metadata']['types']> | null;
+  /** @defaultValue `0` */
+  x?: number | null | undefined;
 
-  /**
-   * @defaultValue `0`
-   */
-  x?: number | null;
-
-  /**
-   * @defaultValue `0`
-   */
-  y?: number | null;
+  /** @defaultValue `0` */
+  y?: number | null | undefined;
 
-  /**
-   * @defaultValue `0`
-   */
-  radius?: number | null;
+  /** @defaultValue `0` */
+  radius?: number | null | undefined;
 
   /**
    * The audio file path that is played by this sound
    */
-  path?: string | null;
+  path?: string | null | undefined;
 
   /**
    * Does this sound loop?
    * @defaultValue `false`
    */
-  repeat?: boolean | null;
+  repeat?: boolean | null | undefined;
 
   /**
    * The audio volume of the sound, from 0 to 1
    * @defaultValue `0.5`
    */
-  volume?: number | null;
+  volume?: number | null | undefined;
 
-  /**
-   * @defaultValue `true`
-   */
-  easing?: boolean | null;
+  /** @defaultValue `true` */
+  walls?: boolean | null | undefined;
 
-  /**
-   * @defaultValue `false`
-   */
-  hidden?: boolean | null;
+  /** @defaultValue `true` */
+  easing?: boolean | null | undefined;
 
-  /**
-   * @defaultValue `{}`
-   */
-  darkness?: DarknessActivationConstructorData | null;
+  /** @defaultValue `false` */
+  hidden?: boolean | null | undefined;
+
+  /** @defaultValue `new DarknessActivation({})` */
+  darkness?: DarknessActivationConstructorData | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'AmbientSound'> | null;
+  flags?: ConfiguredFlags<'AmbientSound'> | null | undefined;
 }
 
 /**
  * The data schema for a AmbientSound embedded document.
  * @see BaseAmbientSound
  */
-export declare class AmbientSoundData extends DocumentData<
+export class AmbientSoundData extends DocumentData<
   AmbientSoundDataSchema,
   AmbientSoundDataProperties,
   PropertiesToSource<AmbientSoundDataProperties>,
   AmbientSoundDataConstructorData,
   documents.BaseAmbientSound
 > {
+  /** @override */
   static defineSchema(): AmbientSoundDataSchema;
 
+  /** @override */
+  _initializeSource(data: AmbientSoundDataConstructorData): PropertiesToSource<AmbientSoundDataProperties>;
+
   /** @override */
   protected _initialize(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface AmbientSoundData extends AmbientSoundDataProperties {}
+export interface AmbientSoundData extends AmbientSoundDataProperties {}

package/src/foundry/common/data/data.mjs/animationData.d.ts

@@ -4,13 +4,13 @@ import { BaseAmbientLight } from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface AnimationDataSchema extends DocumentSchema {
-  type: typeof fields.STRING_FIELD;
+  type: fields.StringField;
   speed: DocumentField<number> & {
     type: typeof Number;
     required: false;
     default: 5;
     validate: (a: number) => boolean;
-    validationError: 'Light animation speed must be an integer between 1 and 10';
+    validationError: 'Light animation speed must be an integer between 0 and 10';
   };
   intensity: DocumentField<number> & {
     type: typeof Number;
@@ -19,13 +19,14 @@ interface AnimationDataSchema extends DocumentSchema {
     validate: (a: number) => boolean;
     validationError: 'Light animation intensity must be an integer between 1 and 10';
   };
+  reverse: fields.BooleanField;
 }
 
 interface AnimationDataProperties {
   /**
    * The animation type which is applied
    */
-  type?: string;
+  type: string | undefined;
 
   /**
    * The speed of the animation, a number between 1 and 10
@@ -38,39 +39,46 @@ interface AnimationDataProperties {
    * @defaultValue `5`
    */
   intensity: number;
+
+  /** @defaultValue `false` */
+  reverse: boolean;
 }
 
-export interface AnimationDataConstructorData {
+interface AnimationDataConstructorData {
   /**
    * The animation type which is applied
    */
-  type?: string | null;
+  type?: string | null | undefined;
 
   /**
    * The speed of the animation, a number between 1 and 10
    * @defaultValue `5`
    */
-  speed?: number | null;
+  speed?: number | null | undefined;
 
   /**
    * The intensity of the animation, a number between 1 and 10
    * @defaultValue `5`
    */
-  intensity?: number | null;
+  intensity?: number | null | undefined;
+
+  /** @defaultValue `false` */
+  reverse?: boolean | null | undefined;
 }
 
 /**
  * An embedded data object which defines the properties of a light source animation
  */
-export declare class AnimationData extends DocumentData<
+export class AnimationData extends DocumentData<
   AnimationDataSchema,
   AnimationDataProperties,
   PropertiesToSource<AnimationDataProperties>,
   AnimationDataConstructorData,
   BaseAmbientLight
 > {
+  /** @override */
   static defineSchema(): AnimationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface AnimationData extends AnimationDataProperties {}
+export interface AnimationData extends AnimationDataProperties {}