optolith-database-schema 0.1.27 → 0.2.1

package/lib/types/equipment/_Weapon.d.ts

@@ -0,0 +1,330 @@
+/**
+ *
+ */
+import { Dice } from "../_Dice";
+/**
+ * The structure points of the item. Use an array if the item consists of
+ * multiple components that have individual structure points.
+ * @title Structure Points
+ * @minItems 1
+ */
+export declare type StructurePoints = {
+    /**
+     * The structure points.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+}[];
+/**
+ * If the weapon is sanctified by a god and thus restricted to it's Blessed
+ * Ones.
+ */
+export declare type SanctifiedBy = {
+    /**
+     * The tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+/**
+ * Define if during character creation this weapon can only be bought by
+ * characters of a specific race or culture.
+ */
+export declare type RestrictedToCultures = {
+    tag: "CulturesOfRace";
+    /**
+     * The race's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Culture";
+    /**
+     * The culture's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Cultures";
+    /**
+     * The cultures' identifiers.
+     * @minitems 1
+     */
+    list: {
+        /**
+         * The culture's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    };
+};
+/**
+ * The primary attribute damage and threshold value. You can either use an
+ * integer, an object or a pair. Use an integer if you just have to define a
+ * single threshold value for the default primary attribute of the combat
+ * technique. Use an object if you need to define the value only or if you need
+ * to define the value as well as a single different primary attribute than
+ * which the combat technique uses. Use the pair if you need to set the primary
+ * attributes to AGI and STR (the combat technique has AGI but this item has
+ * AGI/STR) and/or if you need to set different thresholds for AGI and STR (e.g.
+ * AGI 14/STR 15). If the same values are in the pair, they will be merged (AGI
+ * 14/STR 14 will be AGI/STR 14).
+ */
+declare type PrimaryAttributeDamageThreshold = {
+    tag: "Single";
+    /**
+     * The primary attribute(s) if different from the default primary
+     * attribute(s) of the combat technique.
+     * @minItems 1
+     * @uniqueItems
+     */
+    attribute?: {
+        /**
+         * The attribute's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+    /**
+     * The attribute value representing the damage threshold.
+     * @integer
+     * @minimum 1
+     */
+    threshold: number;
+} | {
+    tag: "Differing";
+    /**
+     * A list of primary attributes, each featuring a different threshold.
+     * @minItems 2
+     * @uniqueItems
+     */
+    list: {
+        /**
+         * The primary attribute.
+         */
+        attribute: {
+            /**
+             * The attribute's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        };
+        /**
+         * The attribute value representing the damage threshold.
+         * @integer
+         * @minimum 1
+         */
+        threshold: number;
+    }[];
+};
+/**
+ * The damage of a weapon consists of a random part using dice and an optional
+ * flat part.
+ */
+declare type DamageMelee = {
+    /**
+     * How many dice of which type are rolled to get the damage.
+     */
+    dice: Dice;
+    /**
+     * Flat damage, if any. It gets added to the result of the dice rolls.
+     * @integer
+     * @default 0
+     */
+    flat?: number;
+};
+/**
+ * The damage of a ranged weapon. It consists of a random part using dice and an
+ * optional flat part ny default. Some ranged weapons may work different so that
+ * damage is either not applicable at all or it is outlined as *Special* and
+ * further defined in a description.
+ */
+declare type DamageRanged = {
+    tag: "Default";
+    /**
+     * How many dice of which type are rolled to get the damage.
+     */
+    dice: Dice;
+    /**
+     * Flat damage, if any. It gets added to the result of the dice rolls.
+     * @integer
+     * @default 0
+     */
+    flat?: number;
+} | {
+    tag: "NotApplicable";
+} | {
+    tag: "Special";
+};
+/**
+ * The AT modifier.
+ * @integer
+ */
+declare type Attack = number;
+/**
+ * The PA modifier.
+ * @integer
+ */
+declare type Parry = number;
+/**
+ * The reach of the weapon.
+ * @integer
+ * @minimum 1
+ * @maximum 4
+ */
+declare type Reach = number;
+/**
+ * The length of the weapon in cm/halffingers.
+ * @integer
+ * @minimum 1
+ */
+declare type Length = number;
+/**
+ */
+declare type ShieldSize = {
+    tag: "Large";
+    /**
+     * The attack penalty from the shield.
+     * @integer
+     * @default 1
+     */
+    attack_penalty?: number;
+} | {
+    tag: "Medium";
+} | {
+    tag: "Small";
+};
+/**
+ * @title Melee Weapon
+ */
+export declare type MeleeWeapon = {
+    tag: "Melee";
+    /**
+     * The combat techniques and dependent values.
+     */
+    combat_technique: {
+        tag: "ChainWeapons";
+        damage_threshold: PrimaryAttributeDamageThreshold;
+        at: Attack;
+        reach: Reach;
+        length: Length;
+    } | {
+        tag: "Whips";
+        damage_threshold: PrimaryAttributeDamageThreshold;
+        at: Attack;
+        reach: Reach;
+        length: Length;
+    } | {
+        tag: "Lances";
+        at: Attack;
+        length: Length;
+    } | {
+        tag: "Shields";
+        size: ShieldSize;
+        damage_threshold: PrimaryAttributeDamageThreshold;
+        at: Attack;
+        pa: Parry;
+        reach: Reach;
+    } | {
+        tag: "Fans";
+        size: ShieldSize;
+        damage_threshold: PrimaryAttributeDamageThreshold;
+        at: Attack;
+        pa: Parry;
+        reach: Reach;
+        length: Length;
+    } | {
+        tag: "Default";
+        /**
+         * The close combat technique's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        damage_threshold: PrimaryAttributeDamageThreshold;
+        at: Attack;
+        pa: Parry;
+        reach: Reach;
+        length: Length;
+    };
+    damage: DamageMelee;
+    /**
+     * Is the weapon a parrying weapon?
+     */
+    is_parrying_weapon: boolean;
+    /**
+     * Is the weapon a two-handed weapon?
+     */
+    is_two_handed_weapon: boolean;
+};
+/**
+ * @title Ranged Weapon
+ */
+export declare type RangedWeapon = {
+    tag: "Ranged";
+    /**
+     * The combat techniques and dependent values.
+     */
+    combat_technique: {
+        tag: "ThrownWeapons";
+    } | {
+        tag: "Default";
+        /**
+         * The needed ammunition.
+         */
+        ammunition: {
+            /**
+             * The item's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        };
+    };
+    damage: DamageRanged;
+    /**
+     * The range brackets for the weapon: close, medium, far. Distances in m.
+     */
+    range: {
+        /**
+         * The close range bracket for the weapon. Distance in m.
+         * @integer
+         * @minimum 1
+         */
+        close: number;
+        /**
+         * The medium range bracket for the weapon. Distance in m.
+         * @integer
+         * @minimum 1
+         */
+        medium: number;
+        /**
+         * The far range bracket for the weapon. Distance in m.
+         * @integer
+         * @minimum 1
+         */
+        far: number;
+    };
+    /**
+     * One or multiple reload times.
+     * @minItems 1
+     * @uniqueItems
+     */
+    reload_time: {
+        /**
+         * A reload time value in actions.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    }[];
+    length: Length;
+};
+export {};

package/lib/types/equipment/_Weapon.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.27",
+  "version": "0.2.1",
   "description": "Definitions and utilities for the flat-file database of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”, and its external integrations into other software.",
   "keywords": [
     "tde",

package/schema/Race.schema.json

@@ -287,7 +287,7 @@
           },
           "sides": {
             "description": "Number of sides on every die. Example: 6 in 2D6.",
-            "$ref": "#/definitions/DieType"
+            "$ref": "./_Dice.schema.json#/definitions/DieType"
           },
           "offset_strategy": {
             "description": "The strategy how to offset the randomly generated values against the\nbase value. Either they are all added or subtracted or even results are\nadded and odd results are subtracted.",
@@ -359,7 +359,7 @@
         },
         "random": {
           "description": "The random value for the selected experience level. It is going to be\nadded to the base value.",
-          "$ref": "#/definitions/Die"
+          "$ref": "./_Dice.schema.json#/definitions/Dice"
         }
       },
       "required": [
@@ -589,7 +589,7 @@
           "description": "The dice used for random height.",
           "type": "array",
           "items": {
-            "$ref": "#/definitions/Die"
+            "$ref": "./_Dice.schema.json#/definitions/Dice"
           },
           "minItems": 1
         }
@@ -691,34 +691,6 @@
         "attribute_adjustments"
       ],
       "additionalProperties": false
-    },
-    "Die": {
-      "title": "Die",
-      "type": "object",
-      "properties": {
-        "number": {
-          "description": "Number of dice of the same type. Example: 2 in 2D6.",
-          "type": "integer",
-          "minimum": 1
-        },
-        "sides": {
-          "description": "Number of sides on every die. Example: 6 in 2D6.",
-          "$ref": "#/definitions/DieType"
-        }
-      },
-      "required": [
-        "number",
-        "sides"
-      ],
-      "additionalProperties": false
-    },
-    "DieType": {
-      "description": "Number of sides on every dice. Example: 6 in 2D6.",
-      "enum": [
-        3,
-        6,
-        20
-      ]
     }
   }
 }