optolith-database-schema 0.1.1 → 0.1.4

package/lib/types/_Activatable.d.ts

@@ -2,6 +2,7 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
+import { Duration } from "./_ActivatableSkill";
 import { Identifier } from "./_Identifier";
 import { Prerequisite } from "./_Prerequisite";
 /**
@@ -28,9 +29,19 @@ export declare type NameInLibrary = string;
  */
 export declare type Levels = number;
 /**
+ * The number stating how often you can buy the entry. The **default** depends on
+ * the entry type:
  *
+ * - **Advantage:** `1` in all cases (as specified in the **Core Rules**)
+ * - **Disadvantage:** `1` in all cases (as specified in the **Core Rules**)
+ * - **Special Abilities:** `1` if no options can be selected, otherwise the
+ *   number of possible options
+ *
+ * The maximum is only set if it differs from the defaults specified above.
+ * @integer
+ * @minimum 1
  */
-export declare type Maximum = "";
+export declare type Maximum = number;
 /**
  *
  */
@@ -182,19 +193,688 @@ export declare type SkillUses = {
 /**
  * The penalty the special ability gives when used.
  */
-export declare type Penalty = "";
+export declare type Penalty = {
+    tag: "Single";
+    /**
+     * The penalty value.
+     * @integer
+     */
+    value: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByHandedness";
+    /**
+     * The penalty value for one-handed weapons.
+     * @integer
+     */
+    one_handed: number;
+    /**
+     * The penalty value for two-handed weapons.
+     * @integer
+     */
+    two_handed: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByActivation";
+    /**
+     * The penalty value if the entry has been bought by the character.
+     * @integer
+     */
+    active: number;
+    /**
+     * The penalty value if the entry has not been bought by the character.
+     * @integer
+     */
+    inactive: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "Selection";
+    options: {
+        tag: "Specific";
+        /**
+         * The list of specific penalty options.
+         * @minItems 2
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The penalty value.
+             * @integer
+             */
+            value: number;
+        }[];
+    } | {
+        tag: "Range";
+        /**
+         * The minimum penalty value.
+         * @integer
+         */
+        minimum: number;
+        /**
+         * The maximum penalty value.
+         * @integer
+         */
+        maximum: number;
+    };
+} | {
+    tag: "ByLevel";
+    /**
+     * A continuous range of penalties for each level. The first element is the
+     * penalty for the first level, the second element is the penalty for the
+     * second level, and so on.
+     * @minItems 2
+     */
+    levels: {
+        /**
+         * The penalty value for this level.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The identifier of the combat-related special ability of which the level
+     * defines the penalty instead.
+     */
+    external_id?: Identifier.Group.CombatRelatedSpecialAbility;
+} | {
+    tag: "ByAttack";
+    /**
+     * A list of penalties for subsequent attacks. The first element is the
+     * penalty for the first attack, the second element is the penalty for the
+     * second attack, and so on. The order of the first element may be changed
+     * using `initial_order`, so that e.g. if set to `2`, the first element is
+     * the penalty for the second attack, the second element is the penalty for
+     * the third attack, and so on.
+     * @minItems 1
+     */
+    list: {
+        /**
+         * The penalty value for this order.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The order of the first element in the `list` of penalties.
+     */
+    initial_order?: number;
+    /**
+     * Set if a predefined different word should be used instead of the word
+     * `attack` for display purposes.
+     */
+    attack_replacement?: {
+        tag: "Throw";
+    };
+} | {
+    tag: "DependsOnHitZone";
+};
+export declare type EnchantmentCost = {
+    tag: "ArcaneEnergyCost";
+    ae_cost: ArcaneEnergyCost;
+} | {
+    tag: "BindingCost";
+    binding_cost: BindingCost;
+};
 /**
  * The AE Cost.
  */
-export declare type ArcaneEnergyCost = "";
+export declare type ArcaneEnergyCost = {
+    tag: "Fixed";
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * Set to `true` if the AE costs are permanent.
+     * @integer
+     * @minimum 1
+     */
+    is_permanent?: true;
+    /**
+     * Specified if the AE cost `value` has to be paid for each time interval.
+     */
+    interval?: Duration.UnitValue;
+    /**
+     * The AE cost are per level of the enchantment. It may either be displayed
+     * in a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1
+     * AE for level I; 2 AE for level II`).
+     */
+    per_level?: {
+        tag: "Compressed";
+    } | {
+        tag: "Verbose";
+    };
+    /**
+     * 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]: {
+            /**
+             * 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: "PerCountable";
+    /**
+     * The AE cost value that has to be per a specific countable entity.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * If defined, in addition to the cost per entity you have to pay a flat
+     * amount, regardless of the entity count.
+     * @integer
+     * @minimum 1
+     */
+    base_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;
+            };
+            /**
+             * 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: "ActivationAndHalfInterval";
+    /**
+     * The AE cost value that has to be payed for activation. Half of this value
+     * has to be payed each interval.
+     * @integer
+     * @minimum 2
+     * @multipleOf 2
+     */
+    value: number;
+    /**
+     * The time interval for which the AE cost `value` has to be paid.
+     */
+    interval: Duration.UnitValue;
+} | {
+    tag: "Indefinite";
+    /**
+     * The indefinite AE cost may be modified by a certain value.
+     */
+    modifier: {
+        /**
+         * The arithmetic how to apply the `value` to the indefinite base value.
+         */
+        arithmetic: {
+            tag: "Add";
+        } | {
+            tag: "Multiply";
+        };
+        /**
+         * The value that is applied to the indefinite base value using the
+         * defined `arithmetic`.
+         * @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 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;
+            };
+        };
+    };
+} | {
+    tag: "Disjunction";
+    /**
+     * Specified if the selected AE cost option has to be paid for each time
+     * interval.
+     */
+    interval?: {
+        /**
+         * The interval itself.
+         */
+        value: Duration.UnitValue;
+        /**
+         * The AE cost value for activation.
+         * @integer
+         * @minimum 1
+         */
+        activation_value: number;
+        /**
+         * Set to `true` if the action where the enchantment is casted does
+         * **not** as a part of the first interval that has to be payed, so that
+         * the first interval payment needs to be done after the activation.
+         *
+         * This works different than other sustained spells, since for them the
+         * end of the cast usually already counts as part of the first interval.
+         */
+        after_activation: boolean;
+    };
+    /**
+     * The possible AE cost values.
+     */
+    options: {
+        /**
+         * A possible 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]: {
+                /**
+                 * A note, appended to the generated option 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: "None";
+    /**
+     * 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]: {
+            /**
+             * 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: "Variable";
+};
 /**
  * The volume points the enchantment needs.
  */
-export declare type Volume = "";
+export declare type Volume = {
+    tag: "Fixed";
+    /**
+     * The volume points.
+     * @integer
+     * @minimum 0
+     */
+    points: number;
+} | {
+    tag: "PerLevel";
+    /**
+     * The volume points per level.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+} | {
+    tag: "ByLevel";
+    /**
+     * The volume points for each level. The first element is the volume points
+     * for the first level, the second element is the volume points for the
+     * second level, and so on.
+     * @minItems 2
+     */
+    list: {
+        /**
+         * The volume points for this level.
+         * @integer
+         * @minimum 0
+         */
+        points: number;
+    }[];
+} | {
+    tag: "Map";
+    map: VolumeMap;
+};
+/**
+ * A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead /
+ * Fairies, Ghosts / Demons, Elementals` may be respresented as the following
+ * map:
+ *
+ * ```yaml
+ * options:
+ *   - points: 3
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Chimera, Daimonid, Golems, Undead"
+ *         label_standalone: "Chimera/Daimonid/Golems/Undead"
+ *   - points: 4
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Fairies, Ghosts"
+ *         label_standalone: "Fairies/Ghosts"
+ *   - points: 5
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Demons, Elementals"
+ *         label_standalone: "Demons/Elementals"
+ * ```
+ *
+ * This will generate the exact same string as seen above. The associated
+ * options are not present in the example, but they link to the options the
+ * volume specification is meant for.
+ */
+export declare type VolumeMap = {
+    /**
+     * The possible costs and associated labels.
+     * @minItems 2
+     */
+    options: VolumeMapOption[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * Place a string between the `for` and the grouped map option labels.
+             */
+            list_prepend?: string;
+            /**
+             * Place a string after the grouped map option labels.
+             */
+            list_append?: string;
+            /**
+             * If the string from the book cannot be generated using the default
+             * generation technique, use this string. All options still need to be
+             * inserted propertly, since it may be used by in-game tools to provide a
+             * selection to players.
+             */
+            replacement?: string;
+        };
+    };
+};
+export declare type VolumeMapOption = {
+    /**
+     * The full permanent AE cost value for this option.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+    /**
+     * Links to the options this volume specification is meant for.
+     */
+    associated_options: {
+        /**
+         * The option's identifier.
+         */
+        id: Identifier.Group.VolumePointsOptionReference;
+    }[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The description of the option for cost string generation.
+             * @minLength 1
+             */
+            label: string;
+            /**
+             * The description of the option if used standalone. Only used if
+             * different from `label`.
+             * @minLength 1
+             */
+            label_standalone?: string;
+        };
+    };
+};
 /**
  * The binding cost for an enchantment.
  */
-export declare type BindingCost = "";
+export declare type BindingCost = {
+    tag: "Fixed";
+    /**
+     * The permanent AE cost.
+     * @integer
+     * @minimum 1
+     */
+    permanent_value: number;
+} | {
+    tag: "PerLevel";
+    /**
+     * The permanent AE cost per level.
+     * @integer
+     * @minimum 1
+     */
+    permanent_value: number;
+} | {
+    tag: "Map";
+    map: BindingCostMap;
+};
+/**
+ * A content that is `2/4/8 permanent AE for spell-swords with the combat
+ * technique Daggers, Swords, or Two-Handed Swords` may be respresented as the
+ * following map:
+ *
+ * ```yaml
+ * options:
+ *   - permanent_value: 2
+ *     translations:
+ *       en-US:
+ *         label: "Daggers"
+ *         label_standalone: "Dagger"
+ *   - permanent_value: 4
+ *     translations:
+ *       en-US:
+ *         label: "Swords"
+ *         label_standalone: "Sword"
+ *   - permanent_value: 8
+ *     translations:
+ *       en-US:
+ *         label: "Two-Handed Swords"
+ *         label_standalone: "Two-Handed Sword"
+ * list_prepend: "spell-swords with the combat technique"
+ * ```
+ *
+ * This will generate the exact same string as seen above.
+ */
+export declare type BindingCostMap = {
+    /**
+     * The possible costs and associated labels.
+     * @minItems 2
+     */
+    options: VolumeMapOption[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * Place a string between the `for` and the grouped map option labels.
+             */
+            list_prepend?: string;
+            /**
+             * Place a string after the grouped map option labels.
+             */
+            list_append?: string;
+            /**
+             * If the string from the book cannot be generated using the default
+             * generation technique, use this string. All options still need to be
+             * inserted propertly, since it may be used by in-game tools to provide a
+             * selection to players.
+             */
+            replacement?: string;
+        };
+    };
+};
+export declare type BindingCostMapOption = {
+    /**
+     * The full permanent AE cost value for this option.
+     * @integer
+     * @minimum 1
+     */
+    permanent_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]: {
+            /**
+             * The description of the option for cost string generation.
+             * @minLength 1
+             */
+            label: string;
+            /**
+             * The description of the option if used standalone. Only used if
+             * different from `label`.
+             * @minLength 1
+             */
+            label_standalone?: string;
+        };
+    };
+};
 /**
  * The magic property's identifier. `DependingOnProperty` can only be used if
  * the special ability has an option to select a property.