optolith-database-schema 0.0.1

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

@@ -0,0 +1,228 @@
+/**
+ * @main Curse
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+/**
+ * @title Curse
+ */
+export declare type Curse = {
+    /**
+     * The curse'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 curse.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    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 curse.
+             * @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
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a curse.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The AE cost.
+     */
+    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 KP
+                 * per person`
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+                /**
+                 * A note, appended to the generated string in parenthesis.
+                 */
+                note?: {
+                    /**
+                     * The full note.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed note, if applicable. If not specified it should not
+                     * be displayed in small location.
+                     * @minLength 1
+                     */
+                    compressed?: string;
+                };
+            };
+        };
+    } | {
+        tag: "Indefinite";
+        /**
+         * 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 where the cost come from.
+                 */
+                description: {
+                    /**
+                     * The full description of where the cost come from.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of where the cost come from for use in
+                     * small areas (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The unit of the `value`.
+         */
+        unit: Duration.Unit;
+    } | Duration.CheckResultBasedTagged | {
+        tag: "Indefinite";
+        /**
+         * Specified if the duration has a maximum time span.
+         */
+        maximum?: {
+            tag: "Fixed";
+            /**
+             * The (unitless) maximum duration value.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+            /**
+             * The unit of the `value`.
+             */
+            unit: Duration.Unit;
+        } | Duration.CheckResultBasedTagged;
+        /**
+         * 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.
+                 */
+                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/Curse.js

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

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

@@ -0,0 +1,181 @@
+/**
+ * @main DominationRitual
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+/**
+ * @title Domination Ritual
+ */
+export declare type DominationRitual = {
+    /**
+     * The domination 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;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a curse.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    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 domination 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
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a curse.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The AE cost.
+     */
+    cost: {
+        /**
+         * The initial skill modification identifier/level.
+         * @integer
+         * @minimum 1
+         * @maximum 6
+         */
+        initial_modification_level: 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]: {
+                /**
+                 * AE cost in addition to the normal AE cost.
+                 */
+                additional?: {
+                    /**
+                     * The full description of where the cost come from.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of where the cost come from for use in
+                     * small areas (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The unit of the `value`.
+         */
+        unit: Duration.Unit;
+    } | Duration.CheckResultBasedTagged | {
+        tag: "Indefinite";
+        /**
+         * Specified if the duration has a maximum time span.
+         */
+        maximum?: {
+            tag: "Fixed";
+            /**
+             * The (unitless) maximum duration value.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+            /**
+             * The unit of the `value`.
+             */
+            unit: Duration.Unit;
+        } | Duration.CheckResultBasedTagged;
+        /**
+         * 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.
+                 */
+                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/DominationRitual.js

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

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

@@ -0,0 +1,149 @@
+/**
+ * @main ElvenMagicalSong
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+import { SkillReference } from "./_SkillReference";
+/**
+ * @title Elven Magical Song
+ */
+export declare type ElvenMagicalSong = {
+    /**
+     * The elven magical song'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;
+    /**
+     * To enhance their songs, elves can make a check on either *Singing
+     * (Two-Voiced Singing)* or *Music (appropriate application)* before making
+     * the check for the song.
+     * @minItems 1
+     * @maxItems 2
+     * @uniqueItems
+     */
+    skill: SkillReference[];
+    /**
+     * Measurable parameters of an elven magical song.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * 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 elven magical song.
+             * @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
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of an elven magical song.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The AE cost.
+     */
+    cost: {
+        /**
+         * The (temporary) AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * Specified if the AE cost `value` have to paid for each time interval.
+         */
+        interval?: Duration.UnitValue;
+        /**
+         * A permanent AE cost, independent from a possible interval.
+         */
+        permanent?: {
+            /**
+             * The permanent 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}$
+                 */
+                [localeId: string]: {
+                    /**
+                     * A replacement string for the permanent cost.
+                     */
+                    replacement: {
+                        /**
+                         * The full replacement string. It must contain `$1`, which is
+                         * going to be replaced with the generated AE cost string, so
+                         * additional information can be provided without duplicating
+                         * concrete numeric values.
+                         * @minLength 1
+                         * @pattern \$1
+                         */
+                        default: string;
+                        /**
+                         * A compressed replacement string for use in small areas (e.g. on
+                         * character sheet). It must contain `$1`, which is going to be
+                         * replaced with the generated AE cost string, so additional
+                         * information can be provided without duplicating concrete
+                         * numeric values.
+                         * @minLength 1
+                         * @pattern \$1
+                         */
+                        compressed: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export {};

package/lib/types/magicalActions/ElvenMagicalSong.js

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