@7h3laughingman/foundry-types 13.351.0

package/src/client/data/_module.d.mts

@@ -0,0 +1,11 @@
+/** @module data */
+
+export * from "./../../common/data/_module.mjs";
+export * from "./_types.mjs";
+export * from "./calendar.mjs";
+export { default as CalendarData } from "./calendar.mjs";
+export { default as ClientDatabaseBackend } from "./client-backend.mjs";
+export { default as CombatConfiguration } from "./combat-config.mjs";
+export * as regionBehaviors from "./region-behaviors/_module.mjs";
+export * as regionShapes from "./region-shapes/_module.mjs";
+export * from "./terrain-data.mjs";

package/src/client/data/_types.d.mts

@@ -0,0 +1,97 @@
+import { ModelPropsFromSchema } from "./../../common/data/fields.mjs";
+import CalendarData, { CalendarDataSchema } from "./calendar.mjs";
+
+/**
+ * Default combat tracker settings used in Foundry VTT.
+ */
+export interface CombatConfigurationData {
+    /** A resource identifier for the tracker. */
+    resource: string;
+
+    /** Whether to skip defeated tokens during combat. */
+    skipDefeated: boolean;
+
+    /** Turn marker configuration. */
+    turnMarker: {
+        enabled: boolean;
+        path: string;
+        animation: string;
+        disposition: string;
+    };
+}
+
+export interface CalendarConfig extends ModelPropsFromSchema<CalendarDataSchema> {}
+
+/** A definition of a year within a calendar. */
+export type CalendarConfigYears = CalendarConfig["years"];
+
+/** A definition of how leap years work within a calendar. */
+export type CalendarConfigLeapYear = CalendarConfigYears["leapYear"];
+
+/** Month related configuration for a calendar. */
+export type CalendarConfigMonths = NonNullable<CalendarConfig["months"]>;
+
+/** A definition of a month within a calendar year. */
+export type CalendarConfigMonth = CalendarConfigMonths["values"][number];
+
+/** Day related configuration for a calendar. */
+export type CalendarConfigDays = CalendarConfig["years"];
+
+/** A definition of the days of the week within a calendar. */
+export interface CalendarConfigDay {
+    /** The full name of the weekday. */
+    name: string;
+
+    /** The abbreviated name of the weekday. */
+    abbreviation?: string;
+
+    /** The ordinal position of this weekday in the week. */
+    ordinal: number;
+
+    /** Is this weekday considered a rest day (weekend)? */
+    isRestDay?: boolean;
+}
+
+/** Season related configuration for a calendar. */
+export type CalendarConfigSeasons = NonNullable<CalendarConfig["seasons"]>;
+
+/** A definition of a season within a calendar year. */
+export type CalendarConfigSeason = CalendarConfigSeasons["values"][number];
+
+/**
+ * A decomposition of the integer world time in seconds into component parts.
+ * Each component expresses the number of that temporal unit since the time=0 epoch.
+ */
+export interface TimeComponents {
+    /** The number of years completed since zero */
+    year: number;
+
+    /** The number of days completed within the year */
+    day: number;
+
+    /** The number of hours completed within the year */
+    hour: number;
+
+    /** The number of minutes completed within the hour */
+    minute: number;
+
+    /** The number of seconds completed within the minute */
+    second: number;
+
+    /** The month, an index of the months.values array */
+    month: number;
+
+    /** The day of the month, starting from zero */
+    dayOfMonth: number;
+
+    /** The weekday, an index of the days.values array */
+    dayOfWeek: number;
+
+    /** The season, an index of the seasons.values array */
+    season: number;
+
+    /** Is it a leap year? */
+    leapYear: boolean;
+}
+
+export type TimeFormatter = (calendar: CalendarData, components: TimeComponents, options: object) => string;

package/src/client/data/calendar.d.mts

