optolith-database-schema 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.1.3](https://github.com/elyukai/optolith-database-schema/compare/v0.1.2...v0.1.3) (2022-03-09)
+
+
+### Features
+
+* first concept of penalties for combat-related special abilities ([d79d3b3](https://github.com/elyukai/optolith-database-schema/commit/d79d3b3752252342795400c905e2944d1234bd37))
+
+
+### Bug Fixes
+
+* remove generic numeric identifier maximum ([e121081](https://github.com/elyukai/optolith-database-schema/commit/e1210810f9cdbf8a720d0e12d5ec6ac21010a8dd))
+
 ### [0.1.2](https://github.com/elyukai/optolith-database-schema/compare/v0.1.1...v0.1.2) (2022-03-09)
 
 

package/lib/types/_Activatable.d.ts

@@ -182,7 +182,130 @@ 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";
+};
 /**
  * The AE Cost.
  */

package/lib/types/_Identifier.d.ts

@@ -48,6 +48,12 @@ export declare namespace Identifier {
             RingEnchantment = "RingEnchantment",
             ChronicleEnchantment = "ChronicleEnchantment"
         }
+        enum CombatRelatedSpecialAbility {
+            CombatSpecialAbility = "CombatSpecialAbility",
+            CombatStyleSpecialAbility = "CombatStyleSpecialAbility",
+            AdvancedCombatSpecialAbility = "AdvancedCombatSpecialAbility",
+            CommandSpecialAbility = "CommandSpecialAbility"
+        }
         enum Rated {
             Attribute = "Attribute",
             Skill = "Skill",
@@ -73,12 +79,12 @@ export declare namespace Identifier {
          * The referenced entry's numeric identifier.
          * @integer
          * @minimum 1
-         * @maximum 8
          */
         value: number;
     };
     namespace Group {
         type Activatable = Tagged<Tag.Activatable>;
+        type CombatRelatedSpecialAbility = Tagged<Tag.CombatRelatedSpecialAbility>;
         type Rated = Tagged<Tag.Rated>;
         type AdvancedSpecialAbilityRestrictedOption = Tagged<Tag.AdvancedSpecialAbilityRestrictedOption>;
         type CombatTechnique = Tagged<Tag.CombatTechnique>;

package/lib/types/_Identifier.js

@@ -51,6 +51,13 @@ export var Identifier;
             Activatable["RingEnchantment"] = "RingEnchantment";
             Activatable["ChronicleEnchantment"] = "ChronicleEnchantment";
         })(Activatable = Tag.Activatable || (Tag.Activatable = {}));
+        let CombatRelatedSpecialAbility;
+        (function (CombatRelatedSpecialAbility) {
+            CombatRelatedSpecialAbility["CombatSpecialAbility"] = "CombatSpecialAbility";
+            CombatRelatedSpecialAbility["CombatStyleSpecialAbility"] = "CombatStyleSpecialAbility";
+            CombatRelatedSpecialAbility["AdvancedCombatSpecialAbility"] = "AdvancedCombatSpecialAbility";
+            CombatRelatedSpecialAbility["CommandSpecialAbility"] = "CommandSpecialAbility";
+        })(CombatRelatedSpecialAbility = Tag.CombatRelatedSpecialAbility || (Tag.CombatRelatedSpecialAbility = {}));
         let Rated;
         (function (Rated) {
             Rated["Attribute"] = "Attribute";

package/lib/types/specialAbility/AdvancedCombatSpecialAbility.d.ts

@@ -13,6 +13,7 @@ export declare type AdvancedCombatSpecialAbility = {
     usage_type: Activatable.CombatSpecialAbilityType;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
+    penalty?: Activatable.Penalty;
     combat_techniques: Activatable.ApplicableCombatTechniques;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;

package/lib/types/specialAbility/CombatSpecialAbility.d.ts

@@ -13,6 +13,7 @@ export declare type CombatSpecialAbility = {
     usage_type: Activatable.CombatSpecialAbilityType;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
+    penalty?: Activatable.Penalty;
     combat_techniques: Activatable.ApplicableCombatTechniques;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "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/_Activatable.schema.json

@@ -280,7 +280,251 @@
     },
     "Penalty": {
       "description": "The penalty the special ability gives when used.",
-      "const": ""
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Single"
+            },
+            "value": {
+              "description": "The penalty value.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByHandedness"
+            },
+            "one_handed": {
+              "description": "The penalty value for one-handed weapons.",
+              "type": "integer"
+            },
+            "two_handed": {
+              "description": "The penalty value for two-handed weapons.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "one_handed",
+            "two_handed"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByActivation"
+            },
+            "active": {
+              "description": "The penalty value if the entry has been bought by the character.",
+              "type": "integer"
+            },
+            "inactive": {
+              "description": "The penalty value if the entry has not been bought by the character.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "active",
+            "inactive"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Selection"
+            },
+            "options": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Specific"
+                    },
+                    "list": {
+                      "description": "The list of specific penalty options.",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "value": {
+                            "description": "The penalty value.",
+                            "type": "integer"
+                          }
+                        },
+                        "required": [
+                          "value"
+                        ],
+                        "additionalProperties": false
+                      },
+                      "minItems": 2,
+                      "uniqueItems": true
+                    }
+                  },
+                  "required": [
+                    "tag",
+                    "list"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Range"
+                    },
+                    "minimum": {
+                      "description": "The minimum penalty value.",
+                      "type": "integer"
+                    },
+                    "maximum": {
+                      "description": "The maximum penalty value.",
+                      "type": "integer"
+                    }
+                  },
+                  "required": [
+                    "tag",
+                    "minimum",
+                    "maximum"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            }
+          },
+          "required": [
+            "tag",
+            "options"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByLevel"
+            },
+            "levels": {
+              "description": "A continuous range of penalties for each level. The first element is the\npenalty for the first level, the second element is the penalty for the\nsecond level, and so on.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "description": "The penalty value for this level.",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "value"
+                ],
+                "additionalProperties": false
+              },
+              "minItems": 2
+            },
+            "external_id": {
+              "description": "The identifier of the combat-related special ability of which the level\ndefines the penalty instead.",
+              "$ref": "./_Identifier.schema.json#/definitions/Identifier/Group/CombatRelatedSpecialAbility"
+            }
+          },
+          "required": [
+            "tag",
+            "levels"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByAttack"
+            },
+            "list": {
+              "description": "A list of penalties for subsequent attacks. The first element is the\npenalty for the first attack, the second element is the penalty for the\nsecond attack, and so on. The order of the first element may be changed\nusing `initial_order`, so that e.g. if set to `2`, the first element is\nthe penalty for the second attack, the second element is the penalty for\nthe third attack, and so on.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "description": "The penalty value for this order.",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "value"
+                ],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "initial_order": {
+              "description": "The order of the first element in the `list` of penalties.",
+              "type": "number"
+            },
+            "attack_replacement": {
+              "description": "Set if a predefined different word should be used instead of the word\n`attack` for display purposes.",
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Throw"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            }
+          },
+          "required": [
+            "tag",
+            "list"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DependsOnHitZone"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
     },
     "ArcaneEnergyCost": {
       "description": "The AE Cost.",
@@ -506,7 +750,6 @@
         "value": {
           "description": "The referenced entry's numeric identifier.",
           "type": "integer",
-          "maximum": 8,
           "minimum": 1
         }
       },
