optolith-database-schema 0.0.1

package/lib/types/magicalActions/GeodeRitual.d.ts

@@ -0,0 +1,162 @@
+/**
+ * @main GeodeRitual
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { CastingTime, Cost, Duration, Effect, TargetCategory } from "../_ActivatableSkill";
+import { GroupCollection } from "../_Prerequisite";
+import { SkillCheck } from "../_SkillCheck";
+/**
+ * @title Geode Ritual
+ */
+export declare type GeodeRitual = {
+    /**
+     * The geode ritual's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * Measurable parameters of a geode ritual.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    prerequisites?: GroupCollection.GeodeRitual;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the geode ritual.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            casting_time: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            range: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a geode ritual.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The casting time.
+     */
+    casting_time: {
+        /**
+         * The (unitless) casting time.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The casting time unit.
+         */
+        unit: CastingTime.SlowSkillCastingTimeUnit;
+    };
+    /**
+     * The AE cost.
+     */
+    cost: {
+        tag: "Fixed";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "Map";
+        map: Cost.OneTime.Map;
+    };
+    /**
+     * The range.
+     */
+    range: {
+        tag: "Self";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 2
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | Duration.CheckResultBasedTagged;
+};
+export {};

package/lib/types/magicalActions/GeodeRitual.js

@@ -0,0 +1,4 @@
+/**
+ * @main GeodeRitual
+ */
+export {};

package/lib/types/magicalActions/JesterTrick.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @main JesterTrick
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect, TargetCategory } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+/**
+ * @title Jester Trick
+ */
+export declare type JesterTrick = {
+    /**
+     * The jester trick's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a jester trick.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the jester trick.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            casting_time: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            range: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a jester trick.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The casting time.
+     * @integer
+     * @minimum 1
+     */
+    casting_time: {
+        /**
+         * The casting time in actions.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    /**
+     * The AE cost.
+     * @integer
+     * @minimum 1
+     */
+    cost: {
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    /**
+     * The range.
+     */
+    range: {
+        tag: "Touch";
+    } | {
+        tag: "Self";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 2
+         */
+        value: number;
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 2
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | Duration.CheckResultBasedTagged;
+};
+export {};

package/lib/types/magicalActions/JesterTrick.js

@@ -0,0 +1,4 @@
+/**
+ * @main JesterTrick
+ */
+export {};

package/lib/types/magicalActions/MagicalDance.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @main MagicalDance
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck } from "../_SkillCheck";
+import { MusicTraditionReference } from "./_MusicTradition";
+/**
+ * @title Magical Dance
+ */
+export declare type MagicalDance = {
+    /**
+     * The magical dance's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * Measurable parameters of a magical dance.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * The music tradition(s) the magical dance is available for. This also
+     * defines the different names in each music tradition.
+     * @minItems 1
+     */
+    music_tradition: MusicTraditionReference[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the magical dance.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a magical dance.
+ */
+declare type PerformanceParameters = {
+    duration: {
+        length: {
+            tag: "Long";
+        } | {
+            tag: "Short";
+        };
+        reusability: {
+            tag: "OneTime";
+        } | {
+            tag: "Sustainable";
+        };
+    };
+    cost: {
+        tag: "Fixed";
+        /**
+         * The (temporary) AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 * The cost have to be per a specific countable entity, e.g. `8 AE per
+                 * person`.
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    } | {
+        tag: "Indefinite";
+        /**
+         * Specified if the indefinite description's result value is to be
+         * modified by a certain number.
+         */
+        modifier?: {
+            /**
+             * The arithmetic how to apply the `value` to the indefinite value.
+             */
+            arithmetic: Duration.CheckResultArithmetic;
+            /**
+             * The value that is applied to the indefinite value using the defined
+             * `arithmetic`.
+             * @integer
+             * @minimum 2
+             */
+            value: number;
+        };
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * A description of the duration.
+                 * @minLength 1
+                 */
+                description: {
+                    /**
+                     * The full description of the duration.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the duration for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+};
+export {};

package/lib/types/magicalActions/MagicalDance.js

@@ -0,0 +1,4 @@
+/**
+ * @main MagicalDance
+ */
+export {};

package/lib/types/magicalActions/MagicalMelody.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @main MagicalMelody
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Effect } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+import { MusicTraditionReference } from "./_MusicTradition";
+import { SkillReference } from "./_SkillReference";
+/**
+ * @title Magical Melody
+ */
+export declare type MagicalMelody = {
+    /**
+     * The magical melody's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Arcane bards must make a *Singing (area of application)* or *Music (area of
+     * application)* check for each magical melody.
+     * @minItems 1
+     * @maxItems 2
+     * @uniqueItems
+     */
+    skill: SkillReference[];
+    /**
+     * Measurable parameters of a magical melody.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * The music tradition(s) the magical melody is available for. This also
+     * defines the different names in each music tradition.
+     * @minItems 1
+     */
+    music_tradition: MusicTraditionReference[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the magical melody.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a magical melody.
+ */
+declare type PerformanceParameters = {
+    duration: {
+        length: {
+            tag: "Long";
+        } | {
+            tag: "Short";
+        };
+        reusability: {
+            tag: "OneTime";
+        } | {
+            tag: "Sustainable";
+        };
+    };
+    cost: {
+        tag: "Fixed";
+        /**
+         * The (temporary) AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "FirstPerson";
+        /**
+         * The (temporary) AE cost value for the first targeted person. The AE
+         * cost for each additional person is half this value.
+         * @integer
+         * @minimum 1
+         * @multipleOf 2
+         */
+        value: number;
+    };
+};
+export {};

package/lib/types/magicalActions/MagicalMelody.js

@@ -0,0 +1,4 @@
+/**
+ * @main MagicalMelody
+ */
+export {};