@@ -0,0 +1,175 @@
+import DataModel from "./../../common/abstract/data.mjs";
+import * as fields from "./../../common/data/fields.mjs";
+import { CalendarConfig, TimeComponents, TimeFormatter } from "./_types.mjs";
+
+/**
+ * Game Time Calendar configuration data model.
+ */
+export default class CalendarData<TComponents extends TimeComponents = TimeComponents> extends DataModel<null, CalendarDataSchema> {
+    static override defineSchema(): CalendarDataSchema;
+
+    static formatTimestamp<T extends TimeComponents>(calendar: CalendarData<T>, components: T, options: object): string;
+
+    static formatAgo<T extends TimeComponents>(calendar: CalendarData<T>, components: T, options: object): string;
+
+    /**
+     * Expand a world time integer into an object containing the relevant time components.
+     * @param components An amount of time expressed as components
+     * @returns The cumulative time in seconds
+     */
+    componentsToTime(components: Partial<TComponents>): number;
+
+    /**
+     * Compute the difference between some new time and some other time.
+     * @param endTime   A time to difference relative to the start time.
+     * @param startTime The starting time. If not provided the current world time is used.
+     * @returns The time difference expressed as components
+     */
+    difference(endTime: number | TComponents, startTime?: number | TComponents): TComponents;
+
+    /**
+     * Format a time using one of several supported display formats.
+     * @param time      The time components to format, by default the current world time.
+     * @param formatter The formatter function applied to the time. If a string is provided, it must be a function
+     *                  configured in CONFIG.time.formatters. Options passed to the formatter function
+     * @returns The formatted date and time string
+     */
+    format(time?: number | TComponents, formatter?: string | TimeFormatter, options?: object): string;
+
+    /**
+     * Test whether a year is a leap year.
+     * @param year The year to test
+     * @returns Is it a leap year?
+     */
+    isLeapYear(year: number): boolean;
+
+    /**
+     * Expand a world time integer into an object containing the relevant time components.
+     * @param time A time in seconds
+     * @returns The time expressed as components
+     */
+    timeToComponents(time?: number): TComponents;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default interface CalendarData<TComponents extends TimeComponents = TimeComponents>
+    extends DataModel<null, CalendarDataSchema>, fields.ModelPropsFromSchema<CalendarDataSchema> {}
+
+export type CalendarDataSchema = {
+    /** The name of the calendar being used. */
+    name: fields.StringField<string, string, true, false, true>;
+
+    /** A text description of the calendar configuration. */
+    description: fields.StringField<string, string, false, false, true>;
+
+    /** A definition of a year within a calendar. */
+    years: fields.SchemaField<{
+        /** A definition of how leap years work within a calendar. */
+        yearZero: fields.NumberField<number, number, true, false, true>;
+        /** The index of days.values that is the first weekday at time=0 */
+        firstWeekday: fields.NumberField<number, number, true, false, true>;
+        /** A definition of how leap years work within a calendar. */
+        leapYear: fields.SchemaField<{
+            /** The year number of the first leap year. On or after yearZero. */
+            leapStart: fields.NumberField<number, number, true, false, true>;
+            /** The number of years between leap years. */
+            leapInterval: fields.NumberField<number, number, true, false, true>;
+        }>;
+    }>;
+
+    /** Month related configuration for a calendar. */
+    months: fields.SchemaField<
+        {
+            /** An array of months in the calendar year. */
+            values: fields.ArrayField<fields.SchemaField<MonthSchema>>;
+        },
+        { values: fields.SourceFromSchema<MonthSchema>[] },
+        { values: fields.ModelPropsFromSchema<MonthSchema>[] },
+        true,
+        true,
+        true
+    >;
+
+    /** Configuration of days. */
+    days: fields.SchemaField<{
+        /** The configuration of the days of the week. */
+        values: fields.ArrayField<
+            fields.SchemaField<{
+                name: fields.StringField<string, string, true, false, false>;
+                abbreviation: fields.StringField;
+                ordinal: fields.NumberField<number, number, true, false, false>;
+            }>
+        >;
+        /** The number of days in a year. */
+        daysPerYear: fields.NumberField<number, number, true, false, false>;
+        /** The number of hours in a day. */
+        hoursPerDay: fields.NumberField<number, number, true, false, false>;
+        /** The number of minutes in an hour. */
+        minutesPerHour: fields.NumberField<number, number, true, false, false>;
+        /** The number of seconds in a minute. */
+        secondsPerMinute: fields.NumberField<number, number, true, false, false>;
+    }>;
+
+    /** Configuration of seasons. */
+    seasons: fields.SchemaField<
+        {
+            /** An array of seasons in the calendar year. */
+            values: fields.ArrayField<
+                fields.SchemaField<{
+                    /** The full name of the season. */
+                    name: fields.StringField<string, string, true, false, false>;
+                    /** The abbreviated name of the season. */
+                    abbreviation: fields.StringField;
+                    /** The ordinal month in which the season starts. */
+                    monthStart: fields.NumberField<number, number, true>;
+                    /** The day of the month on which the season starts. */
+                    monthEnd: fields.NumberField<number, number, true>;
+                    /** The ordinal month in which the season ends. */
+                    dayStart: fields.NumberField<number, number, true>;
+                    /** The day of the month on which the season ends. */
+                    dayEnd: fields.NumberField<number, number, true>;
+                }>
+            >;
+        },
+        {
+            values: {
+                name: string;
+                abbreviation: string | undefined;
+                monthStart: number | null;
+                monthEnd: number | null;
+                dayStart: number | null;
+                dayEnd: number | null;
+            }[];
+        },
+        {
+            values: {
+                name: string;
+                abbreviation: string | undefined;
+                monthStart: number | null;
+                monthEnd: number | null;
+                dayStart: number | null;
+                dayEnd: number | null;
+            }[];
+        },
+        true,
+        true
+    >;
+};
+
+/** A definition of a month within a calendar year. */
+type MonthSchema = {
+    /** The full name of the month. */
+    name: fields.StringField<string, string, true, false, false>;
+    /** The abbreviated name of the month. */
+    abbreviation: fields.StringField;
+    /** The ordinal position of this month in the year. */
+    ordinal: fields.NumberField<number, number, true, false, false>;
+    /** The number of days in the month. */
+    days: fields.NumberField<number, number, true, false, false>;
+    /** The number of days in the month during a leap year. If not defined the value of days is used. */
+    leapDays: fields.NumberField;
+};
+
+export const SIMPLIFIED_GREGORIAN_CALENDAR_CONFIG: CalendarConfig;
+
+export {};

package/src/client/data/client-backend.d.mts

@@ -0,0 +1,82 @@
+import {
+    DatabaseBackend,
+    DatabaseCreateOperation,
+    DatabaseDeleteOperation,
+    DatabaseGetOperation,
+    DatabaseUpdateOperation,
+    Document,
+} from "./../../common/abstract/_module.mjs";
+import BaseUser from "./../../common/documents/user.mjs";
+import { CompendiumIndexData } from "./../documents/collections/compendium-collection.mjs";
+import User from "./../documents/user.mjs";
+
+/**
+ * The client-side database backend implementation which handles Document modification operations.
+ */
+export default class ClientDatabaseBackend extends DatabaseBackend {
+    /* -------------------------------------------- */
+    /*  Get Operations                              */
+    /* -------------------------------------------- */
+
+    protected override _getDocuments<TDocument extends Document>(
+        documentClass: AbstractConstructorOf<TDocument>,
+        operation: DatabaseGetOperation<TDocument["parent"]>,
+        user?: User,
+    ): Promise<TDocument[]>;
+    protected override _getDocuments<TDocument extends Document>(
+        documentClass: AbstractConstructorOf<TDocument>,
+        operation: DatabaseGetOperation<TDocument["parent"]>,
+        user?: BaseUser,
+    ): Promise<TDocument[]>;
+
+    /* -------------------------------------------- */
+    /*  Create Operations                           */
+    /* -------------------------------------------- */
+
+    protected override _createDocuments<TDocument extends Document>(
+        documentClass: ConstructorOf<TDocument>,
+        operation: DatabaseCreateOperation<TDocument["parent"]>,
+        user: User,
+    ): Promise<(CompendiumIndexData | TDocument)[]>;
+
+    /* -------------------------------------------- */
+    /*  Update Operations                           */
+    /* -------------------------------------------- */
+
+    protected override _updateDocuments<TDocument extends Document>(
+        documentClass: ConstructorOf<TDocument>,
+        operation: DatabaseUpdateOperation<TDocument["parent"]>,
+        user: User,
+    ): Promise<TDocument[]>;
+
+    /* -------------------------------------------- */
+    /*  Delete Operations                           */
+    /* -------------------------------------------- */
+
+    protected override _deleteDocuments<TDocument extends Document>(
+        documentClass: ConstructorOf<TDocument>,
+        operation: DatabaseDeleteOperation<TDocument["parent"]>,
+        user: User,
+    ): Promise<TDocument[]>;
+
+    /* -------------------------------------------- */
+    /*  Socket Workflows                            */
+    /* -------------------------------------------- */
+
+    /**
+     * Activate the Socket event listeners used to receive responses from events which modify database documents
+     * @param socket The active game socket
+     * @internal
+     */
+    activateSocketListeners(socket: io.Socket): void;
+
+    /* -------------------------------------------- */
+    /*  Helper Methods                              */
+    /* -------------------------------------------- */
+
+    override getFlagScopes(): string[];
+
+    override getCompendiumScopes(): string[];
+
+    protected override _log(level: string, message: string): void;
+}

package/src/client/data/combat-config.d.mts

@@ -0,0 +1,84 @@
+import * as fields from "../../common/data/fields.mjs";
+import { TurnMarkerAnimationData } from "../canvas/placeables/tokens/turn-marker-data.mjs";
+
+/**
+ * A configuration class managing the Combat Turn Markers.
+ */
+export default class CombatConfiguration {
+    constructor();
+
+    /**
+     * The configuration setting used to record Combat preferences
+     */
+    static CONFIG_SETTING: "combatTrackerConfig";
+
+    /**
+     * The data model schema used to structure and validate the stored setting.
+     */
+    static get schema(): fields.SchemaField;
+
+    /**
+     * Register the token ring config and initialize it
+     */
+    static initialize(): void;
+
+    /**
+     * Register game settings used by the Combat Tracker
+     */
+    static registerSettings(): void;
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Get turn marker settings.
+     */
+    get turnMarker(): object;
+
+    /**
+     * Get tracked resource setting.
+     */
+    get resource(): string;
+
+    /**
+     * Get skip defeated setting.
+     */
+    get skipDefeated(): boolean;
+
+    /**
+     * Get current turn marker animation.
+     */
+    get currentTurnMarkerAnimation(): TurnMarkerAnimationData;
+
+    /* -------------------------------------------- */
+    /*  Management                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Add a new turn marker animation.
+     * @param id     The id of the turn marker animation.
+     * @param config The configuration object for the turn marker animation.
+     */
+    addTurnMarkerAnimation(id: string, config: TurnMarkerAnimationData): void;
+
+    /**
+     * Get a turn marker animation by id.
+     * @param id The id of the turn marker configuration.
+     * @returns The turn marker configuration object.
+     */
+    getTurnMarkerAnimation(id: string): TurnMarkerAnimationData;
+
+    /**
+     * Use a turn marker animation.
+     * @param animationId The id of the turn marker animation to use.
+     * @returns True if the animation was successfully set, false otherwise.
+     */
+    useTurnMarkerAnimation(animationId: string): boolean;
+
+    /**
+     * Get all animations and labels as an array of choices suitable for a select element.
+     * @returns An array of objects containing an id and a localized label.
+     */
+    get turnMarkerAnimations(): { value: string; label: string }[];
+}

package/src/client/data/region-behaviors/_module.d.mts

@@ -0,0 +1,9 @@
+export { default as AdjustDarknessLevelRegionBehaviorType } from "./adjust-darkness-level.mjs";
+export { default as RegionBehaviorType } from "./base.mjs";
+export { default as ExecuteMacroRegionBehaviorType } from "./execute-macro.mjs";
+export { default as ExecuteScriptRegionBehaviorType } from "./execute-script.mjs";
+export { default as ModifyMovementCostRegionBehaviorType } from "./increase-movement-cost.mjs";
+export { default as PauseGameRegionBehaviorType } from "./pause-game.mjs";
+export { default as SuppressWeatherRegionBehaviorType } from "./suppress-weather.mjs";
+export { default as TeleportTokenRegionBehaviorType } from "./teleport-token.mjs";
+export { default as ToggleBehaviorRegionBehaviorType } from "./toggle-behavior.mjs";

package/src/client/data/region-behaviors/adjust-darkness-level.d.mts

@@ -0,0 +1,29 @@
+import * as fields from "./../../../common/data/fields.mjs";
+import RegionBehaviorType from "./base.mjs";
+
+/**
+ * The data model for a behavior that allows to suppress weather effects within the Region
+ */
+export default class AdjustDarknessLevelRegionBehaviorType extends RegionBehaviorType<AdjustDarknessLevelRegionBehaviorSchema> {
+    static override defineSchema(): AdjustDarknessLevelRegionBehaviorSchema;
+
+    /** Darkness level behavior modes. */
+    static get MODES(): {
+        /** Override the darkness level with the modifier. */
+        OVERRIDE: 0;
+        /** Brighten the darkness level: `darknessLevel * (1 - modifier)` */
+        BRIGHTEN: 1;
+        /** Darken the darkness level: `1 - (1 - darknessLevel) * (1 - modifier)`. */
+        DARKEN: 2;
+    };
+}
+
+export default interface AdjustDarknessLevelRegionBehaviorType
+    extends RegionBehaviorType<AdjustDarknessLevelRegionBehaviorSchema>, fields.ModelPropsFromSchema<AdjustDarknessLevelRegionBehaviorSchema> {}
+
+export type AdjustDarknessLevelRegionBehaviorSchema = {
+    mode: fields.NumberField<AdjustDarknessLevelRegionBehaviorModes, AdjustDarknessLevelRegionBehaviorModes, true>;
+    modifier: fields.AlphaField;
+};
+
+type AdjustDarknessLevelRegionBehaviorModes = (typeof AdjustDarknessLevelRegionBehaviorType.MODES)[keyof typeof AdjustDarknessLevelRegionBehaviorType.MODES];

package/src/client/data/region-behaviors/base.d.mts

@@ -0,0 +1,70 @@
+import { DataSchema } from "./../../../common/abstract/_types.mjs";
+import TypeDataModel from "./../../../common/abstract/type-data.mjs";
+import { REGION_EVENTS } from "./../../../common/constants.mjs";
+import * as fields from "./../../../common/data/fields.mjs";
+import { RegionEvent, TokenMovementWaypoint } from "./../../documents/_types.mjs";
+import RegionBehavior from "./../../documents/region-behavior.mjs";
+import TokenDocument from "./../../documents/token.mjs";
+
+/**
+ * The data model for a behavior that receives Region events. *
+ */
+export default abstract class RegionBehaviorType<
+    TSchema extends DataSchema = DataSchema,
+    TParent extends RegionBehavior | null = RegionBehavior | null,
+> extends TypeDataModel<TParent, TSchema> {
+    /**
+     * Create the events field.
+     * @param options Options which configure how the events field is declared
+     * @param options.events The event names to restrict to.
+     * @param options.initial The initial set of events that should be default for the field
+     */
+    protected static _createEventsField({ events, initial }?: { events: string[]; initial: string[] }): EventsField;
+
+    /**
+     * A RegionBehaviorType may register to always receive certain events by providing a record of handler functions.
+     * These handlers are called with the behavior instance as its bound scope.
+     */
+    static events: Record<string, EventBehaviorStaticHandler>;
+
+    /** The events that are handled by the behavior. */
+    events: fields.ModelPropFromDataField<EventsField>;
+
+    /** A convenience reference to the RegionBehavior which contains this behavior sub-type. */
+    get behavior(): RegionBehavior | null;
+
+    /** A convenience reference to the RegionDocument which contains this behavior sub-type. */
+    get region(): RegionBehavior["region"];
+
+    /** A convenience reference to the Scene which contains this behavior sub-type. */
+    get scene(): RegionBehavior["scene"];
+
+    /**
+     * Handle the Region event.
+     * @param {RegionEvent} event    The Region event
+     * @internal
+     */
+    protected _handleRegionEvent(event: RegionEvent): Promise<void>;
+
+    /**
+     * Get the terrain effects of this behavior for the movement of the given token.
+     * This function is called only for behaviors that are not disabled.
+     * The terrain data is created from the terrain effects
+     * ({@link CONFIG.Token.movement.TerrainData.resolveTerrainEffects}).
+     * Returns an empty array by default.
+     * @param token The token being or about to be moved within the region of this behavior
+     * @param segment The segment data of the token's movement
+     * @returns The terrain effects that apply to this token's movement
+     */
+    protected _getTerrainEffects(
+        token: TokenDocument,
+        segment: Pick<TokenMovementWaypoint, "width" | "height" | "shape" | "action"> & { preview: boolean },
+    ): object[];
+}
+
+/** Run in the context of a {@link RegionBehaviorType} */
+type EventBehaviorStaticHandler = <TBehaviorType extends RegionBehaviorType>(this: TBehaviorType, event: RegionEvent) => Promise<void>;
+
+type RegionEventType = (typeof REGION_EVENTS)[keyof typeof REGION_EVENTS];
+
+export type EventsField = fields.SetField<fields.StringField<RegionEventType, RegionEventType, true, false, false>>;

package/src/client/data/region-behaviors/execute-macro.d.mts

@@ -0,0 +1,17 @@
+import * as fields from "./../../../common/data/fields.mjs";
+import RegionBehaviorType, { EventsField } from "./base.mjs";
+
+/** The data model a behavior that executes a Macro. */
+export default class ExecuteMacroRegionBehaviorType extends RegionBehaviorType<ExecuteMacroRegionBehaviorTypeSchema> {
+    static override defineSchema(): ExecuteMacroRegionBehaviorTypeSchema;
+}
+
+export default interface ExecuteMacroRegionBehaviorType
+    extends RegionBehaviorType<ExecuteMacroRegionBehaviorTypeSchema>, fields.ModelPropsFromSchema<ExecuteMacroRegionBehaviorTypeSchema> {}
+
+export type ExecuteMacroRegionBehaviorTypeSchema = {
+    /** The events that are handled by the behavior. */
+    events: EventsField;
+    /** The Macro UUID. */
+    uuid: fields.DocumentUUIDField;
+};

package/src/client/data/region-behaviors/execute-script.d.mts

@@ -0,0 +1,15 @@
+import * as fields from "./../../../common/data/fields.mjs";
+import RegionBehaviorType, { EventsField } from "./base.mjs";
+
+/** The data model for a behavior that executes a script. */
+export default class ExecuteScriptRegionBehaviorType extends RegionBehaviorType<ExecuteScriptRegionBehaviorTypeSchema> {}
+
+export default interface ExecuteScriptRegionBehaviorType
+    extends RegionBehaviorType<ExecuteScriptRegionBehaviorTypeSchema>, fields.ModelPropsFromSchema<ExecuteScriptRegionBehaviorTypeSchema> {}
+
+export type ExecuteScriptRegionBehaviorTypeSchema = {
+    /** The events that are handled by the behavior. */
+    events: EventsField;
+    /** The source code of the script. */
+    source: fields.JavaScriptField;
+};

package/src/client/data/region-behaviors/increase-movement-cost.d.mts

@@ -0,0 +1,36 @@
+import * as fields from "./../../../common/data/fields.mjs";
+import { TokenMovementWaypoint } from "./../../documents/_types.mjs";
+import TokenDocument from "./../../documents/token.mjs";
+import RegionBehaviorType, { EventBehaviorStaticHandler } from "./base.mjs";
+
+/**
+ * @import {RegionBehaviorViewedEvent, RegionBehaviorUnviewedEvent,
+ *   RegionRegionBoundaryEvent} from "./../../documents/_types.mjs";
+ */
+
+/**
+ * The data model for a behavior that allows to modify the movement cost within the Region.
+ *
+ * @property {{[movementAction: string]: number}} difficulties    The difficulty of each movement action
+ */
+export default class ModifyMovementCostRegionBehaviorType extends RegionBehaviorType {
+    /** @override */
+    static override LOCALIZATION_PREFIXES: string[];
+
+    static override defineSchema(): ModifyMovementCostBehaviorSchema;
+
+    static override events: Record<string, EventBehaviorStaticHandler>;
+
+    override prepareBaseData(): void;
+
+    protected override _onUpdate(changed: Record<string, unknown>, options: object, userId: string): void;
+
+    protected override _getTerrainEffects(
+        token: TokenDocument,
+        segment: Pick<TokenMovementWaypoint, "width" | "height" | "shape" | "action"> & { preview: boolean },
+    ): { name: "difficulty"; difficulty: number }[];
+}
+
+export type ModifyMovementCostBehaviorSchema = {
+    difficulties: fields.SchemaField<Record<string, fields.NumberField<number, number, true, true, true>>>;
+};

package/src/client/data/region-behaviors/pause-game.d.mts

@@ -0,0 +1,15 @@
+import * as fields from "./../../../common/data/fields.mjs";
+import RegionBehaviorType from "./base.mjs";
+
+/** The data model for a behavior that pauses the game when a player-controlled Token enters the Region. */
+export default class PauseGameRegionBehaviorType extends RegionBehaviorType<PauseGameRegionBehaviorTypeSchema> {
+    static override defineSchema(): PauseGameRegionBehaviorTypeSchema;
+}
+
+export default interface PauseGameRegionBehaviorType
+    extends RegionBehaviorType<PauseGameRegionBehaviorTypeSchema>, fields.ModelPropsFromSchema<PauseGameRegionBehaviorTypeSchema> {}
+
+export type PauseGameRegionBehaviorTypeSchema = {
+    /** Disable the behavior once a player-controlled Token enters the region? */
+    once: fields.BooleanField;
+};

package/src/client/data/region-behaviors/suppress-weather.d.mts

@@ -0,0 +1,13 @@
+import { DataSchema } from "./../../../common/abstract/_types.mjs";
+import * as fields from "./../../../common/data/fields.mjs";
+import RegionBehaviorType from "./base.mjs";
+
+/** The data model for a behavior that allows to suppress weather effects within the Region */
+export default class SuppressWeatherRegionBehaviorType extends RegionBehaviorType<SuppressWeatherRegionBehaviorTypeSchema> {
+    static override defineSchema(): SuppressWeatherRegionBehaviorTypeSchema;
+}
+
+export default interface SuppressWeatherRegionBehaviorType
+    extends RegionBehaviorType<SuppressWeatherRegionBehaviorTypeSchema>, fields.ModelPropsFromSchema<SuppressWeatherRegionBehaviorTypeSchema> {}
+
+export type SuppressWeatherRegionBehaviorTypeSchema = DataSchema;