@@ -525,7 +768,6 @@
         "value": {
           "description": "The referenced entry's numeric identifier.",
           "type": "integer",
-          "maximum": 8,
           "minimum": 1
         }
       },

package/schema/_Identifier.schema.json

@@ -54,6 +54,14 @@
             "ChronicleEnchantment"
           ]
         },
+        "CombatRelatedSpecialAbility": {
+          "enum": [
+            "CombatSpecialAbility",
+            "CombatStyleSpecialAbility",
+            "AdvancedCombatSpecialAbility",
+            "CommandSpecialAbility"
+          ]
+        },
         "Rated": {
           "enum": [
             "Attribute",
@@ -89,7 +97,24 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
+              "minimum": 1
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        "CombatRelatedSpecialAbility": {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "$ref": "#/definitions/Identifier/Tag/CombatRelatedSpecialAbility"
+            },
+            "value": {
+              "description": "The referenced entry's numeric identifier.",
+              "type": "integer",
               "minimum": 1
             }
           },
@@ -108,7 +133,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },
@@ -127,7 +151,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },
@@ -146,7 +169,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },

package/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json

@@ -22,6 +22,9 @@
         "skill_uses": {
           "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
+        "penalty": {
+          "$ref": "../_Activatable.schema.json#/definitions/Penalty"
+        },
         "combat_techniques": {
           "$ref": "../_Activatable.schema.json#/definitions/ApplicableCombatTechniques"
         },

package/schema/specialAbility/CombatSpecialAbility.schema.json

@@ -22,6 +22,9 @@
         "skill_uses": {
           "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
+        "penalty": {
+          "$ref": "../_Activatable.schema.json#/definitions/Penalty"
+        },
         "combat_techniques": {
           "$ref": "../_Activatable.schema.json#/definitions/ApplicableCombatTechniques"
         },