diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Advantage.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Advantage.swift index 779669e4..b3e513e3 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Advantage.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Advantage.swift @@ -24,12 +24,10 @@ public struct Advantage: LocalizableEntity { public let apValue: AdventurePointsValue - /// Does this advantage count towards the maximum of AP to be spent on - /// advantages? + /// Does this advantage count towards the maximum of AP to be spent on advantages? public let hasMaximumSpentInfluence: Bool - /// Does this advantage exclusively applies to arcane spellworks and not - /// to magical actions and magical applications? + /// Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications? public let isExclusiveToArcaneSpellworks: Bool public let src: PublicationRefs @@ -68,9 +66,7 @@ public struct AdvantageTranslation: EntitySubtype { public let apValue: AdventurePointsValueReplacement? - /// A string that gets appended to the default AP Value text with a preceding - /// space. This always happens if present, even if the generated AP Value text - /// is replaced. + /// A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. public let apValueAppend: AdventurePointsValueAppend? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/AnimalDisease.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/AnimalDisease.swift index 6cb5f718..22ab73c4 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/AnimalDisease.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/AnimalDisease.swift @@ -14,27 +14,20 @@ public struct AnimalDisease: LocalizableEntity { /// The animal disease's level. public let level: Int - /// Depending on the disease, apply Spirit or Toughness as a penalty to the - /// disease roll. It may also happen that the lower of both is applied as a - /// penalty. + /// Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. public let resistance: Resistance - /// What causes the disease? The GM rolls 1D20 to see if a character gets - /// infected. If the infection check succeeds, the GM makes a disease check to - /// determine the severity of the infection. + /// What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. public let cause: [Cause] /// The animal types this disease applies to. /// - /// If no animal types are given, the animal disease applies to all animal - /// types. + /// If no animal types are given, the animal disease applies to all animal types. public let animalTypes: [AnimalTypeReference] - /// If and at which chance the disease can be communicated to intelligent - /// creatures. + /// If and at which chance the disease can be communicated to intelligent creatures. /// - /// If no causes are given, the disease is not communicable to intelligent - /// creatures. + /// If no causes are given, the disease is not communicable to intelligent creatures. public let communicabilityToIntelligentCreatures: [Cause] public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Aspect.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Aspect.swift index 971960c4..0d046938 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Aspect.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Aspect.swift @@ -19,8 +19,7 @@ public struct AspectTranslation: EntitySubtype { /// The aspect name. public let name: NonEmptyString - /// The aspect's name appended to the simple name (not `name_in_library`) - /// of the special ability *Master of (Aspect)*. + /// The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*. public let masterOfAspectSuffix: NonEmptyString? private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Cantrip.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Cantrip.swift index de6aeb58..fe774521 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Cantrip.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Cantrip.swift @@ -20,10 +20,7 @@ public struct Cantrip: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// A note specifying the dissemination of the cantrip in different traditions. - /// Sometimes a cantrip is exclusively available to one or more specific - /// traditions, but usually one the academies and traditions are listed the - /// cantrip is most commonly teached in. + /// A note specifying the dissemination of the cantrip in different traditions. Sometimes a cantrip is exclusively available to one or more specific traditions, but usually one the academies and traditions are listed the cantrip is most commonly teached in. public let note: CantripNote? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Ceremony.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Ceremony.swift index 38b075a2..0ea60fe7 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Ceremony.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Ceremony.swift @@ -23,9 +23,7 @@ public struct Ceremony: LocalizableEntity { /// The target category – the kind of creature or object – the skill affects. public let target: AffectedTargetCategories - /// The tradition(s) the ceremony is available for. Note that general aspects - /// do not have an associated tradition and thus need to be defined in a - /// special way. + /// The tradition(s) the ceremony is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. public let traditions: [SkillTradition] /// States which column is used to improve the skill. @@ -59,14 +57,10 @@ public struct CeremonyTranslation: EntitySubtype { /// The name of the ceremony. public let name: NonEmptyString - /// A compressed name of the ceremony for use in small areas (e.g. on - /// character sheet). Should only be defined if the `name` does not fit on - /// character sheet. + /// A compressed name of the ceremony for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. public let nameCompressed: NonEmptyString? - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Close.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Close.swift index 83dab883..27b26ca2 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Close.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Close.swift @@ -11,8 +11,7 @@ public struct CloseCombatTechnique: LocalizableEntity { /// The close combat technique's identifier. An unique, increasing integer. public let id: Int - /// Special rules for the combat technique that apply to all weapons in this - /// category. + /// Special rules for the combat technique that apply to all weapons in this category. public let special: CloseCombatTechniqueSpecialRules /// The primary attribute(s). @@ -39,8 +38,7 @@ public struct CloseCombatTechnique: LocalizableEntity { } } -/// Special rules for the combat technique that apply to all weapons in this -/// category. +/// Special rules for the combat technique that apply to all weapons in this category. public struct CloseCombatTechniqueSpecialRules: EntitySubtype { /// Is parrying possible with this combat technique? public let canParry: Bool diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Ranged.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Ranged.swift index 7868b1eb..4a34d022 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Ranged.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/CombatTechnique_Ranged.swift @@ -11,8 +11,7 @@ public struct RangedCombatTechnique: LocalizableEntity { /// The ranged combat technique's identifier. An unique, increasing integer. public let id: Int - /// Special rules for the combat technique that apply to all weapons in this - /// category. + /// Special rules for the combat technique that apply to all weapons in this category. public let special: RangedCombatTechniqueSpecialRules /// The primary attribute(s). @@ -39,8 +38,7 @@ public struct RangedCombatTechnique: LocalizableEntity { } } -/// Special rules for the combat technique that apply to all weapons in this -/// category. +/// Special rules for the combat technique that apply to all weapons in this category. public struct RangedCombatTechniqueSpecialRules: EntitySubtype { public let hasAmmunition: Bool diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Continent.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Continent.swift index 6ad1bcc4..7b9de6ce 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Continent.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Continent.swift @@ -7,8 +7,7 @@ import DiscriminatedEnum -/// Continents are mostly referenced to in languages and scripts that occur on a -/// specific continent. +/// Continents are mostly referenced to in languages and scripts that occur on a specific continent. public struct Continent: LocalizableEntity { /// The continent's identifier. An unique, increasing integer. public let id: Int diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Culture.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Culture.swift index 0f8497eb..13a84b30 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Culture.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Culture.swift @@ -14,8 +14,7 @@ public struct Culture: LocalizableEntity { /// A list of native languages (usually it is only one). public let language: [LanguageReference] - /// A list of native scripts (usually it is only one). If the culture does not - /// use any script, leave this field empty. + /// A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty. public let script: [ScriptReference]? /// If the area knowledge has a fixed value or can be adjusted. @@ -24,10 +23,7 @@ public struct Culture: LocalizableEntity { /// A list of possible social status in the respective culture. public let socialStatus: [SocialStatusReference] - /// A list of professions that are typical for the culture, as well as - /// professions that are rarely practiced or encountered in the culture. The - /// list is either defined by group (as multiple lists) or plain (as a single - /// list). + /// A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). public let commonProfessions: CommonProfessions /// A list of common advantages. @@ -86,46 +82,34 @@ public struct AreaKnowledge: EntitySubtype { } } -/// The "weight" difference compared to other professions or profession variants. -/// Some professions or profession variants are simply more common (Mostly), but -/// sometimes only specific elements are used (Only). +/// The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only). public enum CommonnessWeight: String, EntitySubtype { case mostly = "Mostly" case only = "Only" } -/// Some professions or profession variants are more common than others. There -/// may be cultures where some professions or profession variants are not -/// represented at all. +/// Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all. public struct Weighted: EntitySubtype { /// The list of more common professions or profession variants. public let elements: [ProfessionOrVariant] - /// The "weight" difference compared to other professions or profession - /// variants. Some professions or profession variants are simply more common + /// The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common /// (Mostly), but sometimes only specific elements are used (Only). public let weight: CommonnessWeight } -/// This defines how the list of constraints should be offset against the -/// list of all mundane professions: Either only the professions are kept -/// that intersect with the constraints (include) or only the professions -/// are kept that are different from the constraints (exclude). +/// This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). public enum CommonProfessionConstraintsOperation: String, EntitySubtype { case intersection = "Intersection" case difference = "Difference" } -/// A list of professions. The filter specifies how the list is applied to -/// all mundane professions. +/// A list of professions. The filter specifies how the list is applied to all mundane professions. public struct CommonProfessionConstraints: EntitySubtype { /// The list of constraints. public let constraints: [Constraint] - /// This defines how the list of constraints should be offset against the - /// list of all mundane professions: Either only the professions are kept - /// that intersect with the constraints (include) or only the professions - /// are kept that are different from the constraints (exclude). + /// This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). public let operation: CommonProfessionConstraintsOperation } @@ -139,12 +123,10 @@ public struct ProfessionConstraint: EntitySubtype { /// The profession's identifier. public let id: ProfessionIdentifier - /// Some profession variants are more common than others. There may be - /// cultures where some variants are not represented at all. + /// Some profession variants are more common than others. There may be cultures where some variants are not represented at all. public let weightedVariants: Weighted? - /// Some professions may be found in a culture, but are not that - /// common. + /// Some professions may be found in a culture, but are not that common. public let rarity: Rarity? private enum CodingKeys: String, CodingKey { @@ -165,8 +147,7 @@ public struct MagicalTraditionConstraint: EntitySubtype { /// The magical tradition's identifier. public let id: MagicalTraditionIdentifier - /// Some professions are more common than others. There may be cultures - /// where some professions are not represented at all. + /// Some professions are more common than others. There may be cultures where some professions are not represented at all. public let weightedProfessions: Weighted? /// Some traditions may be found in a culture, but are not that common. @@ -183,8 +164,7 @@ public struct BlessedTraditionConstraint: EntitySubtype { /// The magical tradition's identifier. public let id: BlessedTraditionIdentifier - /// Some professions are more common than others. There may be cultures - /// where some professions are not represented at all. + /// Some professions are more common than others. There may be cultures where some professions are not represented at all. public let weightedProfessions: Weighted? /// Some traditions may be found in a culture, but are not that common. @@ -226,10 +206,7 @@ public struct GroupedCommonProfessions: EntitySubtype { public let blessed: CommonProfessionConstraints? } -/// A list of professions that are typical for the culture, as well as -/// professions that are rarely practiced or encountered in the culture. The -/// list is either defined by group (as multiple lists) or plain (as a single -/// list). +/// A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). @DiscriminatedEnum public enum CommonProfessions: EntitySubtype { case plain(PlainCommonProfessions) @@ -242,8 +219,7 @@ public struct CulturalPackageItem: EntitySubtype { /// The skill's identifier. public let id: SkillIdentifier - /// The skill points for the respective skill you get for buying the cultural - /// package. + /// The skill points for the respective skill you get for buying the cultural package. public let points: Int } @@ -288,8 +264,7 @@ public struct AreaKnowledgeTranslation: EntitySubtype { /// The full description without examples in parenthesis. public let description: String - /// A shorter version of the description, used in input fields and other UI - /// elements where the space might be to small to use the full description. + /// A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description. public let abbreviated: String /// Examples of areas, if applicable. @@ -302,12 +277,10 @@ public struct AreaKnowledgeExample: EntitySubtype { /// Structured description of common names. public struct CommonNames: EntitySubtype { - /// First names can be gender-neutral, but they can also be for a specific - /// binary sex. They are sorted into groups. + /// First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups. public let firstNameGroups: [CommonNameGroup]? - /// Last names can be gender-neutral, like family names, but they can also be - /// for a specific binary sex. They are sorted into groups. + /// Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups. public let lastNameGroups: [CommonNameGroup]? /// Special naming rules. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Disadvantage.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Disadvantage.swift index 01a2776e..cf39a93f 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Disadvantage.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Disadvantage.swift @@ -20,12 +20,10 @@ public struct Disadvantage: LocalizableEntity { public let apValue: AdventurePointsValue - /// Does this disadvantage count towards the maximum of AP to be spent on - /// disadvantages? + /// Does this disadvantage count towards the maximum of AP to be spent on disadvantages? public let hasMaximumSpentInfluence: Bool - /// Does this disadvantage exclusively applies to arcane spellworks and not - /// to magical actions and magical applications? + /// Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications? public let isExclusiveToArcaneSpellworks: Bool public let src: PublicationRefs @@ -60,9 +58,7 @@ public struct DisadvantageTranslation: EntitySubtype { /// The range. public let range: String? - /// A string that gets appended to the default AP Value text with a preceding - /// space. This always happens if present, even if the generated AP Value text - /// is replaced. + /// A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. public let apValueAppend: AdventurePointsValueAppend? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Disease.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Disease.swift index 0b0be5e8..0e122fe8 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Disease.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Disease.swift @@ -14,14 +14,10 @@ public struct Disease: LocalizableEntity { /// The disease's level. public let level: Int - /// Depending on the disease, apply Spirit or Toughness as a penalty to the - /// disease roll. It may also happen that the lower of both is applied as a - /// penalty. + /// Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. public let resistance: Resistance - /// What causes the disease? The GM rolls 1D20 to see if a character gets - /// infected. If the infection check succeeds, the GM makes a disease check to - /// determine the severity of the infection. + /// What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. public let cause: [Cause] public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/FamiliarsTrick.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/FamiliarsTrick.swift index dde82c94..dfcbd1ea 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/FamiliarsTrick.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/FamiliarsTrick.swift @@ -11,11 +11,9 @@ public struct FamiliarsTrick: LocalizableEntity { /// The familiar's trick's identifier. An unique, increasing integer. public let id: Int - /// The animal types this trick is available to. Either it is available to all - /// or only a list of specific animal types. + /// The animal types this trick is available to. Either it is available to all or only a list of specific animal types. /// - /// If no animal types are given, the animal disease applies to all animal - /// types. + /// If no animal types are given, the animal disease applies to all animal types. public let animalTypes: [AnimalTypeReference] /// Measurable parameters of a familiar's trick. @@ -24,8 +22,7 @@ public struct FamiliarsTrick: LocalizableEntity { /// The property of the trick. public let property: FamiliarsTrickProperty - /// The AP value the familiar has to pay for. It may also be that a specific is - /// known by all familiar by default. In the latter case the field is not set. + /// The AP value the familiar has to pay for. It may also be that a specific is known by all familiar by default. In the latter case the field is not set. public let apValue: Int? public let src: PublicationRefs @@ -120,8 +117,7 @@ public struct FamiliarsTrickFixedOneTimeCost: EntitySubtype { } public struct FamiliarsTrickFixedOneTimeCostTranslation: EntitySubtype { - /// The cost have to be per a specific countable entity, e.g. `8 KP - /// per person`. + /// The cost have to be per a specific countable entity, e.g. `8 KP per person`. public let per: ResponsiveTextOptional? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Lessons_Curriculum.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Lessons_Curriculum.swift index a458c9d5..5d102ff5 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Lessons_Curriculum.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Lessons_Curriculum.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// This is a curriculum of a specified academy, containing the guideline, -/// elective and restricted spellworks as well as the lesson packages of that -/// academy. +/// This is a curriculum of a specified academy, containing the guideline, elective and restricted spellworks as well as the lesson packages of that academy. public struct Curriculum: LocalizableEntity { /// The curriculum's identifier. An unique, increasing integer. public let id: Int @@ -63,17 +61,11 @@ public struct SpecificElectiveSpellworks: EntitySubtype { public struct ElectiveSpellwork: EntitySubtype { public let id: SpellworkIdentifier - /// The elective spellwork may only take effect if a certain condition is met. - /// The condition may be related to professions or profession variants, but it - /// is designed so that it can work without a specific profession, as multiple - /// may belong to an institute, but with referencing other entities instead. + /// The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. public let restriction: ElectiveSpellworkRestriction? } -/// The elective spellwork may only take effect if a certain condition is met. -/// The condition may be related to professions or profession variants, but it is -/// designed so that it can work without a specific profession, as multiple may -/// belong to an institute, but with referencing other entities instead. +/// The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. @DiscriminatedEnum public enum ElectiveSpellworkRestriction: EntitySubtype { case element(ElectiveSpellworkElementRestriction) @@ -103,9 +95,7 @@ public struct RestrictedProperty: EntitySubtype { /// Exclude specific spellworks from the restriction. public let exclude: [SpellworkIdentifier]? - /// Spellworks from this property up to a certain number are allowed. - /// Spellworks excluded from this restriction definition using `exclude` do - /// not contribute to the maximum. + /// Spellworks from this property up to a certain number are allowed. Spellworks excluded from this restriction definition using `exclude` do not contribute to the maximum. public let maximum: Double? } @@ -116,10 +106,7 @@ public struct LessonPackage: EntitySubtype { /// The lesson package's identifier. An unique, increasing integer. public let id: Int - /// The spell values difference of the lesson package. This field reflects the - /// changes (difference) to the field of the same name in the profession - /// package. If a spell gets to SR 0 because of this, it will be removed - /// completely. + /// The spell values difference of the lesson package. This field reflects the changes (difference) to the field of the same name in the profession package. If a spell gets to SR 0 because of this, it will be removed completely. public let spellworkChanges: [SpellworkChange]? public let skills: [AbilityAdjustment]? @@ -145,8 +132,7 @@ public struct LessonPackageTranslation: EntitySubtype { /// The name of the lesson package. public let name: NonEmptyString - /// The spell values difference of the lesson package. Use this field to - /// specify a text that is displayed instead of the generated + /// The spell values difference of the lesson package. Use this field to specify a text that is displayed instead of the generated /// `spellwork_changes` list. The field is displayed even if no list is /// present. public let spellworkChanges: NonEmptyString? @@ -167,8 +153,7 @@ public enum AbilityAdjustment: EntitySubtype { public struct CombatTechniqueAdjustment: EntitySubtype { public let id: CombatTechniqueIdentifier - /// The combat technique points that will be added to the current combat - /// technique rating. + /// The combat technique points that will be added to the current combat technique rating. public let points: Int } @@ -183,12 +168,9 @@ public struct SkillAdjustment: EntitySubtype { public struct SpellworkAdjustment: EntitySubtype { public let id: SpellworkIdentifier - /// The skill points that will be added to the current skill rating. If a - /// spell gets to a skill rating of 0 because of this, it will be removed - /// completely. + /// The skill points that will be added to the current skill rating. If a spell gets to a skill rating of 0 because of this, it will be removed completely. public let points: Int - /// The target tradition. If the target spell is not from the Guild Mage - /// tradition, specify the tradition identifier here. + /// The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here. public let tradition: MagicalTraditionIdentifier? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/LiturgicalChant.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/LiturgicalChant.swift index ca67c601..c3a9a918 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/LiturgicalChant.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/LiturgicalChant.swift @@ -23,9 +23,7 @@ public struct LiturgicalChant: LocalizableEntity { /// The target category – the kind of creature or object – the skill affects. public let target: AffectedTargetCategories - /// The tradition(s) the liturgical chant is available for. Note that general - /// aspects do not have an associated tradition and thus need to be defined in - /// a special way. + /// The tradition(s) the liturgical chant is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. public let traditions: [SkillTradition] /// States which column is used to improve the skill. @@ -59,14 +57,10 @@ public struct LiturgicalChantTranslation: EntitySubtype { /// The name of the liturgical chant. public let name: NonEmptyString - /// A compressed name of the liturgical chant for use in small areas (e.g. - /// on character sheet). Should only be defined if the `name` does not fit - /// on character sheet. + /// A compressed name of the liturgical chant for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. public let nameCompressed: NonEmptyString? - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Locale.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Locale.swift index 4333ee76..d59c9b3d 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Locale.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Locale.swift @@ -17,8 +17,7 @@ public struct Locale: Entity { /// Region in which the language is spoken in it's language. public let region: String - /// The language is not (fully) implemented and thus needs to be excluded from - /// stable releases. + /// The language is not (fully) implemented and thus needs to be excluded from stable releases. public let isMissingImplementation: Bool? private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/MetaCondition.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/MetaCondition.swift index f4755e05..410f6501 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/MetaCondition.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/MetaCondition.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// Meta Conditions are rule elements that work like conditions in the sense that -/// they have four levels with different effects, but which are not explicitly -/// listed as conditions. +/// Meta Conditions are rule elements that work like conditions in the sense that they have four levels with different effects, but which are not explicitly listed as conditions. public struct MetaCondition: LocalizableEntity { /// The meta condition's identifier. An unique, increasing integer. public let id: Int diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Patron.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Patron.swift index 60045a4d..a5017962 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Patron.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Patron.swift @@ -17,36 +17,28 @@ public struct Patron: LocalizableEntity { /// The patron-specific skills. public let skills: [SkillReference] - /// The patron is only available to a certain set of cultures. It may be - /// available to all, it may be available to only specific ones (intersection) - /// and it may be available to all except specific ones to the listed cultures + /// The patron is only available to a certain set of cultures. It may be available to all, it may be available to only specific ones (intersection) and it may be available to all except specific ones to the listed cultures /// (difference). public let culture: PatronCulture - /// The list of cultures where patrons from this category can be the primary - /// patron of. + /// The list of cultures where patrons from this category can be the primary patron of. public let primaryPatronCultures: [CultureReference]? - /// The patron-specific powers. Used by animist power Animal Powers I–III and - /// should only be present on animal patrons. + /// The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons. public let powers: AnimalPowers? - /// The patron-specific AE cost. Used by several animist forces for animal - /// patrons. + /// The patron-specific AE cost. Used by several animist forces for animal patrons. public let aeCost: Int? - /// The patron-specific improvement cost. Used by several animist forces for - /// animal patrons. + /// The patron-specific improvement cost. Used by several animist forces for animal patrons. public let improvementCost: ImprovementCost? - /// The patron may grant common advantages that are taken into account during - /// character creation. + /// The patron may grant common advantages that are taken into account during character creation. /// /// *Source:* Geisterwald & Knochenklippen, p. 6-7 public let commonAdvantages: [AdvantageReference]? - /// The patron may grant common disadvantages that are taken into account - /// during character creation. + /// The patron may grant common disadvantages that are taken into account during character creation. /// /// *Source:* Geisterwald & Knochenklippen, p. 6-7 public let commonDisadvantages: [DisadvantageReference]? @@ -80,19 +72,14 @@ public struct PatronTranslation: EntitySubtype { public let name: NonEmptyString } -/// The patron cultures the patron is or is not part of. If the patron is part of -/// all patron cultures, the set should be empty and the operation should be -/// difference. +/// The patron cultures the patron is or is not part of. If the patron is part of all patron cultures, the set should be empty and the operation should be difference. public struct PatronCulture: EntitySubtype { public let set: [CultureReference] public let operation: PatronCultureOperation } -/// The set operation to combine the set of all patron cultures with the -/// specified set of patron cultures: If they should intersect, the patron is -/// only part of the given cultures. If they should differ, the patron is only -/// part of the cultures that are not given. +/// The set operation to combine the set of all patron cultures with the specified set of patron cultures: If they should intersect, the patron is only part of the given cultures. If they should differ, the patron is only part of the cultures that are not given. public enum PatronCultureOperation: String, EntitySubtype { case intersection = "Intersection" case difference = "Difference" diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/PatronCategory.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/PatronCategory.swift index 44a591a7..bde29c62 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/PatronCategory.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/PatronCategory.swift @@ -11,8 +11,7 @@ public struct PatronCategory: LocalizableEntity { /// The patron category's identifier. An unique, increasing integer. public let id: Int - /// The list of cultures where patrons from this category can be the primary - /// patron of. + /// The list of cultures where patrons from this category can be the primary patron of. public let primaryPatronCultures: [CultureReference] /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/PersonalityTrait.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/PersonalityTrait.swift index 0178676c..5de8ddcf 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/PersonalityTrait.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/PersonalityTrait.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// A personality trait describes character aspects of a person from a certain -/// region. Higher trait levels only cover a part of the region covered by -/// lower-level traits. +/// A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits. public struct PersonalityTrait: LocalizableEntity { /// The personality trait's identifier. An unique, increasing integer. public let id: Int @@ -41,8 +39,7 @@ public struct PersonalityTraitTranslation: EntitySubtype { /// The name of the personality trait. public let name: NonEmptyString - /// The effects of the personality trait. They should be sorted like they - /// are in the book. + /// The effects of the personality trait. They should be sorted like they are in the book. public let effects: [PersonalityTraitEffect] public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Profession.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Profession.swift index 3e73feb9..bf4fafb9 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Profession.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Profession.swift @@ -14,17 +14,9 @@ public struct Profession: Entity { /// The profession group. public let group: ProfessionGroup - /// A list of professions representing the same profession but with (slightly) - /// different stats. For example, there may be a profession in a regional - /// sourcebook or in the core rules and a profession in an extension rulebook - /// like Magic of Aventuria, where the profession is basically called the same - /// and almost has the same values, but the version from Magic of Aventuria - /// features a spell style special ability that does not exist in the core - /// rules or regional sourcebook. + /// A list of professions representing the same profession but with (slightly) different stats. For example, there may be a profession in a regional sourcebook or in the core rules and a profession in an extension rulebook like Magic of Aventuria, where the profession is basically called the same and almost has the same values, but the version from Magic of Aventuria features a spell style special ability that does not exist in the core rules or regional sourcebook. /// - /// The profession representation may feature different values for different - /// explicitly mentioned experience levels. In most cases, there is only one - /// stats package, which targets the experience level *Experienced*. + /// The profession representation may feature different values for different explicitly mentioned experience levels. In most cases, there is only one stats package, which targets the experience level *Experienced*. public let versions: [ProfessionVersion] } @@ -53,8 +45,7 @@ public enum ProfessionVersion: EntitySubtype { } public struct ExperiencedProfessionPackage: EntitySubtype { - /// The profession representation variant's identifier. An unique, increasing - /// integer. + /// The profession representation variant's identifier. An unique, increasing integer. public let id: Int public let package: ProfessionPackage @@ -66,8 +57,7 @@ public struct ExperiencedProfessionPackage: EntitySubtype { } public struct ProfessionPackagesForDifferentExperienceLevels: EntitySubtype { - /// The profession representation variant's identifier. An unique, increasing - /// integer. + /// The profession representation variant's identifier. An unique, increasing integer. public let id: Int public let packagesMap: [ExperienceLevelDynamicProfessionPackage] @@ -86,8 +76,7 @@ public struct ProfessionPackagesForDifferentExperienceLevels: EntitySubtype { } public struct ExperienceLevelDynamicProfessionPackage: EntitySubtype { - /// The experience level this profession targets. The experience level - /// must be unique for this representation. + /// The experience level this profession targets. The experience level must be unique for this representation. public let experienceLevelId: Int public let package: ProfessionPackage @@ -102,32 +91,25 @@ public struct ProfessionPackage: EntitySubtype { /// What does the professional package cost in adventure points? public let apValue: Int - /// Which prerequisites must be met to buy the stat block? For example, a - /// character might need the advantage Spellcaster or Blessed. Note: the AP - /// cost for a profession package does not include these prerequisites. + /// Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. public let prerequisites: ProfessionPrerequisites? - /// In some areas, the profession package grants a loose set of stats where the - /// player must choose between different options for the profession package. + /// In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. public let options: ProfessionPackageOptions? /// Any special abilities the profession receives from the package. public let specialAbilities: [ProfessionSpecialAbility]? - /// Provides ratings for the combat techniques that the hero receives from the - /// package. + /// Provides ratings for the combat techniques that the hero receives from the package. public let combatTechniques: [CombatTechniqueRating]? /// The skill ratings the package grants to the hero. public let skills: [SkillRating]? - /// The skill ratings a magical profession receives for spells; these spells - /// are considered activated. Spells from an unfamiliar Tradition, if any, are - /// identified as such. + /// The skill ratings a magical profession receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. public let spells: [SpellRating]? - /// Clerical professions receive these liturgical chants at the listed skill - /// ratings. These liturgical chants are considered activated. + /// Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. public let liturgicalChants: [LiturgicalChantRating]? /// Typical advantages for the profession. @@ -136,19 +118,13 @@ public struct ProfessionPackage: EntitySubtype { /// Typical disadvantages for the profession. public let suggestedDisadvantages: [CommonnessRatedAdvantageDisadvantage]? - /// These advantages do not fit well with this profession; to be checked with - /// the GM before taking any of them. + /// These advantages do not fit well with this profession; to be checked with the GM before taking any of them. public let unsuitableAdvantages: [CommonnessRatedAdvantageDisadvantage]? - /// These disadvantages do not fit well with this profession; to be checked - /// with the GM before taking any of them. + /// These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. public let unsuitableDisadvantages: [CommonnessRatedAdvantageDisadvantage]? - /// Provides examples of variants for the profession, which may include changes - /// to AP values and additional or modified skill ratings, special abilities, - /// or combat techniques, as compared to the basic profession. Usually picking - /// a variant is optional, but there are some rare exceptions where picking a - /// variant is required. + /// Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. public let variants: ProfessionVariants? private enum CodingKeys: String, CodingKey { @@ -172,9 +148,7 @@ public struct ProfessionTranslation: EntitySubtype { /// Name of the basic profession. public let name: ProfessionName - /// A name addition of the profession. This will contain texts like name of - /// the academy or the witch circle. It is enclosed in parenthesis, but the - /// database entry must not contain parenthesis. + /// A name addition of the profession. This will contain texts like name of the academy or the witch circle. It is enclosed in parenthesis, but the database entry must not contain parenthesis. public let specification: ProfessionName? /// Typical advantages for the profession. @@ -183,12 +157,10 @@ public struct ProfessionTranslation: EntitySubtype { /// Typical disadvantages for the profession. public let suggestedDisadvantages: NonEmptyString? - /// These advantages do not fit well with this profession; to be checked with - /// the GM before taking any of them. + /// These advantages do not fit well with this profession; to be checked with the GM before taking any of them. public let unsuitableAdvantages: NonEmptyString? - /// These disadvantages do not fit well with this profession; to be checked - /// with the GM before taking any of them. + /// These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. public let unsuitableDisadvantages: NonEmptyString? public let errata: Errata? @@ -204,11 +176,7 @@ public struct ProfessionTranslation: EntitySubtype { } } -/// Provides examples of variants for the profession, which may include changes -/// to AP values and additional or modified skill ratings, special abilities, or -/// combat techniques, as compared to the basic profession. Usually picking a -/// variant is optional, but there are some rare exceptions where picking a -/// variant is required. +/// Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. public struct ProfessionVariants: EntitySubtype { /// If the selection of a profession variant is required. public let isSelectionRequired: Bool @@ -229,9 +197,7 @@ public struct ProfessionVariant: EntitySubtype { /// The AP value you have to pay for the package variant. public let apValue: Int - /// Which prerequisites must be met to buy the stat block? For example, a - /// character might need the advantage Spellcaster or Blessed. Note: the AP - /// cost for a profession package does not include these prerequisites. + /// Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. public let prerequisites: ProfessionPrerequisites? public let options: ProfessionVariantPackageOptions? @@ -239,20 +205,16 @@ public struct ProfessionVariant: EntitySubtype { /// Any special abilities the profession receives from the package variant. public let specialAbilities: [VariantSpecialAbility]? - /// Provides ratings for the combat techniques that the hero receives from the - /// package variant. + /// Provides ratings for the combat techniques that the hero receives from the package variant. public let combatTechniques: [CombatTechniqueRating]? /// The skill ratings the package variant grants to the hero. public let skills: [SkillRating]? - /// The skill ratings a magical profession variant receives for spells; these - /// spells are considered activated. Spells from an unfamiliar Tradition, if - /// any, are identified as such. + /// The skill ratings a magical profession variant receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. public let spells: [SpellRating]? - /// Clerical professions receive these liturgical chants at the listed skill - /// ratings. These liturgical chants are considered activated. + /// Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. public let liturgicalChants: [LiturgicalChantRating]? /// All translations for the entry, identified by IETF language tag (BCP47). @@ -310,8 +272,7 @@ public struct SpecialAbilityDefinition: EntitySubtype { /// The level of the received special ability. public let level: Int? - /// Received select options. Order is important. Typically, you only need the - /// first array index, though. + /// Received select options. Order is important. Typically, you only need the first array index, though. public let options: [RequirableSelectOptionIdentifier]? } @@ -325,21 +286,18 @@ public struct FixedVariantSpecialAbility: EntitySubtype { /// The identifier of the combat technique to provide the rating for. public let id: SpecialAbilityIdentifier - /// if set to `false`, if the selection is granted by the basic package, it - /// is removed. + /// if set to `false`, if the selection is granted by the basic package, it is removed. public let active: Bool? /// The level of the received special ability. public let level: Int? - /// Received select options. Order is important. Typically, you only need the - /// first array index, though. + /// Received select options. Order is important. Typically, you only need the first array index, though. public let options: [RequirableSelectOptionIdentifier]? } public struct VariantSpecialAbilitySelection: EntitySubtype { - /// if set to `false`, if the selection is granted by the basic package, it - /// is removed. + /// if set to `false`, if the selection is granted by the basic package, it is removed. public let active: Bool? public let options: [SpecialAbilityDefinition] @@ -349,8 +307,7 @@ public struct CombatTechniqueRating: EntitySubtype { /// The identifier of the combat technique to provide the rating for. public let id: CombatTechniqueIdentifier - /// The rating bonus provided for the combat technique. If used in a profession - /// variant, it can also be used to lower the bonus of the base profession. + /// The rating bonus provided for the combat technique. If used in a profession variant, it can also be used to lower the bonus of the base profession. /// /// **Note:** This is a rating *bonus*, so it will be *added* to the default /// value of 6. @@ -361,19 +318,15 @@ public struct SkillRating: EntitySubtype { /// The identifier of the skill to provide the rating for. public let id: SkillIdentifier - /// The rating bonus provided for the skill. If used in a profession variant, - /// it can also be used to lower the bonus of the base profession + /// The rating bonus provided for the skill. If used in a profession variant, it can also be used to lower the bonus of the base profession public let rating: Int } public struct SpellRating: EntitySubtype { - /// The identifier(s) of the spell(s) to choose from to provide the rating for. - /// If multiple spells are provided, they must all have the same improvement - /// cost. + /// The identifier(s) of the spell(s) to choose from to provide the rating for. If multiple spells are provided, they must all have the same improvement cost. public let id: [ProfessionSpellIdentifier] - /// The rating bonus provided for the (selected) spell. If used in a profession - /// variant, it can also be used to lower the bonus of the base profession. + /// The rating bonus provided for the (selected) spell. If used in a profession variant, it can also be used to lower the bonus of the base profession. public let rating: Int } @@ -387,11 +340,7 @@ public struct ProfessionSpellworkIdentifier: EntitySubtype { /// The identifier of the spell to provide the rating for. public let id: SpellworkIdentifier - /// If the spell is not part of the magical tradition required by the - /// package, this references the magical tradition it is part of. It can also - /// be used to define the target magical tradition of a spell if multiple - /// magical traditions are required and the spell is available to multiple - /// of them. + /// If the spell is not part of the magical tradition required by the package, this references the magical tradition it is part of. It can also be used to define the target magical tradition of a spell if multiple magical traditions are required and the spell is available to multiple of them. public let tradition: MagicalTraditionReference? } @@ -401,19 +350,14 @@ public struct ProfessionMagicalActionIdentifier: EntitySubtype { } public struct LiturgicalChantRating: EntitySubtype { - /// The identifier(s) of the liturgical chant(s) to choose from to provide - /// the rating for. If multiple liturgical chants are provided, they must all - /// have the same improvement cost. + /// The identifier(s) of the liturgical chant(s) to choose from to provide the rating for. If multiple liturgical chants are provided, they must all have the same improvement cost. public let id: [LiturgyIdentifier] - /// The rating bonus provided for the selected liturgical chant. If used in a - /// profession variant, it can also be used to lower the bonus of the base - /// profession. + /// The rating bonus provided for the selected liturgical chant. If used in a profession variant, it can also be used to lower the bonus of the base profession. public let rating: Int } -/// In some areas, the profession package grants a loose set of stats where the -/// player must choose between different options for the profession package. +/// In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. public struct ProfessionPackageOptions: EntitySubtype { public let skillSpecialization: SkillSpecializationOptions? @@ -440,9 +384,7 @@ public struct ProfessionPackageOptions: EntitySubtype { } } -/// In some areas, the profession package grants a loose set of stats where the -/// player must choose between different options for the profession package. The -/// variant may override or remove those options. +/// In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. The variant may override or remove those options. public struct ProfessionVariantPackageOptions: EntitySubtype { public let skillSpecialization: VariantOptionAction? @@ -475,9 +417,7 @@ public enum VariantOptionAction: EntitySubtype { case override(T) } -/// Select an application from a skill or from one of a list of skills where you -/// get a skill specialization for. You can also specify a skill groups from -/// which you can choose a skill. +/// Select an application from a skill or from one of a list of skills where you get a skill specialization for. You can also specify a skill groups from which you can choose a skill. @DiscriminatedEnum public enum SkillSpecializationOptions: EntitySubtype { case single(SingleSkillSpecializationOption) @@ -503,13 +443,10 @@ public struct LanguagesScriptsOptions: EntitySubtype { /// Select one or more combat techniques you get a CtR bonus for. public struct CombatTechniquesOptions: EntitySubtype { - /// Specify the number of combat techniques that can be selected so that they - /// get increased to a specific CtR. There can be multiple selections with - /// different CtRs. + /// Specify the number of combat techniques that can be selected so that they get increased to a specific CtR. There can be multiple selections with different CtRs. public let fixed: [RatingForCombatTechniquesNumber] - /// Define if after the fixed selections the remaining unselected combat - /// techniques will receive a certain rating bonus as well. + /// Define if after the fixed selections the remaining unselected combat techniques will receive a certain rating bonus as well. public let restRating: Int? /// The list of combat techniques to choose from. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Property.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Property.swift index 7839bd66..b12c40b9 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Property.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Property.swift @@ -11,8 +11,7 @@ public struct Property: LocalizableEntity { /// The property's identifier. An unique, increasing integer. public let id: Int - /// The property check's attributes. Only the properties from the Core Rules - /// have defined property checks. + /// The property check's attributes. Only the properties from the Core Rules have defined property checks. public let check: SkillCheck? /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Race.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Race.swift index 62434cdb..b150f512 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Race.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Race.swift @@ -18,13 +18,10 @@ public struct Race: LocalizableEntity { /// The race’s base values. public let baseValues: BaseValues - /// Describes how to raise or lower maximum attribute values during character - /// creation. + /// Describes how to raise or lower maximum attribute values during character creation. public let attributeAdjustments: AttributeAdjustments - /// A list of automatically applied advantages. This does only work for - /// advantages with no further configuration such as level or special - /// selection. + /// A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection. public let automaticAdvantages: [AdvantageReference]? /// A list of strongly recommended advantages. @@ -36,13 +33,10 @@ public struct Race: LocalizableEntity { /// Configuration for random weight generation. public let weight: RandomWeightGeneration - /// Defines the starting ages for the race. It depends on the selected - /// experience level. + /// Defines the starting ages for the race. It depends on the selected experience level. public let startingAge: [StartingAgeConfigForExperienceLevel] - /// A list of available race variants where one has to be selected. If no - /// variants are to be selected, a single variant with no name has to be provided - /// which will be used as the missing values for the base race. + /// A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. public let variants: RaceVariants public let src: PublicationRefs @@ -88,18 +82,14 @@ public struct BaseValues: EntitySubtype { } } -/// Describes how to raise or lower maximum attribute values during character -/// creation. +/// Describes how to raise or lower maximum attribute values during character creation. public struct AttributeAdjustments: EntitySubtype { /// The values by which the maximum of the respective attribute is modified. public let fixed: [FixedAttributeAdjustment]? - /// An array of attribute maximum modifiers, where the attribute they apply to - /// is selected from a list of options. + /// An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options. /// - /// The array only permits a single entry because no race specified more than - /// one selectable attribute adjustment so far. But the schema allows for - /// multiple entries to be future-proof. + /// The array only permits a single entry because no race specified more than one selectable attribute adjustment so far. But the schema allows for multiple entries to be future-proof. public let selectable: [SelectableAttributeAdjustment]? } @@ -113,9 +103,7 @@ public struct FixedAttributeAdjustment: EntitySubtype { public let value: Int } -/// A value that will be added to the current maximum of the selected attribute -/// that has been chosen from the listed attributes (negative values will lower -/// the maximum). +/// A value that will be added to the current maximum of the selected attribute that has been chosen from the listed attributes (negative values will lower the maximum). public struct SelectableAttributeAdjustment: EntitySubtype { /// A list of attributes the player has to choose from. public let list: [AttributeReference] @@ -142,9 +130,7 @@ public struct WeightDice: EntitySubtype { /// Number of sides on every die. Example: 6 in 2D6. public let sides: DieType - /// The strategy how to offset the randomly generated values against the - /// base value. Either they are all added or subtracted or even results are - /// added and odd results are subtracted. + /// The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. public let offsetStrategy: WeightDiceOffsetStrategy private enum CodingKeys: String, CodingKey { @@ -154,9 +140,7 @@ public struct WeightDice: EntitySubtype { } } -/// The strategy how to offset the randomly generated values against the -/// base value. Either they are all added or subtracted or even results are -/// added and odd results are subtracted. +/// The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. public enum WeightDiceOffsetStrategy: String, EntitySubtype { case add = "Add" case subtract = "Subtract" @@ -170,14 +154,11 @@ public struct StartingAgeConfigForExperienceLevel: EntitySubtype { /// The base value for the selected experience level. public let base: Int - /// The random value for the selected experience level. It is going to be - /// added to the base value. + /// The random value for the selected experience level. It is going to be added to the base value. public let random: Dice } -/// A list of available race variants where one has to be selected. If no -/// variants are to be selected, a single variant with no name has to be provided -/// which will be used as the missing values for the base race. +/// A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. public typealias RaceVariants = [RaceVariant] public struct RaceVariant: EntitySubtype { @@ -199,12 +180,10 @@ public struct RaceVariant: EntitySubtype { /// A list of uncommon disadvantages. public let uncommonDisadvantages: [CommonnessRatedAdvantageDisadvantage]? - /// An array containing 20 (numeric) hair color identifiers. The array also - /// represents the 20-sided die for a random hair color. + /// An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color. public let hairColor: [HairColorReference] - /// An array containing 20 (numeric) eye color identifiers. The array also - /// represents the 20-sided die for a random eye color. + /// An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color. public let eyeColor: [EyeColorReference] /// Configuration for random height generation. @@ -237,9 +216,7 @@ public struct Height: EntitySubtype { } public struct RaceVariantTranslation: EntitySubtype { - /// The race variant's name. If left empty, it defaults to the base race name. - /// This can be used if the race has no (visible) variants so that a single - /// variant has to be provided. + /// The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided. public let name: NonEmptyString? /// The respective common advantages text from the source book. @@ -276,8 +253,7 @@ public struct RaceTranslation: EntitySubtype { /// The respective strongly recommended advantages text from the source book. public let stronglyRecommendedAdvantages: NonEmptyString? - /// The respective strongly recommended disadvantages text from the source - /// book. + /// The respective strongly recommended disadvantages text from the source book. public let stronglyRecommendedDisadvantages: NonEmptyString? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Ritual.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Ritual.swift index f6e5db0e..615354a1 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Ritual.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Ritual.swift @@ -26,9 +26,7 @@ public struct Ritual: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// The tradition(s) the ritual is available for. It may be *generally* - /// available to all traditions or it may be only familiar in specific - /// traditions. + /// The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. public let traditions: Traditions /// States which column is used to improve the skill. @@ -63,9 +61,7 @@ public struct RitualTranslation: EntitySubtype { /// The name of the ritual. public let 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/SexPractice.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/SexPractice.swift index d929d0b6..0361dc68 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/SexPractice.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/SexPractice.swift @@ -27,8 +27,7 @@ public struct SexPracticeTranslation: EntitySubtype { /// How long a round of this sex practice takes. public let duration: NonEmptyString - /// Prerequisites of participants and environment. Do not specify if the - /// sex practice has no prerequisites. + /// Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites. public let prerequisites: NonEmptyString? /// Effects of a failed *Seduction* check. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Skill.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Skill.swift index ac9c07dd..d72cac3f 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Skill.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Skill.swift @@ -14,9 +14,7 @@ public struct Skill: LocalizableEntity { /// Lists the linked three attributes used to make a skill check. public let check: SkillCheck - /// Lists applications for the skill, if any. This does not necessarily include - /// all possible applications. There may also be new applications that could be - /// purchased via certain advantages or special abilities. + /// Lists applications for the skill, if any. This does not necessarily include all possible applications. There may also be new applications that could be purchased via certain advantages or special abilities. public let applications: Applications /// Indicates whether encumbrance gives a penalty for checks with the skill. @@ -49,18 +47,13 @@ public struct SkillTranslation: EntitySubtype { /// The name of the skill. public let name: NonEmptyString - /// If there are options available that can not be put into a selection - /// list (like different cults), provide the label text for the input - /// element here. Otherwise leave empty. + /// If there are options available that can not be put into a selection list (like different cults), provide the label text for the input element here. Otherwise leave empty. public let applicationsInputLabel: NonEmptyString? - /// The text listing the certain circumstances in which the encumbrance may - /// count. This text must be used if `encumbrance` is set to `"Maybe"`, - /// otherwise it is ignored if defined. + /// The text listing the certain circumstances in which the encumbrance may count. This text must be used if `encumbrance` is set to `"Maybe"`, otherwise it is ignored if defined. public let encumbranceDescription: NonEmptyString? - /// Mentions any tools from the equipment list that are necessary to employ - /// the skill. + /// Mentions any tools from the equipment list that are necessary to employ the skill. public let tools: NonEmptyMarkdown? /// Gives examples of the effects that various QL might provide. @@ -90,8 +83,7 @@ public struct SkillTranslation: EntitySubtype { } } -/// A category. All available entries from the specified category will be -/// included as separate applications. +/// A category. All available entries from the specified category will be included as separate applications. public enum ApplicationCategory: String, EntitySubtype { case blessedTraditions = "BlessedTraditions" case diseases = "Diseases" diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/SkillModificationLevel.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/SkillModificationLevel.swift index 142cb287..a1dbf16c 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/SkillModificationLevel.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/SkillModificationLevel.swift @@ -69,17 +69,14 @@ public enum SlowSkillCastingTimeUnit: String, EntitySubtype { } public struct SkillModificationLevelTranslation: EntitySubtype { - /// Configuration for this level for fast skills (spells, liturgical chants). - /// Values set here override the default generated text. + /// Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text. public let fast: LevelTypeConfigTranslation? - /// Configuration for this level for slow skills (rituals, ceremonies). Values - /// set here override the default generated text. + /// Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text. public let slow: LevelTypeConfigTranslation? } -/// Configuration translation of a type for a level. Values set here override the -/// default generated text. +/// Configuration translation of a type for a level. Values set here override the default generated text. public struct LevelTypeConfigTranslation: EntitySubtype { public let range: NonEmptyString } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/Spell.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/Spell.swift index 2e2779ca..0e353658 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/Spell.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/Spell.swift @@ -26,9 +26,7 @@ public struct Spell: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// The tradition(s) the spell is available for. It may be *generally* - /// available to all traditions or it may be only familiar in specific - /// traditions. + /// The tradition(s) the spell is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. public let traditions: Traditions /// States which column is used to improve the skill. @@ -63,9 +61,7 @@ public struct SpellTranslation: EntitySubtype { /// The name of the spell. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Activatable.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Activatable.swift index 7d655921..c8816e39 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Activatable.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Activatable.swift @@ -13,15 +13,13 @@ public typealias Id = Int /// The name of the activatable entry. public typealias Name = String -/// The full name of the entry as stated in the sources. Only use when `name` -/// needs to be different from full name for text generation purposes. +/// The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. public typealias NameInLibrary = String /// Number of available levels. public typealias Levels = Int -/// The number stating how often you can buy the entry. The **default** depends on -/// the entry type: +/// 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**) @@ -31,31 +29,14 @@ public typealias Levels = Int /// The maximum is only set if it differs from the defaults specified above. public typealias Maximum = Int -/// Definitions for possible options for the activatable entry. They can either -/// be derived from entry categories or be defined explicitly. Both can happen as -/// well, but if there is an explicitly defined select option and a derived -/// select option has the same identifier (which may only happen if skill or -/// combat technique identifiers are used for explicit select options), the -/// explicit definition overwrites the derived option. +/// Definitions for possible options for the activatable entry. They can either be derived from entry categories or be defined explicitly. Both can happen as well, but if there is an explicitly defined select option and a derived select option has the same identifier (which may only happen if skill or combat technique identifiers are used for explicit select options), the explicit definition overwrites the derived option. /// -/// Note that this is only a full definition of options for simple logic that can -/// be made explicit using the more detailed configuration for both derived -/// categories and explicit options. There are quite a few entries whose option -/// logic cannot be fully represented here, so that it needs to be implemented -/// manually. +/// Note that this is only a full definition of options for simple logic that can be made explicit using the more detailed configuration for both derived categories and explicit options. There are quite a few entries whose option logic cannot be fully represented here, so that it needs to be implemented manually. public struct SelectOptions: EntitySubtype { - /// An entry category with optional further configuration. All available - /// entries from the specified categories will be included as separate select - /// options. You can also specify a set of groups that should only be - /// included. Groups not mentioned will be excluded then. + /// An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then. public let derived: SelectOptionCategory? - /// A list of explicit select options. If the identifier has a specific type, - /// its entry is the base of this select option, where values defined here - /// override values from the base. Define the `src` property if the options - /// are not derived from the rules text of the advantage/disadvantage/special - /// ability but instead are listed in a separate block and/or on a separate - /// page. + /// A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the `src` property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page. public let explicit: [ExplicitSelectOption]? } @@ -70,28 +51,18 @@ public struct ExplicitGeneralSelectOption: EntitySubtype { /// The option's identifier. An unique, increasing integer. public let id: Int - /// Sometimes, professions use specific text selections that are not - /// contained in described lists. This ensures you can use them for - /// professions only. They are not going to be displayed as options to the - /// user. + /// Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user. public let professionOnly: Bool? - /// Registers new applications, which get enabled once this entry is - /// activated with its respective select option. It specifies an entry-unique - /// identifier and the skill it belongs to. A translation can be left out if - /// its name equals the name of the origin select option. + /// Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. public let skillApplications: SkillApplications? - /// Registers uses, which get enabled once this entry is activated with its - /// respective select option. It specifies an entry-unique identifier and the - /// skill it belongs to. A translation can be left out if its name equals the - /// name of the origin select option. + /// Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. public let skillUses: SkillUses? public let prerequisites: GeneralPrerequisites? - /// Specific binding cost for the select option. Only has an effect if the - /// associated entry supports binding costs. + /// Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. public let bindingCost: Int? /// Specific AP cost for the select option. @@ -119,12 +90,10 @@ public struct ExplicitGeneralSelectOptionTranslation: EntitySubtype { /// The name of the select option. public let name: String - /// The name of the select option when displayed in a generated - /// profession text. + /// The name of the select option when displayed in a generated profession text. public let nameInProfession: String? - /// The description of the select option. Useful for Bad Habits, Trade - /// Secrets and other entries where a description is available. + /// The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available. public let description: String? public let errata: Errata? @@ -141,22 +110,15 @@ public struct ExplicitSkillSelectOption: EntitySubtype { /// The skill's identifier. An unique, increasing integer. public let id: SkillIdentifier - /// Registers new applications, which get enabled once this entry is - /// activated with its respective select option. It specifies an entry-unique - /// identifier and the skill it belongs to. A translation can be left out if - /// its name equals the name of the origin select option. + /// Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. public let skillApplications: [SkillApplicationOrUse]? - /// Registers uses, which get enabled once this entry is activated with its - /// respective select option. It specifies an entry-unique identifier and the - /// skill it belongs to. A translation can be left out if its name equals the - /// name of the origin select option. + /// Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. public let skillUses: [SkillApplicationOrUse]? public let prerequisites: GeneralPrerequisites? - /// Specific binding cost for the select option. Only has an effect if the - /// associated entry supports binding costs. + /// Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. public let bindingCost: Int? /// Specific AP cost for the select option. @@ -189,8 +151,7 @@ public struct ExplicitCombatTechniqueSelectOption: EntitySubtype { public let prerequisites: GeneralPrerequisites? - /// Specific binding cost for the select option. Only has an effect if the - /// associated entry supports binding costs. + /// Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. public let bindingCost: Int? /// Specific AP cost for the select option. @@ -228,17 +189,13 @@ public enum CombatSpecialAbilityUsageType: String, EntitySubtype { case specialManeuver = "SpecialManeuver" } -/// The definition of if the combat special ability can be used when armed or -/// when unarmed. +/// The definition of if the combat special ability can be used when armed or when unarmed. public enum CombatSpecialAbilityType: String, EntitySubtype { case armed = "Armed" case unarmed = "Unarmed" } -/// Registers new skill applications, which get enabled once this entry is -/// activated. It specifies an entry-unique identifier and the skill it belongs -/// to. A translation can be left out if its name equals the name of the origin -/// activatable entry. +/// Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. public typealias SkillApplications = [SkillApplication] public struct SkillApplication: EntitySubtype { @@ -262,9 +219,7 @@ public struct SkillApplicationAssociatedSkills: EntitySubtype { /// The skills this application belongs to. public let list: [SkillReference] - /// If an application applies to multiple skills, it may need to ensure the - /// respective skill is on a certain skill rating if the activatable entry - /// cannot ensure this prerequisite. + /// If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite. public let requiredSkillRating: Int? private enum CodingKeys: String, CodingKey { @@ -278,9 +233,7 @@ public struct SkillApplicationTranslation: EntitySubtype { public let name: NonEmptyString } -/// Registers uses, which get enabled once this entry is activated. It specifies -/// an entry-unique identifier and the skill it belongs to. A translation can be -/// left out if its name equals the name of the origin activatable entry. +/// Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. public typealias SkillUses = [SkillUse] public struct SkillUse: EntitySubtype { @@ -398,13 +351,10 @@ public struct PenaltySelectionOptionsRange: EntitySubtype { } public struct PenaltyByLevel: EntitySubtype { - /// 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. + /// 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. public let levels: [PenaltyByLevelLevel] - /// The combat-related special ability of which the level defines the penalty - /// instead. + /// The combat-related special ability of which the level defines the penalty instead. public let external: PenaltyByExternalLevel? } @@ -413,21 +363,14 @@ public struct PenaltyByLevelLevel: EntitySubtype { public let value: Int } -/// The combat-related special ability of which the level defines the penalty -/// instead. +/// The combat-related special ability of which the level defines the penalty instead. public struct PenaltyByExternalLevel: EntitySubtype { - /// The identifier of the combat-related special ability of which the level - /// defines the penalty instead. + /// The identifier of the combat-related special ability of which the level defines the penalty instead. public let id: CombatRelatedSpecialAbilityIdentifier } public struct PenaltyByAttack: EntitySubtype { - /// 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. + /// 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. public let list: [PenaltyByAttackOrderItem] /// The order of the first element in the `list` of penalties. @@ -483,9 +426,7 @@ public struct FixedArcaneEnergyCost: EntitySubtype { /// Specified if the AE cost `value` has to be paid for each time interval. public let interval: DurationUnitValue? - /// 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`). + /// 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`). public let perLevel: FixedArcaneEnergyCostPerLevel? /// All translations for the entry, identified by IETF language tag (BCP47). @@ -500,9 +441,7 @@ public struct FixedArcaneEnergyCost: EntitySubtype { } } -/// 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`). +/// 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`). public enum FixedArcaneEnergyCostPerLevel: String, EntitySubtype { case compressed = "Compressed" case verbose = "Verbose" @@ -517,8 +456,7 @@ public struct ArcaneEnergyCostPerCountable: EntitySubtype { /// The AE cost value that has to be per a specific countable entity. public let value: Int - /// If defined, in addition to the cost per entity you have to pay a flat - /// amount, regardless of the entity count. + /// If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count. public let baseValue: Int? /// All translations for the entry, identified by IETF language tag (BCP47). @@ -532,8 +470,7 @@ public struct ArcaneEnergyCostPerCountable: EntitySubtype { } public struct ArcaneEnergyCostPerCountableTranslation: EntitySubtype { - /// The cost have to be per a specific countable entity, e.g. `8 AE per - /// person`. + /// The cost have to be per a specific countable entity, e.g. `8 AE per person`. public let per: ResponsiveText /// A note, appended to the generated string in parenthesis. @@ -549,8 +486,7 @@ public struct IntervalArcaneEnergyCost: EntitySubtype { } public struct ActivationAndHalfIntervalArcaneEnergyCost: EntitySubtype { - /// The AE cost value that has to be payed for activation. Half of this value - /// has to be payed each interval. + /// The AE cost value that has to be payed for activation. Half of this value has to be payed each interval. public let value: Int /// The time interval for which the AE cost `value` has to be paid. @@ -558,8 +494,7 @@ public struct ActivationAndHalfIntervalArcaneEnergyCost: EntitySubtype { } public struct IndefiniteArcaneEnergyCost: EntitySubtype { - /// Specified if the indefinite AP cost description needs to be modified by a - /// certain value. + /// Specified if the indefinite AP cost description needs to be modified by a certain value. public let modifier: IndefiniteArcaneEnergyCostModifier? /// All translations for the entry, identified by IETF language tag (BCP47). @@ -584,8 +519,7 @@ public struct IndefiniteArcaneEnergyCostTranslation: EntitySubtype { } public struct ArcaneEnergyCostDisjunction: EntitySubtype { - /// Specified if the selected AE cost option has to be paid for each time - /// interval. + /// Specified if the selected AE cost option has to be paid for each time interval. public let interval: ArcaneEnergyCostDisjunctionInterval? /// The possible AE cost values. @@ -603,8 +537,7 @@ public struct ArcaneEnergyCostDisjunctionInterval: EntitySubtype { /// **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. + /// This works different than other sustained spells, since for them the end of the cast usually already counts as part of the first interval. public let afterActivation: Bool private enum CodingKeys: String, CodingKey { @@ -659,9 +592,7 @@ public struct VolumePerLevel: EntitySubtype { } public struct VolumeByLevel: EntitySubtype { - /// 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. + /// 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. public let list: [VolumeByLevelItem] } @@ -670,9 +601,7 @@ public struct VolumeByLevelItem: EntitySubtype { public let points: Int } -/// A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead / -/// Fairies, Ghosts / Demons, Elementals` may be respresented as the following -/// map: +/// 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: @@ -708,9 +637,7 @@ public struct VolumeByLevelItem: EntitySubtype { /// 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. +/// 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. public struct VolumeMap: EntitySubtype { /// The possible costs and associated labels. public let options: [VolumeMapOption] @@ -726,10 +653,7 @@ public struct VolumeMapTranslation: EntitySubtype { /// Place a string after the grouped map option labels. public let listAppend: 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. + /// 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. public let replacement: String? private enum CodingKeys: String, CodingKey { @@ -765,8 +689,7 @@ public struct VolumeMapOptionTranslation: EntitySubtype { /// The description of the option for cost string generation. public let label: NonEmptyString - /// The description of the option if used standalone. Only used if - /// different from `label`. + /// The description of the option if used standalone. Only used if different from `label`. public let labelStandalone: NonEmptyString? private enum CodingKeys: String, CodingKey { @@ -792,8 +715,7 @@ public enum BindingCost: EntitySubtype { public struct FixedBindingCost: EntitySubtype { /// The permanent AE cost. /// - /// If the enchantment has multiple levels, it is only applied for the first - /// level. + /// If the enchantment has multiple levels, it is only applied for the first level. public let permanentValue: Int private enum CodingKeys: String, CodingKey { @@ -810,9 +732,7 @@ public struct BindingCostPerLevel: EntitySubtype { } } -/// 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: +/// 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: @@ -850,10 +770,7 @@ public struct BindingCostMapTranslation: EntitySubtype { /// Place a string after the grouped map option labels. public let listAppend: NonEmptyString? - /// 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. + /// 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. public let replacement: NonEmptyString? private enum CodingKeys: String, CodingKey { @@ -880,8 +797,7 @@ public struct BindingCostMapOptionTranslation: EntitySubtype { /// The description of the option for cost string generation. public let label: NonEmptyString - /// The description of the option if used standalone. Only used if - /// different from `label`. + /// The description of the option if used standalone. Only used if different from `label`. public let labelStandalone: NonEmptyString? private enum CodingKeys: String, CodingKey { @@ -895,8 +811,7 @@ public struct BindingCostDerivedFromSelection: EntitySubtype { public let fallback: Int } -/// The magic property's identifier. `DependingOnProperty` can only be used if -/// the special ability has an option to select a property. +/// The magic property's identifier. `DependingOnProperty` can only be used if the special ability has an option to select a property. @DiscriminatedEnum public enum PropertyDeclaration: EntitySubtype { case dependingOnSelection @@ -919,8 +834,7 @@ public struct RestrictAdvancedSpecialAbilityOptions: /// The advanced special ability’s identifier. public let id: Identifier - /// Specify the select option(s) that only are allowed for the referenced - /// advanced special ability; others are disallowed. + /// Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed. public let option: [AdvancedSpecialAbilityRestrictedOptionIdentifier] } @@ -928,8 +842,7 @@ public struct OneOfAdvancedSpecialAbilityOptions: Ent /// The possible advanced special abilities. public let options: [AdvancedSpecialAbilityReference] - /// Do have to choose the advanced special ability when buying the style - /// special ability? Otherwise the decision can be made later. + /// Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later. public let isSelectionRequiredOnPurchase: Bool public let displayOption: DisplayOption? @@ -957,8 +870,7 @@ public struct AdvancedSpecialAbilityDerivedFromExternalOption: EntitySubtype { /// The select option's identifier. public let fromOption: PatronIdentifier @@ -976,15 +888,10 @@ public typealias AdvancedSpecialAbilityDerivedExternalEntryId = MagicalTradition public typealias AdvancedSpecialAbilityDerivedExternalEntryOptionId = PatronIdentifier -/// The Advanced Special Abilities for the respective Style Special Ability. -/// Sometimes, only a specific select option or a set of select options of an -/// entry is allowed, which can be modelled by the option property. It can also -/// be that you can choose from a set of special abilities, but then you can't -/// specify an option. +/// The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option. public typealias AdvancedSpecialAbilities = [AdvancedSpecialAbility] -/// The prerequisites text. It is only used if the text cannot be generated from -/// the given information. +/// The prerequisites text. It is only used if the text cannot be generated from the given information. public typealias PrerequisitesReplacement = NonEmptyMarkdown @DiscriminatedEnum @@ -1084,26 +991,20 @@ public enum AdventurePointsValue: EntitySubtype { case indefinite } -/// A fixed adventure points value. If the entry has levels, this is the cost per -/// level as well. +/// A fixed adventure points value. If the entry has levels, this is the cost per level as well. public typealias FixedAdventurePointsValue = AdventurePointsSingleValue -/// An entry with levels may have different costs for each level. The length of -/// the list must match the amount of levels the special ability has. +/// An entry with levels may have different costs for each level. The length of the list must match the amount of levels the special ability has. public typealias AdventurePointsValueByLevel = [AdventurePointsSingleValue] -/// The adventure points value is derived from the selection of the special -/// ability. Its display value may be able to be derived from the given -/// information for the select options. If that is not the case or the generated -/// text would not match the original one, a replacement text can be provided. +/// The adventure points value is derived from the selection of the special ability. Its display value may be able to be derived from the given information for the select options. If that is not the case or the generated text would not match the original one, a replacement text can be provided. public struct AdventurePointsDerivedFromSelection: EntitySubtype { /// All translations for the entry, identified by IETF language tag (BCP47). public let translations: LocaleMap? } public struct AdventurePointsDerivedFromSelectionTranslation: EntitySubtype { - /// A replacement for the generated text if it would not match the original - /// one. + /// A replacement for the generated text if it would not match the original one. public let replacement: NonEmptyMarkdown? } @@ -1113,11 +1014,8 @@ public typealias AdventurePointsSingleValue = Int /// A string that is used as a label for an input field. public typealias Input = NonEmptyString -/// The AP value. It is only used if the text cannot be generated from the given -/// information. +/// The AP value. It is only used if the text cannot be generated from the given information. public typealias AdventurePointsValueReplacement = NonEmptyMarkdown -/// A string that gets appended to the default AP Value text with a preceding -/// space. This always happens if present, even if the generated AP Value text is -/// replaced. +/// A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. public typealias AdventurePointsValueAppend = NonEmptyMarkdown diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSelectOptionCategory.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSelectOptionCategory.swift index 2b675cf0..331117b0 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSelectOptionCategory.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSelectOptionCategory.swift @@ -33,8 +33,7 @@ public enum SelectOptionCategory: EntitySubtype { } public struct BlessedTraditionsSelectOptionCategory: EntitySubtype { - /// Should the principles (code) of the tradition be required to select the - /// respective tradition? + /// Should the principles (code) of the tradition be required to select the respective tradition? public let requirePrinciples: Bool? private enum CodingKeys: String, CodingKey { @@ -51,8 +50,7 @@ public struct PropertiesSelectOptionCategory: EntitySubtype { /// Does each property require it's corresponding property knowledge? public let requireKnowledge: Bool? - /// Require a minimum number of spellworks of the respective property to be - /// on a minimum skill rating. + /// Require a minimum number of spellworks of the respective property to be on a minimum skill rating. public let requireMinimumSpellworksOn: RequiredMinimumSkillsToBeOnSkillRating? private enum CodingKeys: String, CodingKey { @@ -65,14 +63,10 @@ public struct AspectSelectOptionCategory: EntitySubtype { /// Does each aspect require it's corresponding aspect knowledge? public let requireKnowledge: Bool? - /// The generated name should be the *Master of (Aspect)* suffix for this - /// aspect instead of the aspect's name. If an aspect does not provide a - /// suffix (such as the General aspect), it is automatically excluded from - /// the list. + /// The generated name should be the *Master of (Aspect)* suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list. public let useMasterOfSuffixAsName: Bool? - /// Require a minimum number of liturgies of the respective aspect to be on a - /// minimum skill rating. + /// Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating. public let requireMinimumLiturgiesOn: RequiredMinimumSkillsToBeOnSkillRating? private enum CodingKeys: String, CodingKey { @@ -82,15 +76,12 @@ public struct AspectSelectOptionCategory: EntitySubtype { } } -/// Require a minimum number of spellworks/liturgies of the respective -/// property/aspect to be on a minimum skill rating. +/// Require a minimum number of spellworks/liturgies of the respective property/aspect to be on a minimum skill rating. public struct RequiredMinimumSkillsToBeOnSkillRating: EntitySubtype { - /// The minimum number of liturgies that need to be on the defined minimum - /// skill rating. + /// The minimum number of liturgies that need to be on the defined minimum skill rating. public let number: Int - /// The minimum skill rating the defined minimum number of liturgies need - /// to be on. + /// The minimum skill rating the defined minimum number of liturgies need to be on. public let rating: Int } @@ -139,22 +130,13 @@ public struct SkillSelectOptionCategoryCategory: EntitySubtype { /// Only include entries of the specified groups. public let groups: [SkillGroupReference]? - /// Only include (`Intersection`) or exclude (`Difference`) specific - /// skills. + /// Only include (`Intersection`) or exclude (`Difference`) specific skills. public let specific: SpecificFromSkillSelectOptionCategoryCategory? - /// Registers new applications, which get enabled once this entry is - /// activated with its respective select option. It specifies an - /// entry-unique identifier, the skill it belongs to is derived from the - /// select option automatically. A translation can be left out if its - /// name equals the name of the origin entry. + /// Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. public let skillApplications: [SkillApplicationOrUse]? - /// Registers uses, which get enabled once this entry is activated with - /// its respective select option. It specifies an entry-unique - /// identifier, the skill it belongs to is derived from the select option - /// automatically. A translation can be left out if its name equals the - /// name of the origin entry. + /// Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. public let skillUses: [SkillApplicationOrUse]? /// Generate prerequisites for each entry of the category. @@ -201,8 +183,7 @@ public struct SkillApplicationOrUse: EntitySubtype { } public struct SkillApplicationOrUseTranslation: EntitySubtype { - /// The name of the application or use if different from the activatable - /// entry's name. + /// The name of the application or use if different from the activatable entry's name. public let name: String } @@ -273,8 +254,7 @@ public struct SelectOptionsFixedAdventurePointsValue: /// A mapping of skill identifiers to their specific AP values. public let map: [SelectOptionsFixedAdventurePointsValueMapping] - /// The default value of an entry. Used as a fallback if no value is - /// found in `list`. + /// The default value of an entry. Used as a fallback if no value is found in `list`. public let `default`: Int } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCastingTime.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCastingTime.swift index d35f72c6..eb6e61b0 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCastingTime.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCastingTime.swift @@ -22,18 +22,14 @@ public struct ModifiableCastingTime: EntitySubtype { } } -/// The casting time may have two different values: One for use in “normal” time, -/// i. e. actions, combat rounds and others, and one for use during lovemaking, -/// which is a rule set from Aventurian Intimacy. +/// The casting time may have two different values: One for use in “normal” time, i. e. actions, combat rounds and others, and one for use during lovemaking, which is a rule set from Aventurian Intimacy. /// /// There must always be at least one casting time value. public struct CastingTimeIncludingLovemaking: EntitySubtype { /// The default casting time definition. public let `default`: CastingTime? - /// The casting time during lovemaking. In Aventurian Intimacy, you may only - /// use an activatable skill during lovemaking if it has a casting time used - /// during lovemaking. + /// The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. public let duringLovemaking: CastingTimeDuringLovemaking? private enum CodingKeys: String, CodingKey { @@ -42,9 +38,7 @@ public struct CastingTimeIncludingLovemaking: Enti } } -/// The casting time during lovemaking. In Aventurian Intimacy, you may only use -/// an activatable skill during lovemaking if it has a casting time used during -/// lovemaking. +/// The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. public struct CastingTimeDuringLovemaking: EntitySubtype { /// The (unitless) casting time value. public let value: Int diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCost.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCost.swift index fdc9dbf8..15faa52f 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCost.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillCost.swift @@ -56,8 +56,7 @@ public struct NonModifiableOneTimeCost: EntitySubtype { /// The part of the cost value that has to be spent permanently. public let permanentValue: Int? - /// The cost have to be per a specific countable entity, e.g. `8 KP per - /// person`. + /// The cost have to be per a specific countable entity, e.g. `8 KP per person`. public let per: NonModifiableOneTimeCostPerCountable? /// All translations for the entry, identified by IETF language tag @@ -74,8 +73,7 @@ public struct NonModifiableOneTimeCost: EntitySubtype { } public struct NonModifiableOneTimeCostPerCountable: EntitySubtype { - /// If defined, the minimum total AE that have to be spent casting the - /// skill. + /// If defined, the minimum total AE that have to be spent casting the skill. public let minimumTotal: Double? /// All translations for the entry, identified by IETF language tag @@ -108,8 +106,7 @@ public struct IndefiniteOneTimeCostTranslation: EntitySubtype { public let description: ResponsiveText } -/// A content that is `2/4/8/16 AE for an item the size of a -/// cup/chest/door/castle gate` may be respresented as the following map: +/// A content that is `2/4/8/16 AE for an item the size of a cup/chest/door/castle gate` may be respresented as the following map: /// /// ```yaml /// options: @@ -124,8 +121,7 @@ public struct IndefiniteOneTimeCostTranslation: EntitySubtype { /// for_append: "an item the size of a" /// ``` /// -/// This will generate the exact same string as seen above – given it is set -/// for a spellwork and thus `AE` is used. +/// This will generate the exact same string as seen above – given it is set for a spellwork and thus `AE` is used. public struct CostMap: EntitySubtype { /// The possible costs and associated labels. public let options: [CostMapOption] @@ -155,8 +151,7 @@ public struct CostMapOptionTranslation: EntitySubtype { /// The description of the option for cost string generation. public let label: NonEmptyString - /// The description of the option if used standalone. Only used if - /// different from `label`. + /// The description of the option if used standalone. Only used if different from `label`. public let labelStandalone: NonEmptyString? private enum CodingKeys: String, CodingKey { @@ -172,10 +167,7 @@ public struct CostMapTranslation: EntitySubtype { /// Place a string after the grouped map option labels. public let listAppend: NonEmptyString? - /// 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. + /// 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. public let replacement: NonEmptyString? private enum CodingKeys: String, CodingKey { @@ -211,8 +203,7 @@ public struct NonModifiableSustainedCost: EntitySubtype { /// The AE cost value. public let value: Int - /// The cost have to be per a specific countable entity, e.g. `8 KP per - /// person per 5 minutes`. + /// The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`. public let per: NonModifiableSustainedCostPerCountable? /// The sustain interval. @@ -227,8 +218,7 @@ public struct NonModifiableSustainedCost: EntitySubtype { } public struct NonModifiableSustainedCostPerCountable: EntitySubtype { - /// If defined, the minimum total AE that have to be spent casting the - /// skill. + /// If defined, the minimum total AE that have to be spent casting the skill. public let minimumTotal: Double? /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillEffect.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillEffect.swift index e9e90b6a..57ac69e2 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillEffect.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillEffect.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// 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. +/// 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. @DiscriminatedEnum public enum ActivatableSkillEffect: EntitySubtype { case plain(ActivatableSkillPlainEffect) @@ -23,16 +21,13 @@ public struct ActivatableSkillPlainEffect: EntitySubtype { } public struct ActivatableSkillEffectForEachQualityLevel: EntitySubtype { - /// The effect description before the list of effects for each quality - /// level. + /// The effect description before the list of effects for each quality level. public let textBefore: NonEmptyMarkdown - /// The list of effects for each quality level. The first element - /// represents QL 1, the second element QL 2, and so on. + /// The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. public let qualityLevels: [NonEmptyMarkdown] - /// The effect description after the list of effects for each quality - /// level. + /// The effect description after the list of effects for each quality level. public let textAfter: NonEmptyMarkdown? private enum CodingKeys: String, CodingKey { @@ -43,17 +38,13 @@ public struct ActivatableSkillEffectForEachQualityLevel: EntitySubtype { } public struct ActivatableSkillEffectForEachTwoQualityLevels: EntitySubtype { - /// The effect description before the list of effects for each quality - /// level. + /// The effect description before the list of effects for each quality level. public let textBefore: NonEmptyMarkdown - /// The list of effects for each two quality levels. The first element - /// represents QL 1–2, the second element QL 3–4 and the third element QL - /// 5–6. + /// The list of effects for each two quality levels. The first element represents QL 1–2, the second element QL 3–4 and the third element QL 5–6. public let qualityLevels: [NonEmptyMarkdown] - /// The effect description after the list of effects for each quality - /// level. + /// The effect description after the list of effects for each quality level. public let textAfter: NonEmptyMarkdown? private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillRange.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillRange.swift index 3e73163a..ce1e4dab 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillRange.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillRange.swift @@ -90,13 +90,10 @@ public struct CheckResultBasedRange: EntitySubtype { } public struct RangeTranslation: EntitySubtype { - /// A note, appended to the generated string in parenthesis. If the - /// generated is modified using `replacement`, the note is appended to - /// the modifier string. + /// A note, appended to the generated string in parenthesis. If the generated is modified using `replacement`, the note is appended to the modifier string. public let note: ResponsiveTextOptional? - /// A replacement string. If `note` is provided, it is appended to the - /// replaced string. + /// A replacement string. If `note` is provided, it is appended to the replaced string. public let replacement: ResponsiveTextReplace? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillTargetCategory.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillTargetCategory.swift index b24cca0a..e1a82c04 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillTargetCategory.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ActivatableSkillTargetCategory.swift @@ -9,8 +9,7 @@ import DiscriminatedEnum /// The target category – the kind of creature or object – the skill affects. /// -/// If no target categories are given, the skill applies to all target -/// categories. +/// If no target categories are given, the skill applies to all target categories. public typealias AffectedTargetCategories = [SpecificAffectedTargetCategory] public struct SpecificAffectedTargetCategory: EntitySubtype { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Blessed.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Blessed.swift index 66daec37..8b5e5255 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Blessed.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Blessed.swift @@ -17,8 +17,6 @@ public struct SkillTraditionWithAspects: EntitySubtype { /// The blessed tradition. public let tradition: BlessedTraditionReference - /// The aspect(s) from the tradition the ceremony belongs to. Note that not - /// all traditions have aspects. Traditions with aspects must have at least one - /// aspect specified. + /// The aspect(s) from the tradition the ceremony belongs to. Note that not all traditions have aspects. Traditions with aspects must have at least one aspect specified. public let aspects: [AspectReference]? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_DiseasePoison.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_DiseasePoison.swift index befd71b2..fbb97c33 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_DiseasePoison.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_DiseasePoison.swift @@ -7,18 +7,14 @@ import DiscriminatedEnum -/// Depending on the disease, apply Spirit or Toughness as a penalty to the -/// disease roll. It may also happen that the lower of both is applied as a -/// penalty. +/// Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. public enum Resistance: String, EntitySubtype { case spirit = "Spirit" case toughness = "Toughness" case lowerOfSpiritAndToughness = "LowerOfSpiritAndToughness" } -/// What causes the disease? The GM rolls 1D20 to see if a character gets -/// infected. If the infection check succeeds, the GM makes a disease check to -/// determine the severity of the infection. +/// What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. public struct Cause: EntitySubtype { /// The chance to get infected by this cause, in percent. public let chance: Int? @@ -31,9 +27,7 @@ public struct CauseTranslation: EntitySubtype { /// The name of the cause. public let name: String - /// The chance to get infected by this cause. If present for this - /// language, this overrides the universal `chance` field; they cannot be - /// used at the same time. + /// The chance to get infected by this cause. If present for this language, this overrides the universal `chance` field; they cannot be used at the same time. public let chance: NonEmptyString? /// An additional note about this cause. @@ -53,12 +47,10 @@ public struct DiseaseTranslation: EntitySubtype { /// After infection, how much time passes before symptoms appear? public let incubationTime: NonEmptyString - /// The damage caused by the disease. If the disease check fails, apply the - /// lessened effects. + /// The damage caused by the disease. If the disease check fails, apply the lessened effects. public let damage: Reduceable - /// The duration of the disease. If the disease check fails, use the - /// lessened duration. + /// The duration of the disease. If the disease check fails, use the lessened duration. public let duration: Reduceable /// Special information about the disease. @@ -86,16 +78,13 @@ public struct DiseaseTranslation: EntitySubtype { } } -/// An effect or other parameter that may be reduced by a failed disease check -/// for lessening or a degraded poison. +/// An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison. /// -/// This streamlines the wording for diseases and poison by using a unified -/// wording for *lessened* (disease) and *degraded* (poison). +/// This streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison). public struct Reduceable: EntitySubtype { /// The default value. In the source, it's the text before the slash. public let `default`: Content - /// The reduced value. In the source, it's the text after the slash. Some - /// entries may not have a reduced value. + /// The reduced value. In the source, it's the text after the slash. Some entries may not have a reduced value. public let reduced: Content? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Enhancements.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Enhancements.swift index d071116b..572fb5e4 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Enhancements.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Enhancements.swift @@ -17,8 +17,7 @@ public struct Enhancement: EntitySubtype { /// The skill rating required to learn this enhancement. public let skillRating: Int - /// The value to multiply with the numeric representation of the associated - /// skill's improvement cost to form the final AP cost of this enhancement. + /// The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement. public let adventurePointsModifier: Int public let prerequisites: EnhancementPrerequisites? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_I18n.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_I18n.swift index f2556034..75e822d6 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_I18n.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_I18n.swift @@ -7,14 +7,7 @@ import DiscriminatedEnum -/// The item can be present in multiple pluralization categories; this object -/// unifies handling of them. Not all of the options must be present, however, -/// every possible category for that language should be defined. This means, that -/// different languages may have a different amount of properties defined here. -/// More information on pluralization and the Intl.PluralRules API on -/// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, -/// https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and -/// http://cldr.unicode.org/index/cldr-spec/plural-rules. +/// The item can be present in multiple pluralization categories; this object unifies handling of them. Not all of the options must be present, however, every possible category for that language should be defined. This means, that different languages may have a different amount of properties defined here. More information on pluralization and the Intl.PluralRules API on https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and http://cldr.unicode.org/index/cldr-spec/plural-rules. /// /// From the third link: /// diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Influence.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Influence.swift index 2736cff4..53a676c2 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Influence.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Influence.swift @@ -23,16 +23,14 @@ public struct InfluenceTranslation: EntitySubtype { /// The influence name. public let name: NonEmptyString - /// The effects of the influence. They should be sorted like they are in - /// the book. + /// The effects of the influence. They should be sorted like they are in the book. public let effects: [InfluenceEffect] public let errata: Errata? } public struct InfluenceEffect: EntitySubtype { - /// An optional label that is displayed and placed before the actual - /// text. + /// An optional label that is displayed and placed before the actual text. public let label: NonEmptyString? /// The effect text. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Prerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Prerequisite.swift index 0457613c..5f013c62 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Prerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Prerequisite.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// A prerequisite group has no influence on validation logic. It serves as a -/// single unit for displaying purposes, where the source uses a prerequisites -/// item that cannot be represented as a single prerequisite. +/// A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite. public struct PrerequisiteGroup: EntitySubtype { public let list: [T] diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ResponsiveText.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ResponsiveText.swift index 76a2fd7e..34d41279 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_ResponsiveText.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_ResponsiveText.swift @@ -7,8 +7,7 @@ import DiscriminatedEnum -/// A text from the source that can be also displayed in small areas using a -/// compressed version. +/// A text from the source that can be also displayed in small areas using a compressed version. public struct ResponsiveText: EntitySubtype { /// The full text from the source. public let full: NonEmptyString @@ -17,29 +16,20 @@ public struct ResponsiveText: EntitySubtype { public let compressed: NonEmptyString } -/// A text from the source that can be also displayed in small areas using a -/// compressed version. It is used as a replacement for a generated text while -/// the generated text is still provided and should be used. +/// A text from the source that can be also displayed in small areas using a compressed version. It is used as a replacement for a generated text while the generated text is still provided and should be used. public struct ResponsiveTextReplace: EntitySubtype { - /// The full replacement string. It must contain `$1`, which is going to be - /// replaced with the generated string, so additional information can be - /// provided without duplicating concrete numeric values. + /// The full replacement string. It must contain `$1`, which is going to be replaced with the generated string, so additional information can be provided without duplicating concrete numeric values. public let full: 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 string, so additional information can be provided without - /// duplicating concrete numeric values. + /// 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 string, so additional information can be provided without duplicating concrete numeric values. public let compressed: String } -/// A text from the source that can be also displayed in small areas using a -/// compressed version, if available. +/// A text from the source that can be also displayed in small areas using a compressed version, if available. public struct ResponsiveTextOptional: EntitySubtype { /// The full text from the source. public let full: NonEmptyString - /// A compressed text for use in small areas (e.g. on character sheet). If this - /// is not present, it should not appear in those areas. + /// A compressed text for use in small areas (e.g. on character sheet). If this is not present, it should not appear in those areas. public let compressed: NonEmptyString? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Spellwork.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Spellwork.swift index 5d9d5a75..6d3dfbc0 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/_Spellwork.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/_Spellwork.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// The tradition(s) the ritual is available for. It may be *generally* -/// available to all traditions or it may be only familiar in specific -/// traditions. +/// The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. @DiscriminatedEnum public enum Traditions: EntitySubtype { case general diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/EquipmentPackage.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/EquipmentPackage.swift index c85f1fbf..db07e628 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/EquipmentPackage.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/EquipmentPackage.swift @@ -11,9 +11,7 @@ public struct EquipmentPackage: LocalizableEntity { /// The equipment package's identifier. An unique, increasing integer. public let id: Int - /// All items in the package. You have to provide the item (template) - /// identifier and you can optionally provide the number of how often an item - /// is included in the package. + /// All items in the package. You have to provide the item (template) identifier and you can optionally provide the number of how often an item is included in the package. public let items: [EquipmentPackageItem] public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Armor.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Armor.swift index 34327cb2..a0bb496a 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Armor.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Armor.swift @@ -145,8 +145,7 @@ public enum HitZone: EntitySubtype { } public struct HeadHitZone: EntitySubtype { - /// In some cases, multiple armors for the same hit zone can be combined. - /// They're listed at the item that can be combined with others. + /// In some cases, multiple armors for the same hit zone can be combined. They're listed at the item that can be combined with others. public let combinationPossibilities: HeadHitZoneCombinationPossibilities? private enum CodingKeys: String, CodingKey { @@ -158,7 +157,6 @@ public struct HeadHitZoneCombinationPossibilities: EntitySubtype { /// A list of armors that can be combined with this armor. public let armors: [ArmorReference] - /// The PRO value that is added to the PRO value of the other armor instead - /// of adding the normale PRO value. + /// The PRO value that is added to the PRO value of the other armor instead of adding the normale PRO value. public let protection: Int? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/BandageOrRemedy.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/BandageOrRemedy.swift index fb285ee3..f9275c23 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/BandageOrRemedy.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/BandageOrRemedy.swift @@ -17,12 +17,10 @@ public struct BandageOrRemedy: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints? - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Book.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Book.swift index 4ebc512b..00a85a9c 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Book.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Book.swift @@ -17,8 +17,7 @@ public struct Book: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/CeremonialItem.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/CeremonialItem.swift index 62bb2534..d426d4d3 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/CeremonialItem.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/CeremonialItem.swift @@ -17,15 +17,13 @@ public struct CeremonialItem: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints /// The deity associated with the equipment item. public let associatedTradition: BlessedTraditionReference - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Elixir.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Elixir.swift index 6a2c448a..b774c738 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Elixir.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Elixir.swift @@ -17,8 +17,7 @@ public struct Elixir: LocalizableEntity { /// The laboratory level needed to brew the elixir. public let laboratory: LaboratoryLevel - /// The brewing difficulty, which represents the challenge of creating an - /// elixir. + /// The brewing difficulty, which represents the challenge of creating an elixir. public let brewingDifficulty: Int /// AP value and prerequisites of the elixir recipe’s trade secret. @@ -53,8 +52,7 @@ public struct ElixirTranslation: EntitySubtype { /// Prerequsites for the brewing process, if any. public let brewingProcessPrerequisites: NonEmptyMarkdown? - /// The list of effects for each quality level. The first element - /// represents QL 1, the second element QL 2, and so on. + /// The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. public let qualityLevels: [NonEmptyMarkdown] public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/EquipmentOfBlessedOnes.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/EquipmentOfBlessedOnes.swift index a7cb037c..a1106ba6 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/EquipmentOfBlessedOnes.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/EquipmentOfBlessedOnes.swift @@ -11,8 +11,7 @@ public struct EquipmentOfBlessedOnes: LocalizableEntity { /// The cost in silverthalers. public let cost: Cost - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints /// The deity associated with the equipment item. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/IlluminationLightSource.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/IlluminationLightSource.swift index 5a6ccb34..eb1fad4b 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/IlluminationLightSource.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/IlluminationLightSource.swift @@ -17,16 +17,13 @@ public struct IlluminationLightSource: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints - /// The burning time is the time how long the light source can be lit. After - /// that time you have to use a new light source. + /// The burning time is the time how long the light source can be lit. After that time you have to use a new light source. public let burningTime: BurningTime - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Jewelry.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Jewelry.swift index 86f8e65f..4b4fb3bc 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Jewelry.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Jewelry.swift @@ -17,8 +17,7 @@ public struct Jewelry: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/LuxuryGood.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/LuxuryGood.swift index 15d69cc7..6a227ae7 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/LuxuryGood.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/LuxuryGood.swift @@ -17,12 +17,10 @@ public struct LuxuryGood: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints? - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/MusicalInstrument.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/MusicalInstrument.swift index 29174788..a08dde2d 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/MusicalInstrument.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/MusicalInstrument.swift @@ -17,8 +17,7 @@ public struct MusicalInstrument: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Poison.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Poison.swift index 3a0fdc25..34b0c0a6 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Poison.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Poison.swift @@ -134,8 +134,7 @@ public struct AlchemicalPoison: EntitySubtype { /// The laboratory level needed to brew the elixir. public let laboratory: LaboratoryLevel - /// The brewing difficulty, which represents the challenge of creating an - /// elixir. + /// The brewing difficulty, which represents the challenge of creating an elixir. public let brewingDifficulty: Int /// AP value and prerequisites of the elixir recipe’s trade secret. @@ -226,13 +225,10 @@ public struct DemonicPoisonTranslation: EntitySubtype { } public struct Intoxicant: EntitySubtype { - /// Whether the use of the intoxicant is legal or not, usually from the - /// perspective of most middle-Aventurian an northern-Aventurian nations. + /// Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. public let legality: IntoxicantLegality - /// The chance of getting addicted after an ingestion in addition to the - /// maximum interval at which it, while addicted, must be ingested to not - /// suffer from withdrawal symptoms. + /// The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. public let addiction: IntoxicantAddiction? /// All translations for the entry, identified by IETF language tag @@ -240,8 +236,7 @@ public struct Intoxicant: EntitySubtype { public let translations: LocaleMap } -/// Whether the use of the intoxicant is legal or not, usually from the -/// perspective of most middle-Aventurian an northern-Aventurian nations. +/// Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. public struct IntoxicantLegality: EntitySubtype { public let isLegal: Bool @@ -250,20 +245,16 @@ public struct IntoxicantLegality: EntitySubtype { } } -/// The chance of getting addicted after an ingestion in addition to the maximum -/// interval at which it, while addicted, must be ingested to not suffer from -/// withdrawal symptoms. +/// The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. public struct IntoxicantAddiction: EntitySubtype { /// The chance of getting addicted after an ingestion. public let chance: Double - /// The maximum interval at which it, while addicted, must be ingested to not - /// suffer from withdrawal symptoms. + /// The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. public let interval: IntoxicantAddictionInterval } -/// The maximum interval at which it, while addicted, must be ingested to not -/// suffer from withdrawal symptoms. +/// The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. @DiscriminatedEnum public enum IntoxicantAddictionInterval: EntitySubtype { case constant(ConstantIntoxicantAddictionInterval) @@ -284,12 +275,10 @@ public struct IntoxicantTranslation: EntitySubtype { /// How to ingest the intoxicant. public let ingestion: NonEmptyString - /// The intoxicants side effects that always happen, no matter whether the - /// intoxicant has the default or the reduced effect. + /// The intoxicants side effects that always happen, no matter whether the intoxicant has the default or the reduced effect. public let sideEffect: NonEmptyMarkdown? - /// What happens if the intoxicant has been overdosed, that is, it has been - /// ingested another time within the duration. + /// What happens if the intoxicant has been overdosed, that is, it has been ingested another time within the duration. public let overdose: NonEmptyMarkdown /// Special information about the intoxicant. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/ToolOfTheTrade.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/ToolOfTheTrade.swift index 73301aec..6a661847 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/ToolOfTheTrade.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/ToolOfTheTrade.swift @@ -17,8 +17,7 @@ public struct ToolOfTheTrade: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints? /// Additional information if the item is a laboratory. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Weapon.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Weapon.swift index 92d3bc35..cc1afb6e 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Weapon.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/Weapon.swift @@ -17,24 +17,19 @@ public struct Weapon: LocalizableEntity { /// The complexity of crafting the item. public let complexity: Complexity - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints? - /// A list of stat blocks for each combat technique this weapon can be used - /// with. + /// A list of stat blocks for each combat technique this weapon can be used with. public let uses: [WeaponUse] - /// If the weapon is sanctified by a god and thus restricted to it's Blessed - /// Ones. + /// If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. public let sanctifiedBy: SanctifiedBy? - /// Define if during character creation this weapon can only be bought by - /// characters of a specific race or culture. + /// Define if during character creation this weapon can only be bought by characters of a specific race or culture. public let restrictedToCultures: RestrictedToCultures? - /// Define if during character creation this weapon can only be bought by - /// characters of specific magical or blessed traditions. + /// Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. public let restrictedToTraditions: [MagicalTraditionReference]? public let src: PublicationRefs @@ -89,20 +84,16 @@ public struct WeaponTranslation: EntitySubtype { } public struct SecondaryWeapon: EntitySubtype { - /// A list of stat blocks for each combat technique this weapon can be used - /// with. + /// A list of stat blocks for each combat technique this weapon can be used with. public let uses: [WeaponUse] - /// If the weapon is sanctified by a god and thus restricted to it's Blessed - /// Ones. + /// If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. public let sanctifiedBy: SanctifiedBy? - /// Define if during character creation this weapon can only be bought by - /// characters of a specific race or culture. + /// Define if during character creation this weapon can only be bought by characters of a specific race or culture. public let restrictedToCultures: RestrictedToCultures? - /// Define if during character creation this weapon can only be bought by - /// characters of specific magical or blessed traditions. + /// Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. public let restrictedToTraditions: [MagicalTraditionReference]? /// All translations for the entry, identified by IETF language tag (BCP47). @@ -138,12 +129,10 @@ public enum WeaponUseValues: EntitySubtype { case ranged(RangedWeapon) } -/// If the weapon is sanctified by a god and thus restricted to it's Blessed -/// Ones. +/// If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. public typealias SanctifiedBy = [BlessedTraditionReference] -/// Define if during character creation this weapon can only be bought by -/// characters of a specific race or culture. +/// Define if during character creation this weapon can only be bought by characters of a specific race or culture. @DiscriminatedEnum public enum RestrictedToCultures: EntitySubtype { case culturesOfRace(RaceReference) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Item.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Item.swift index 8a367666..968b396e 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Item.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Item.swift @@ -17,12 +17,10 @@ public struct DefaultItem: EntitySubtype { /// The complexity of crafting the item. public let complexity: Complexity? - /// The structure points of the item. Use an array if the item consists of - /// multiple components that have individual structure points. + /// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public let structurePoints: StructurePoints - /// The item can also be used either as an improvised weapon or as an armor, - /// although this is not the primary use case of the item. + /// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. public let combatUse: CombatUse? public let src: PublicationRefs @@ -41,8 +39,7 @@ public struct DefaultItem: EntitySubtype { } } -/// The item can also be used either as an improvised weapon or as an armor, -/// although this is not the primary use case of the item. +/// The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. @DiscriminatedEnum public enum CombatUse: EntitySubtype { case weapon(SecondaryWeapon) @@ -73,8 +70,7 @@ public struct DefaultItemTranslation: EntitySubtype { } } -/// The structure points of the item. Use an array if the item consists of -/// multiple components that have individual structure points. +/// The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. public typealias StructurePoints = [StructurePointsComponent] public struct StructurePointsComponent: EntitySubtype { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_MeleeWeapon.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_MeleeWeapon.swift index dc3418ca..5240e056 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_MeleeWeapon.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_MeleeWeapon.swift @@ -13,8 +13,7 @@ public typealias AttackModifier = Int /// The PA modifier. public typealias ParryModifier = Int -/// The damage of a weapon consists of a random part using dice and an optional -/// flat part. +/// The damage of a weapon consists of a random part using dice and an optional flat part. public struct MeleeDamage: EntitySubtype { /// How many dice of which type are rolled to get the damage. public let dice: Dice @@ -44,8 +43,7 @@ public struct MeleeWeapon: EntitySubtype { /// The combat techniques and dependent values. public let combatTechnique: CloseCombatTechniqueReference - /// The damage of a weapon consists of a random part using dice and an optional - /// flat part. + /// The damage of a weapon consists of a random part using dice and an optional flat part. public let damage: MeleeDamage /// The primary attribute damage and threshold value. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_RangedWeapon.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_RangedWeapon.swift index 7656503c..1fc45efe 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_RangedWeapon.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_RangedWeapon.swift @@ -7,10 +7,7 @@ import DiscriminatedEnum -/// 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. +/// 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. @DiscriminatedEnum public enum RangedDamage: EntitySubtype { case `default`(DefaultRangedDamage) @@ -18,8 +15,7 @@ public enum RangedDamage: EntitySubtype { case special } -/// The damage of a weapon consists of a random part using dice and an optional -/// flat part. +/// The damage of a weapon consists of a random part using dice and an optional flat part. public struct DefaultRangedDamage: EntitySubtype { /// How many dice of which type are rolled to get the damage. public let dice: Dice @@ -32,8 +28,7 @@ public struct RangedWeapon: EntitySubtype { /// The combat techniques and dependent values. public let combatTechnique: RangedCombatTechniqueReference - /// The damage of a weapon consists of a random part using dice and an optional - /// flat part. + /// The damage of a weapon consists of a random part using dice and an optional flat part. public let damage: RangedDamage /// One or multiple reload times. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Weapon.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Weapon.swift index 783b439a..f36a66da 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Weapon.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/_Weapon.swift @@ -7,16 +7,7 @@ import DiscriminatedEnum -/// 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). +/// 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). @DiscriminatedEnum public enum PrimaryAttributeDamageThreshold: EntitySubtype { case `default`(DefaultPrimaryAttributeDamageThreshold) @@ -24,8 +15,7 @@ public enum PrimaryAttributeDamageThreshold: EntitySubtype { } public struct DefaultPrimaryAttributeDamageThreshold: EntitySubtype { - /// The attribute value representing the damage threshold for the primary - /// attribute of the item's combat technique. + /// The attribute value representing the damage threshold for the primary attribute of the item's combat technique. public let threshold: Int } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/sub/ArmorType.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/sub/ArmorType.swift index a745c879..ab7e2bd0 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/sub/ArmorType.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/equipment/item/sub/ArmorType.swift @@ -11,9 +11,7 @@ public struct ArmorType: LocalizableEntity { /// The armor type's identifier. An unique, increasing integer. public let id: Int - /// An armor type can have a *sturdiness rating*. The higher the rating, the - /// more durable the armor. Rolling higher than this rating during a sturdiness - /// check means the armor receives one level of the new condition *Wear*. + /// An armor type can have a *sturdiness rating*. The higher the rating, the more durable the armor. Rolling higher than this rating during a sturdiness check means the armor receives one level of the new condition *Wear*. public let sturdinessRating: Int? /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/AnimistPower.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/AnimistPower.swift index 992e06b3..ae882d8e 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/AnimistPower.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/AnimistPower.swift @@ -20,24 +20,17 @@ public struct AnimistPower: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// The tribe traditions the animist power is available to. It may be available - /// to all or only specific tribes. + /// The tribe traditions the animist power is available to. It may be available to all or only specific tribes. /// - /// If no tribe tradition is given, the animist power is generally available to - /// all tribe traditions. + /// If no tribe tradition is given, the animist power is generally available to all tribe traditions. public let tribeTradition: [AnimistTribeReference] - /// States which column is used to improve the skill. It is a fixed value or - /// depends on the primary patron. + /// States which column is used to improve the skill. It is a fixed value or depends on the primary patron. public let improvementCost: AnimistPowerImprovementCost public let prerequisites: AnimistPowerPrerequisites? - /// The animist power can have multiple levels. Each level is skilled - /// separately. A previous level must be on at least 10 so that the next higher - /// level can be activated and skilled. A higher level cannot be skilled higher - /// than a lower level. Each level also adds an effect text to the text of the - /// first level. + /// The animist power can have multiple levels. Each level is skilled separately. A previous level must be on at least 10 so that the next higher level can be activated and skilled. A higher level cannot be skilled higher than a lower level. Each level also adds an effect text to the text of the first level. public let levels: [AnimistPowerLevel]? public let src: PublicationRefs @@ -68,9 +61,7 @@ public struct AnimistPowerTranslation: EntitySubtype { /// purposes. public let nameInLibrary: NonEmptyString? - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -120,8 +111,7 @@ public enum AnimistPowerPerformanceParameters: EntitySubtype { } public struct OneTimeAnimistPowerPerformanceParameters: EntitySubtype { - /// The AE cost value, either a flat value or defined dynamically by the - /// primary patron. + /// The AE cost value, either a flat value or defined dynamically by the primary patron. public let cost: OneTimeAnimistPowerCost /// The duration. @@ -158,8 +148,7 @@ public enum OneTimeAnimistPowerDuration: EntitySubtype { } public struct SustainedAnimistPowerPerformanceParameters: EntitySubtype { - /// The AE cost value, either a flat value or defined dynamically by the - /// primary patron. + /// The AE cost value, either a flat value or defined dynamically by the primary patron. public let cost: SustainedAnimistPowerCost } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/Curse.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/Curse.swift index 8f606ab0..63aa99ba 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/Curse.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/Curse.swift @@ -43,9 +43,7 @@ public struct CurseTranslation: EntitySubtype { /// The name of the curse. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -81,8 +79,7 @@ public struct FixedCurseCost: EntitySubtype { } public struct FixedCurseCostTranslation: EntitySubtype { - /// The cost have to be per a specific countable entity, e.g. `8 KP - /// per person`. + /// The cost have to be per a specific countable entity, e.g. `8 KP per person`. public let per: ResponsiveText? /// A note, appended to the generated string in parenthesis. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/DominationRitual.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/DominationRitual.swift index 4a0465fc..246ebf86 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/DominationRitual.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/DominationRitual.swift @@ -43,9 +43,7 @@ public struct DominationRitualTranslation: EntitySubtype { /// The name of the domination ritual. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ElvenMagicalSong.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ElvenMagicalSong.swift index 673181f0..f7cbd384 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ElvenMagicalSong.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ElvenMagicalSong.swift @@ -53,9 +53,7 @@ public struct ElvenMagicalSongTranslation: EntitySubtype { /// The name of the elven magical song. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -98,7 +96,6 @@ public struct ElvenMagicalSongPermanentCostTranslation: EntitySubtype { } public struct ElvenMagicalSongCostTranslation: EntitySubtype { - /// The cost have to be per a specific countable entity, e.g. `8 AE - /// per person`. + /// The cost have to be per a specific countable entity, e.g. `8 AE per person`. public let per: ResponsiveText } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/GeodeRitual.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/GeodeRitual.swift index d760e8d6..4a864e9d 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/GeodeRitual.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/GeodeRitual.swift @@ -35,9 +35,7 @@ public struct GeodeRitualTranslation: EntitySubtype { /// The name of the geode ritual. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/JesterTrick.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/JesterTrick.swift index cd24fbc0..482c1182 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/JesterTrick.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/JesterTrick.swift @@ -51,9 +51,7 @@ public struct JesterTrickTranslation: EntitySubtype { /// The name of the jester trick. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalDance.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalDance.swift index d278f9a2..94c6a7ce 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalDance.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalDance.swift @@ -20,8 +20,7 @@ public struct MagicalDance: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// The music tradition(s) the magical dance is available for. This also - /// defines the different names in each music tradition. + /// The music tradition(s) the magical dance is available for. This also defines the different names in each music tradition. public let musicTradition: [MusicTraditionReference] /// States which column is used to improve the skill. @@ -48,9 +47,7 @@ public struct MagicalDanceTranslation: EntitySubtype { /// The name of the magical dance. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -84,8 +81,7 @@ public struct FixedMagicalDanceCost: EntitySubtype { } public struct IndefiniteMagicalDanceCost: EntitySubtype { - /// Specified if the indefinite description's result value is to be - /// modified by a certain number. + /// Specified if the indefinite description's result value is to be modified by a certain number. public let modifier: CheckResultBasedModifier? /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalMelody.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalMelody.swift index 574ed541..0115bf05 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalMelody.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalMelody.swift @@ -17,8 +17,7 @@ public struct MagicalMelody: LocalizableEntity { /// In some cases, the target's Spirit or Toughness is applied as a penalty. public let checkPenalty: SkillCheckPenalty? - /// Arcane bards must make a *Singing (area of application)* or *Music (area of - /// application)* check for each magical melody. + /// Arcane bards must make a *Singing (area of application)* or *Music (area of application)* check for each magical melody. public let skill: [MusicalSkillReference] /// Measurable parameters of a magical melody. @@ -27,8 +26,7 @@ public struct MagicalMelody: LocalizableEntity { /// The associated property. public let property: PropertyReference - /// The music tradition(s) the magical melody is available for. This also - /// defines the different names in each music tradition. + /// The music tradition(s) the magical melody is available for. This also defines the different names in each music tradition. public let musicTradition: [MusicTraditionReference] /// States which column is used to improve the skill. @@ -57,9 +55,7 @@ public struct MagicalMelodyTranslation: EntitySubtype { /// The name of the magical melody. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -90,7 +86,6 @@ public struct FixedMagicalMelodyCost: EntitySubtype { } public struct FirstPersonMagicalMelodyCost: EntitySubtype { - /// The (temporary) AE cost value for the first targeted person. The AE - /// cost for each additional person is half this value. + /// The (temporary) AE cost value for the first targeted person. The AE cost for each additional person is half this value. public let value: Int } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalRune.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalRune.swift index 31f64631..45f0a369 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalRune.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/MagicalRune.swift @@ -13,8 +13,7 @@ public struct MagicalRune: LocalizableEntity { /// The options the magical rune has, if any. /// - /// If there are multiple options, the magical rune may be activated for each - /// option, that is, multiple times. + /// If there are multiple options, the magical rune may be activated for each option, that is, multiple times. public let options: [MagicalRuneOption]? /// Lists the linked three attributes used to make a skill check. @@ -53,21 +52,16 @@ public struct MagicalRune: LocalizableEntity { public struct MagicalRuneTranslation: EntitySubtype { /// The name of the magical rune. /// - /// If the rune has an option, the option’s name will/should not be included in - /// the name as well as its surrounding parenthesis. It will/should be combined - /// on demand. + /// If the rune has an option, the option’s name will/should not be included in the name as well as its surrounding parenthesis. It will/should be combined on demand. public let name: NonEmptyString - /// The full name of the entry as stated in the sources. Only use when `name` - /// needs to be different from full name for text generation purposes. + /// The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. public let nameInLibrary: NonEmptyString? /// The native name of the magical rune. public let nativeName: NonEmptyString? - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) @@ -182,8 +176,7 @@ public struct MagicalRuneCraftingTime: EntitySubtype { } public struct MagicalRuneCraftingTimeTranslation: EntitySubtype { - /// The crafting time has to be per a specific countable entity, e.g. `8 - /// action per person`. + /// The crafting time has to be per a specific countable entity, e.g. `8 action per person`. public let per: ResponsiveText } @@ -247,8 +240,7 @@ public struct CustomMagicalRuneSuboptionTranslation: EntitySubtype { public struct MagicalRuneOptionTranslation: EntitySubtype { /// The name of the option. /// - /// The surrounding parenthesis will/should not be included, they will/should - /// be generated. + /// The surrounding parenthesis will/should not be included, they will/should be generated. public let name: NonEmptyString /// The native name of the magical rune option. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ZibiljaRitual.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ZibiljaRitual.swift index 61ee19aa..9b38f781 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ZibiljaRitual.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/ZibiljaRitual.swift @@ -51,9 +51,7 @@ public struct ZibiljaRitualTranslation: EntitySubtype { /// The name of the zibilja ritual. public let name: NonEmptyString - /// 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. + /// 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. public let effect: ActivatableSkillEffect @available(*, deprecated) diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/_MusicTradition.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/_MusicTradition.swift index 6d0d722d..7b408294 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/_MusicTradition.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/magicalActions/_MusicTradition.swift @@ -7,8 +7,7 @@ import DiscriminatedEnum -/// A reference to a music tradition with the music-tradition-specific name of -/// the entry +/// A reference to a music tradition with the music-tradition-specific name of the entry public struct MusicTraditionReference: EntitySubtype { /// The music tradition's identifier. public let id: Int diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/ConditionalPrerequisites.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/ConditionalPrerequisites.swift index f944e5a7..881cd158 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/ConditionalPrerequisites.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/ConditionalPrerequisites.swift @@ -7,8 +7,7 @@ import DiscriminatedEnum -/// A list of preconditions for the prerequisite it is defined on, so that it -/// only takes effect if the prerequisites in this list are matched. +/// A list of preconditions for the prerequisite it is defined on, so that it only takes effect if the prerequisites in this list are matched. /// /// Usually appears at the `when` property of the parent prerequisite. public typealias Preconditions = [PreconditionGroup] diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/DisplayOption.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/DisplayOption.swift index 94f3aeef..b25fa40b 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/DisplayOption.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/DisplayOption.swift @@ -14,16 +14,9 @@ public enum DisplayOption: EntitySubtype { } public struct ReplacementDisplayOption: EntitySubtype { - /// If the replacement text is a sentence or sentence-like fragment, this - /// property ensures it is integrated into the prerequisite string correctly. + /// If the replacement text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. /// - /// A standalone sentence is connected to the previous prerequisite string with - /// a period and a period is also added at the end of the sentence - /// automatically, if it is not present. A connected sentence is connected to - /// the previous prerequisite string with a semicolon and a period is not added - /// to the end of the sentence. In this case, if there are prerequisites after - /// this one, they will be connected using a semicolon again, unless a - /// different punctuation mark is present at the end of the given text. + /// A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. public let sentenceType: SentenceType? /// All translations for the entry, identified by IETF language tag (BCP47). diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/ActivatablePrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/ActivatablePrerequisite.swift index 641104c7..be333808 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/ActivatablePrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/ActivatablePrerequisite.swift @@ -18,8 +18,7 @@ public struct ActivatablePrerequisite: EntitySubtype { /// The required minimum level of the entry. public let level: Int? - /// Required select options. Order is important. Typically, you only need the - /// first array index, though. + /// Required select options. Order is important. Typically, you only need the first array index, though. public let options: [RequirableSelectOptionIdentifier]? public let displayOption: DisplayOption? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/EnhancementPrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/EnhancementPrerequisite.swift index 9844c9fe..456fc2b3 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/EnhancementPrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/EnhancementPrerequisite.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// Requires a specific enhancement from a skill. This should **not** be used -/// for enhancements themselves; they can only require enhancements from the same -/// skill they enhance. +/// Requires a specific enhancement from a skill. This should **not** be used for enhancements themselves; they can only require enhancements from the same skill they enhance. public struct ExternalEnhancementPrerequisite: EntitySubtype { /// The required skill. public let skill: SkillWithEnhancementsReference @@ -36,6 +34,5 @@ public struct EnhancementsReference: EntitySubtype { public let id: Int } -/// Requires a specific enhancement from a skill. This can only be used by an -/// enhancement to require another enhancement from the same skill. +/// Requires a specific enhancement from a skill. This can only be used by an enhancement to require another enhancement from the same skill. public typealias InternalEnhancementPrerequisite = EnhancementsReference diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RacePrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RacePrerequisite.swift index 35cf6d8a..f7539518 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RacePrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RacePrerequisite.swift @@ -7,9 +7,7 @@ import DiscriminatedEnum -/// Requires a specific race or one of a specific set of races. You can also -/// provide an object to say whether the hero must meet one of the races or -/// if the entry does not allow one of the races. +/// Requires a specific race or one of a specific set of races. You can also provide an object to say whether the hero must meet one of the races or if the entry does not allow one of the races. public struct RacePrerequisite: EntitySubtype { /// The race's identifier. public let id: RaceIdentifier diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RatedMinimumNumberPrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RatedMinimumNumberPrerequisite.swift index e678b96f..18a6b74b 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RatedMinimumNumberPrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/RatedMinimumNumberPrerequisite.swift @@ -8,12 +8,10 @@ import DiscriminatedEnum public struct RatedMinimumNumberPrerequisite: EntitySubtype { - /// The minimum number of skills that need to be on the defined minimum skill - /// rating. + /// The minimum number of skills that need to be on the defined minimum skill rating. public let number: Int - /// The minimum skill rating the defined minimum number of skills need to be - /// on. + /// The minimum skill rating the defined minimum number of skills need to be on. public let value: Int /// The targets that contribute to satisfying the prerequisite. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TextPrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TextPrerequisite.swift index b1264576..dbb5b066 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TextPrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TextPrerequisite.swift @@ -7,35 +7,19 @@ import DiscriminatedEnum -/// A prerequisite that is either not verifyable in general – e.g. roleplay or -/// background information – or the referenced entities were not made available -/// for use yet – e.g. races –, but which should be displayed, because it is part -/// of the prerequisite string from the sources. +/// A prerequisite that is either not verifyable in general – e.g. roleplay or background information – or the referenced entities were not made available for use yet – e.g. races –, but which should be displayed, because it is part of the prerequisite string from the sources. public struct TextPrerequisite: EntitySubtype { - /// The method how the prerequisite should be verified. Either is passes all - /// verification text or it denies all verification tests. The latter results - /// in the associated entry to never be available for purchase. + /// The method how the prerequisite should be verified. Either is passes all verification text or it denies all verification tests. The latter results in the associated entry to never be available for purchase. public let verification: TextVerificationRule - /// If the text is a sentence or sentence-like fragment, this property ensures - /// it is integrated into the prerequisite string correctly. + /// If the text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. /// - /// A standalone sentence is connected to the previous prerequisite string with - /// a period and a period is also added at the end of the sentence - /// automatically, if it is not present. A connected sentence is connected to - /// the previous prerequisite string with a semicolon and a period is not added - /// to the end of the sentence. In this case, if there are prerequisites after - /// this one, they will be connected using a semicolon again, unless a - /// different punctuation mark is present at the end of the given text. + /// A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. public let sentenceType: SentenceType? - /// If the text does not represent an actual prerequisite but a prerequisite - /// for the use of certain aspects or the entry the prerequisite is associated - /// with, or something like that, this property is set to `true`. + /// If the text does not represent an actual prerequisite but a prerequisite for the use of certain aspects or the entry the prerequisite is associated with, or something like that, this property is set to `true`. /// - /// If all prerequisites of an entry are marked as meta, the entry is - /// considered to have no prerequisites and thus the string `none` must be - /// rendered before the list of meta prerequisites. + /// If all prerequisites of an entry are marked as meta, the entry is considered to have no prerequisites and thus the string `none` must be rendered before the list of meta prerequisites. /// /// This is the only use case for this property. public let isMeta: Bool? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TraditionPrerequisite.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TraditionPrerequisite.swift index 63ebbe22..1b5ada7c 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TraditionPrerequisite.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/prerequisites/single/TraditionPrerequisite.swift @@ -8,8 +8,7 @@ import DiscriminatedEnum public struct BlessedTraditionPrerequisite: EntitySubtype { - /// The blessed tradition prerequisite may only be satified if the blessed - /// tradition is either church or shamanistic. + /// The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. public let restriction: BlessedTraditionPrerequisiteRestriction? public let displayOption: DisplayOption? @@ -20,16 +19,14 @@ public struct BlessedTraditionPrerequisite: EntitySubtype { } } -/// The blessed tradition prerequisite may only be satified if the blessed -/// tradition is either church or shamanistic. +/// The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. public enum BlessedTraditionPrerequisiteRestriction: String, EntitySubtype { case church = "Church" case shamanistic = "Shamanistic" } public struct MagicalTraditionPrerequisite: EntitySubtype { - /// The magical tradition prerequisite may only be satified if the magical - /// tradition can learn rituals or can bind familiars. + /// The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. public let restriction: MagicalTraditionPrerequisiteRestriction? public let displayOption: DisplayOption? @@ -40,8 +37,7 @@ public struct MagicalTraditionPrerequisite: EntitySubtype { } } -/// The magical tradition prerequisite may only be satified if the magical -/// tradition can learn rituals or can bind familiars. +/// The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. public enum MagicalTraditionPrerequisiteRestriction: String, EntitySubtype { case canLearnRituals = "CanLearnRituals" case canBindFamiliars = "CanBindFamiliars" diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/CoreRule.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/CoreRule.swift index 41036c94..12c27d93 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/CoreRule.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/CoreRule.swift @@ -34,23 +34,18 @@ public enum ContentNode: EntitySubtype { case referenceList(ReferenceListNode) } -/// A core rule nested inside this core rule. It may be displayed as a separate -/// page or its content may be included in this rule's text, which will -/// automatically generate a proper heading. No content node of a type other than +/// A core rule nested inside this core rule. It may be displayed as a separate page or its content may be included in this rule's text, which will automatically generate a proper heading. No content node of a type other than /// `Child` should follow a child node, since then it may look like the the text /// may be part of the child node. public struct ChildNode: EntitySubtype { /// The nested core rule's identifier. public let id: CoreRuleIdentifier - /// If the nested core rule's content should be integrated into this core rule - /// and a proper heading should be added. Otherwise create a link to a separate - /// view of that core rule. + /// If the nested core rule's content should be integrated into this core rule and a proper heading should be added. Otherwise create a link to a separate view of that core rule. public let include: Bool } -/// A simple text block, containing one or multiple paragraphs. Headings are not -/// allowed, they should be handled as nested core rules instead. +/// A simple text block, containing one or multiple paragraphs. Headings are not allowed, they should be handled as nested core rules instead. public struct TextNode: EntitySubtype { /// All translations for the entry, identified by IETF language tag (BCP47). public let translations: LocaleMap @@ -134,19 +129,12 @@ public enum ReferenceListNodeSource: EntitySubtype { } public struct ReferenceListNodeImprovementCostSource: EntitySubtype { - /// Define if the cost for attributes or skills should be defined. The - /// cost for attributes start with value 9, while the cost for skills - /// start with 1 in addition to possible activation cost. + /// Define if the cost for attributes or skills should be defined. The cost for attributes start with value 9, while the cost for skills start with 1 in addition to possible activation cost. public let target: ReferenceListNodeImprovementCostSourceTarget /// The highest value the improvement cost are displayed for. /// - /// The minimum maximum value should depend on what is the upper bound of - /// the range of adventure point cost that are equal across multiple - /// values (value increases for attributes are always 15 up to (and - /// including) value 14, while value increases for skills are always 1 to - /// 4, depending on the improvement cost, up to (and including) value - /// 12), since those ranges should be combined into a single table row. + /// The minimum maximum value should depend on what is the upper bound of the range of adventure point cost that are equal across multiple values (value increases for attributes are always 15 up to (and including) value 14, while value increases for skills are always 1 to 4, depending on the improvement cost, up to (and including) value 12), since those ranges should be combined into a single table row. public let maximumRating: Int private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/FocusRule.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/FocusRule.swift index 90578177..6e7a5624 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/FocusRule.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/FocusRule.swift @@ -17,8 +17,7 @@ public struct FocusRule: LocalizableEntity { /// The focus rule's level. public let level: Int - /// Has the focus rule not been implemented in Optolith yet? This is also true - /// if the focus rule does not (currently) apply to any Optolith feature. + /// Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. public let isMissingImplementation: Bool public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/OptionalRule.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/OptionalRule.swift index 24397e35..0ab36bc3 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/OptionalRule.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/rule/OptionalRule.swift @@ -11,8 +11,7 @@ public struct OptionalRule: LocalizableEntity { /// The optional rule's identifier. An unique, increasing integer. public let id: Int - /// Has the focus rule not been implemented in Optolith yet? This is also true - /// if the focus rule does not (currently) apply to any Optolith feature. + /// Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. public let isMissingImplementation: Bool public let src: PublicationRefs diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/source/Publication.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/source/Publication.swift index 05850f05..85c80d7c 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/source/Publication.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/source/Publication.swift @@ -17,8 +17,7 @@ public struct Publication: LocalizableEntity { /// If the publication may contain adult content. public let containsAdultContent: Bool - /// If the publication is not (fully) implemented and thus needs to be excluded - /// from * stable releases. + /// If the publication is not (fully) implemented and thus needs to be excluded from * stable releases. public let isMissingImplementation: Bool /// The specific other publications this publication depends on data from. @@ -50,8 +49,7 @@ public struct PublicationTranslation: EntitySubtype { /// The publication's release date. public let releaseDate: String? - /// If this publication translation is not (fully) implemented and thus needs - /// to be excluded from stable releases. + /// If this publication translation is not (fully) implemented and thus needs to be excluded from stable releases. public let isMissingImplementation: Bool private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/source/_PublicationRef.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/source/_PublicationRef.swift index 1fdb6f03..02100681 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/source/_PublicationRef.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/source/_PublicationRef.swift @@ -10,9 +10,7 @@ import DiscriminatedEnum /// The publications where you can find the entry. public typealias PublicationRefs = [PublicationRef] -/// A source reference. It contains the book's publisher identifier and the page -/// where it occurs. If an entry spans multiple pages, provide the last page as -/// well. +/// A source reference. It contains the book's publisher identifier and the page where it occurs. If an entry spans multiple pages, provide the last page as well. public struct PublicationRef: EntitySubtype { /// The publication's identifier. public let id: PublicationIdentifier @@ -44,12 +42,10 @@ public enum Occurrence: EntitySubtype { public typealias SimpleOccurrences = [SimpleOccurrence] public struct SimpleOccurrence: EntitySubtype { - /// The page where it occurs. If the entry spans multiple pages, use this as - /// the first page and `last_page` as the last page. + /// The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. public let firstPage: Int - /// The last page where it occurs. If there is only one page, set this to the - /// same as `first_page` oder remove it. + /// The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. public let lastPage: Int? private enum CodingKeys: String, CodingKey { @@ -62,22 +58,19 @@ public struct VersionedOccurrence: EntitySubtype { /// The initial occurrence of the entry. public let initial: InitialOccurrence - /// Revisions of the entry, resulting in either changed page references or - /// re-addition or removal of an entry. + /// Revisions of the entry, resulting in either changed page references or re-addition or removal of an entry. public let revisions: [Revision]? } public struct InitialOccurrence: EntitySubtype { - /// The publication's printing since which the entry is present. Leave - /// empty if present since the beginning. + /// The publication's printing since which the entry is present. Leave empty if present since the beginning. public let printing: Int? /// The initial page references. public let pages: [PageRange] } -/// A revision of the entry, resulting in either changed page references or -/// re-addition or removal of an entry. +/// A revision of the entry, resulting in either changed page references or re-addition or removal of an entry. @DiscriminatedEnum public enum Revision: EntitySubtype { case since(Since) @@ -85,8 +78,7 @@ public enum Revision: EntitySubtype { } public struct Since: EntitySubtype { - /// The publication's printing since which the entry is present again or has - /// changed page references. + /// The publication's printing since which the entry is present again or has changed page references. public let printing: Int /// The changed or new page references. @@ -99,12 +91,10 @@ public struct Deprecation: EntitySubtype { } public struct PageRange: EntitySubtype { - /// The page where it occurs. If the entry spans multiple pages, use this as - /// the first page and `last_page` as the last page. + /// The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. public let firstPage: Page - /// The last page where it occurs. If there is only one page, set this to the - /// same as `first_page` oder remove it. + /// The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. public let lastPage: Page? private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/AdvancedCombatSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/AdvancedCombatSpecialAbility.swift index 48ce6907..8d4c0f6d 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/AdvancedCombatSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/AdvancedCombatSpecialAbility.swift @@ -62,13 +62,10 @@ public struct AdvancedCombatSpecialAbilityTranslation: EntitySubtype { @available(*, deprecated) public let penalty: String? - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? - /// A string that gets appended to the default AP Value text with a preceding - /// space. This always happens if present, even if the generated AP Value text - /// is replaced. + /// A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. public let apValueAppend: AdventurePointsValueAppend? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/BlessedTradition.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/BlessedTradition.swift index cd7d3c77..523ccb60 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/BlessedTradition.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/BlessedTradition.swift @@ -16,8 +16,7 @@ public struct BlessedTradition: LocalizableEntity { public let skillUses: SkillUses? - /// The tradition's primary attribute. Leave empty if the tradition does not - /// have one. + /// The tradition's primary attribute. Leave empty if the tradition does not have one. public let primary: AttributeReference? /// The tradition's aspects, if any. @@ -33,15 +32,13 @@ public struct BlessedTradition: LocalizableEntity { /// A list of favored skills. public let favoredSkills: [SkillReference] - /// On activation of the tradition, a specific number of skills from a list of - /// skills must be selected as being favored. + /// On activation of the tradition, a specific number of skills from a list of skills must be selected as being favored. public let favoredSkillsSelection: FavoredSkillsSelection? /// The type of the tradition. May be either church or shamanistic. public let type: BlessedTraditionType - /// The select option's identifier of the disadvantage *Principles* that - /// represent this tradition's code, if any. + /// The select option's identifier of the disadvantage *Principles* that represent this tradition's code, if any. public let associatedPrinciplesId: Double? public let prerequisites: GeneralPrerequisites? @@ -125,14 +122,12 @@ public struct ShamanisticBlessedTradition: EntitySubtype { public struct BlessedTraditionTranslation: EntitySubtype { public let name: Name - /// A shorter name of the tradition's name, used in liturgical chant - /// descriptions. + /// A shorter name of the tradition's name, used in liturgical chant descriptions. public let nameCompressed: String? public let nameInLibrary: NameInLibrary? - /// The special rules of the tradition. They should be sorted like they are - /// in the book. + /// The special rules of the tradition. They should be sorted like they are in the book. public let specialRules: [SpecialRule] public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/CeremonialItemSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/CeremonialItemSpecialAbility.swift index ea7b941f..432c0e8e 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/CeremonialItemSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/CeremonialItemSpecialAbility.swift @@ -53,8 +53,7 @@ public struct CeremonialItemSpecialAbilityTranslation: EntitySubtype { public let effect: Effect - /// The prerequisites text. It is only used if the text cannot be generated - /// from the given information. + /// The prerequisites text. It is only used if the text cannot be generated from the given information. public let prerequisites: PrerequisitesReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/FatePointSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/FatePointSpecialAbility.swift index 1ed6a691..0e93473e 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/FatePointSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/FatePointSpecialAbility.swift @@ -50,8 +50,7 @@ public struct FatePointSpecialAbilityTranslation: EntitySubtype { public let rules: Rules - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/GeneralSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/GeneralSpecialAbility.swift index 75584c83..3f700c57 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/GeneralSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/GeneralSpecialAbility.swift @@ -53,9 +53,7 @@ public struct GeneralSpecialAbilityTranslation: EntitySubtype { public let rules: Rules - /// A string that gets appended to the default AP Value text with a preceding - /// space. This always happens if present, even if the generated AP Value text - /// is replaced. + /// A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. public let apValueAppend: AdventurePointsValueAppend? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/KarmaSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/KarmaSpecialAbility.swift index 94cd1e96..7382e611 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/KarmaSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/KarmaSpecialAbility.swift @@ -44,8 +44,7 @@ public struct KarmaSpecialAbilityTranslation: EntitySubtype { public let rules: Rules - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalSpecialAbility.swift index a2360dff..0b15feda 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalSpecialAbility.swift @@ -53,8 +53,7 @@ public struct MagicalSpecialAbilityTranslation: EntitySubtype { public let rules: Rules - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalTradition.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalTradition.swift index 8ebc994b..b4c579eb 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalTradition.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/MagicalTradition.swift @@ -18,8 +18,7 @@ public struct MagicalTradition: LocalizableEntity { public let skillUses: SkillUses? - /// The tradition's primary attribute. Leave empty if the tradition does not - /// have one. + /// The tradition's primary attribute. Leave empty if the tradition does not have one. public let primary: PrimaryAttribute? /// Can a member of the tradition learn cantrips? @@ -34,23 +33,19 @@ public struct MagicalTradition: LocalizableEntity { /// Can this magical tradition bind familiars? public let canBindFamiliars: Bool - /// Does the tradition allow learning more traditions or having learned a - /// different tradition before learning this tradition? + /// Does the tradition allow learning more traditions or having learned a different tradition before learning this tradition? public let allowsMultipleTraditions: Bool - /// Is the maximum AP you're able to spent on magical advantages and able to - /// get by magical disadvantages different than the default of 50 AP? + /// Is the maximum AP you're able to spent on magical advantages and able to get by magical disadvantages different than the default of 50 AP? public let alternativeMagicalAdventurePointsMaximum: Int? - /// Are advantages/disadvantages required to not exclusively apply to arcane - /// spellworks, but also to the tradition's magical actions or applications? + /// Are advantages/disadvantages required to not exclusively apply to arcane spellworks, but also to the tradition's magical actions or applications? public let requireNonSpellworkExclusiveEffects: Bool /// Is this a magical dilettante tradition? public let isMagicalDilettante: Bool - /// If arcane spellworks from a different tradition count as arcane spellworks - /// of this tradition, this is the different tradition's reference. + /// If arcane spellworks from a different tradition count as arcane spellworks of this tradition, this is the different tradition's reference. public let useArcaneSpellworksFromTradition: MagicalTraditionReference? /// The Influences for the traditions. Influences are enabled by Focus Rules. @@ -93,9 +88,7 @@ public struct PrimaryAttribute: EntitySubtype { /// The attribute's identifier. public let id: AttributeIdentifier - /// Typically, the value of the primary attribute (if one exists) is added - /// onto the base of 20 AE to get the actual AE. But sometimes, only half the - /// value is added. + /// Typically, the value of the primary attribute (if one exists) is added onto the base of 20 AE to get the actual AE. But sometimes, only half the value is added. public let useHalfForArcaneEnergy: Bool private enum CodingKeys: String, CodingKey { @@ -107,14 +100,12 @@ public struct PrimaryAttribute: EntitySubtype { public struct MagicalTraditionTranslation: EntitySubtype { public let name: Name - /// The name used for the traditions list of arcane spellworks if it is - /// different than the `name` of the special ability. + /// The name used for the traditions list of arcane spellworks if it is different than the `name` of the special ability. public let nameForArcaneSpellworks: String? public let nameInLibrary: NameInLibrary? - /// The special rules of the tradition. They should be sorted like they are - /// in the book. + /// The special rules of the tradition. They should be sorted like they are in the book. public let specialRules: [SpecialRule] public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/PactGift.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/PactGift.swift index 9a41c54e..7d67d2d6 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/PactGift.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/PactGift.swift @@ -18,8 +18,7 @@ public struct PactGift: LocalizableEntity { public let permanentDemonicConsumption: PactGiftPermanentDemonicConsumption? - /// This pact gift has direct influence on the existence of other entries. It - /// may add or remove entries. + /// This pact gift has direct influence on the existence of other entries. It may add or remove entries. public let automaticEntries: [AutomaticEntry]? public let prerequisites: GeneralPrerequisites? @@ -57,8 +56,7 @@ public struct FixedPactGiftPermanentDemonicConsumption: EntitySubtype { } public struct PactGiftPermanentDemonicConsumptionPerLevel: EntitySubtype { - /// The levels of *Demonic Consumption* the pact gift causes per activated - /// level of the pact gift. + /// The levels of *Demonic Consumption* the pact gift causes per activated level of the pact gift. public let levels: Int } @@ -66,12 +64,10 @@ public struct AutomaticEntry: EntitySubtype { /// What type of action is applied to the target entry? public let action: AutomaticEntryAction - /// If an entry is added or removed, does is cost or grant adventure points - /// or is it free of charge? + /// If an entry is added or removed, does is cost or grant adventure points or is it free of charge? public let applyApValue: Bool - /// The entry that is to be added or removed. It can be a fixed entry or a - /// selection where the player must choose one entry. + /// The entry that is to be added or removed. It can be a fixed entry or a selection where the player must choose one entry. public let target: AutomaticEntryTarget private enum CodingKeys: String, CodingKey { diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/SikaryanDrainSpecialAbility.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/SikaryanDrainSpecialAbility.swift index 8e196ecf..1fafa855 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/SikaryanDrainSpecialAbility.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/SikaryanDrainSpecialAbility.swift @@ -44,8 +44,7 @@ public struct SikaryanDrainSpecialAbilityTranslation: EntitySubtype { public let rules: Rules - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/VampiricGift.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/VampiricGift.swift index 5cf20f93..43749ad6 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/VampiricGift.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/VampiricGift.swift @@ -44,8 +44,7 @@ public struct VampiricGiftTranslation: EntitySubtype { public let rules: Rules - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/_Tradition.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/_Tradition.swift index cb4f00fa..8623387f 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/_Tradition.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/_Tradition.swift @@ -8,8 +8,7 @@ import DiscriminatedEnum public struct SpecialRule: EntitySubtype { - /// An optional label that is displayed and placed before the actual - /// text. + /// An optional label that is displayed and placed before the actual text. public let label: NonEmptyString? /// The text of a special rule. diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/sub/Language.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/sub/Language.swift index d081dc4a..34aa19ac 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/sub/Language.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/specialAbility/sub/Language.swift @@ -14,14 +14,12 @@ public struct Language: LocalizableEntity { /// The continents this language is present on. public let continent: [AssociatedContinent] - /// Language-specific specializations. Either a list of possible options or a - /// indefinite description of what may be a specialization. + /// Language-specific specializations. Either a list of possible options or a indefinite description of what may be a specialization. public let specializations: Specializations? public let prerequisites: LanguagePrerequisites? - /// The maximum possible level of the language. Only specified if lower than - /// default of 3. + /// The maximum possible level of the language. Only specified if lower than default of 3. public let maxLevel: Double? public let src: PublicationRefs @@ -63,8 +61,7 @@ public struct SpecificSpecializationTranslation: EntitySubtype { /// The name of the specialization. public let name: NonEmptyString - /// The specialization description. It will be appended to the name in - /// parenthesis. + /// The specialization description. It will be appended to the name in parenthesis. public let description: NonEmptyString? } @@ -77,8 +74,7 @@ public struct IndefiniteSpecializationsTranslation: EntitySubtype { /// The specializations description. public let description: NonEmptyString - /// An input label or placeholder text for an UI element if it differs - /// from the `description`. + /// An input label or placeholder text for an UI element if it differs from the `description`. public let label: NonEmptyString? } diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/CauldronEnchantment.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/CauldronEnchantment.swift index 30c6a57b..f3cda2bb 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/CauldronEnchantment.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/CauldronEnchantment.swift @@ -20,8 +20,7 @@ public struct CauldronEnchantment: LocalizableEntity { public let volume: Volume - /// Witches can learn to brew special things in their Witch's Cauldron. These - /// brews can be categorized in different types. + /// Witches can learn to brew special things in their Witch's Cauldron. These brews can be categorized in different types. public let brew: BrewReference public let cost: EnchantmentCost? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/SpellSwordEnchantment.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/SpellSwordEnchantment.swift index 9d36e16f..a7502b97 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/SpellSwordEnchantment.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/SpellSwordEnchantment.swift @@ -62,8 +62,7 @@ public struct SpellSwordEnchantmentTranslation: EntitySubtype { @available(*, deprecated) public let bindingCost: String? - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/StaffEnchantment.swift b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/StaffEnchantment.swift index 2844c150..b3e6fd67 100644 --- a/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/StaffEnchantment.swift +++ b/Sources/OptolithDatabaseSchema/GeneratedTypes/traditionArtifacts/StaffEnchantment.swift @@ -65,8 +65,7 @@ public struct StaffEnchantmentTranslation: EntitySubtype { @available(*, deprecated) public let bindingCost: String? - /// The AP value. It is only used if the text cannot be generated from the - /// given information. + /// The AP value. It is only used if the text cannot be generated from the given information. public let apValue: AdventurePointsValueReplacement? public let errata: Errata? diff --git a/docs/reference/Advantage.md b/docs/reference/Advantage.md index f1768a0a..503953b9 100644 --- a/docs/reference/Advantage.md +++ b/docs/reference/Advantage.md @@ -55,16 +55,14 @@ Key | Description | Details #### `has_maximum_spent_influence` -Does this advantage count towards the maximum of AP to be spent on -advantages? +Does this advantage count towards the maximum of AP to be spent on advantages? - **Type:** Boolean - **Default:** `true` #### `is_exclusive_to_arcane_spellworks` -Does this advantage exclusively applies to arcane spellworks and not -to magical actions and magical applications? +Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications? - **Type:** Boolean - **Default:** `false` @@ -127,9 +125,7 @@ The range. #### `ap_value_append?` -A string that gets appended to the default AP Value text with a preceding -space. This always happens if present, even if the generated AP Value text -is replaced. +A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. - **Type:** AdventurePointsValueAppend diff --git a/docs/reference/AnimalDisease.md b/docs/reference/AnimalDisease.md index a1e65a00..f355ecf4 100644 --- a/docs/reference/AnimalDisease.md +++ b/docs/reference/AnimalDisease.md @@ -33,17 +33,13 @@ The animal disease's level. #### `resistance` -Depending on the disease, apply Spirit or Toughness as a penalty to the -disease roll. It may also happen that the lower of both is applied as a -penalty. +Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. - **Type:** Resistance #### `cause` -What causes the disease? The GM rolls 1D20 to see if a character gets -infected. If the infection check succeeds, the GM makes a disease check to -determine the severity of the infection. +What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. - **Type:** List - **Items:** AnimalDisease/cause[] @@ -53,19 +49,16 @@ determine the severity of the infection. The animal types this disease applies to. -If no animal types are given, the animal disease applies to all animal -types. +If no animal types are given, the animal disease applies to all animal types. - **Type:** List - **Items:** AnimalDisease/animal_types[] #### `communicability_to_intelligent_creatures` -If and at which chance the disease can be communicated to intelligent -creatures. +If and at which chance the disease can be communicated to intelligent creatures. -If no causes are given, the disease is not communicable to intelligent -creatures. +If no causes are given, the disease is not communicable to intelligent creatures. - **Type:** List - **Items:** AnimalDisease/communicability_to_intelligent_creatures[] diff --git a/docs/reference/Aspect.md b/docs/reference/Aspect.md index 3e3cca31..f54de48c 100644 --- a/docs/reference/Aspect.md +++ b/docs/reference/Aspect.md @@ -43,7 +43,6 @@ The aspect name. #### `master_of_aspect_suffix?` -The aspect's name appended to the simple name (not `name_in_library`) -of the special ability *Master of (Aspect)*. +The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*. - **Type:** NonEmptyString diff --git a/docs/reference/Cantrip.md b/docs/reference/Cantrip.md index 215724c0..f495b6b7 100644 --- a/docs/reference/Cantrip.md +++ b/docs/reference/Cantrip.md @@ -44,10 +44,7 @@ The associated property. #### `note?` -A note specifying the dissemination of the cantrip in different traditions. -Sometimes a cantrip is exclusively available to one or more specific -traditions, but usually one the academies and traditions are listed the -cantrip is most commonly teached in. +A note specifying the dissemination of the cantrip in different traditions. Sometimes a cantrip is exclusively available to one or more specific traditions, but usually one the academies and traditions are listed the cantrip is most commonly teached in. - **Type:** CantripNote diff --git a/docs/reference/Ceremony.md b/docs/reference/Ceremony.md index c780cf72..873b5f4a 100644 --- a/docs/reference/Ceremony.md +++ b/docs/reference/Ceremony.md @@ -53,9 +53,7 @@ The target category – the kind of creature or object – the skill affects. #### `traditions` -The tradition(s) the ceremony is available for. Note that general aspects -do not have an associated tradition and thus need to be defined in a -special way. +The tradition(s) the ceremony is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. - **Type:** List - **Items:** Ceremony/traditions[] @@ -117,17 +115,13 @@ The name of the ceremony. #### `name_compressed?` -A compressed name of the ceremony for use in small areas (e.g. on -character sheet). Should only be defined if the `name` does not fit on -character sheet. +A compressed name of the ceremony for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. - **Type:** NonEmptyString #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/CombatTechnique_Close.md b/docs/reference/CombatTechnique_Close.md index c2c8be01..4266afe1 100644 --- a/docs/reference/CombatTechnique_Close.md +++ b/docs/reference/CombatTechnique_Close.md @@ -25,8 +25,7 @@ The close combat technique's identifier. An unique, increasing integer. #### `special` -Special rules for the combat technique that apply to all weapons in this -category. +Special rules for the combat technique that apply to all weapons in this category. - **Type:** CloseCombatTechniqueSpecialRules @@ -71,8 +70,7 @@ All translations for the entry, identified by IETF language tag (BCP47). ### `CloseCombatTechniqueSpecialRules` -Special rules for the combat technique that apply to all weapons in this -category. +Special rules for the combat technique that apply to all weapons in this category. - **Type:** Object diff --git a/docs/reference/CombatTechnique_Ranged.md b/docs/reference/CombatTechnique_Ranged.md index 9a020f99..76fe5dfe 100644 --- a/docs/reference/CombatTechnique_Ranged.md +++ b/docs/reference/CombatTechnique_Ranged.md @@ -25,8 +25,7 @@ The ranged combat technique's identifier. An unique, increasing integer. #### `special` -Special rules for the combat technique that apply to all weapons in this -category. +Special rules for the combat technique that apply to all weapons in this category. - **Type:** RangedCombatTechniqueSpecialRules @@ -71,8 +70,7 @@ All translations for the entry, identified by IETF language tag (BCP47). ### `RangedCombatTechniqueSpecialRules` -Special rules for the combat technique that apply to all weapons in this -category. +Special rules for the combat technique that apply to all weapons in this category. - **Type:** Object diff --git a/docs/reference/Continent.md b/docs/reference/Continent.md index 442abd0a..15c10f2e 100644 --- a/docs/reference/Continent.md +++ b/docs/reference/Continent.md @@ -1,14 +1,12 @@ # Continent -Continents are mostly referenced to in languages and scripts that occur on a -specific continent. +Continents are mostly referenced to in languages and scripts that occur on a specific continent. ## Definitions ### Continent (`Continent`) -Continents are mostly referenced to in languages and scripts that occur on a -specific continent. +Continents are mostly referenced to in languages and scripts that occur on a specific continent. - **Type:** Object diff --git a/docs/reference/Culture.md b/docs/reference/Culture.md index 0fa934cb..c4cf1cd7 100644 --- a/docs/reference/Culture.md +++ b/docs/reference/Culture.md @@ -41,8 +41,7 @@ A list of native languages (usually it is only one). #### `script?` -A list of native scripts (usually it is only one). If the culture does not -use any script, leave this field empty. +A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty. - **Type:** List - **Items:** Culture/script[] @@ -64,10 +63,7 @@ A list of possible social status in the respective culture. #### `common_professions` -A list of professions that are typical for the culture, as well as -professions that are rarely practiced or encountered in the culture. The -list is either defined by group (as multiple lists) or plain (as a single -list). +A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). - **Type:** CommonProfessions @@ -220,9 +216,7 @@ adjusted. ### `CommonnessWeight` -The "weight" difference compared to other professions or profession variants. -Some professions or profession variants are simply more common (Mostly), but -sometimes only specific elements are used (Only). +The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only). - **Type:** Union - **Cases:** CommonnessWeight'0 | CommonnessWeight'1 @@ -243,9 +237,7 @@ sometimes only specific elements are used (Only). ### `Weighted` -Some professions or profession variants are more common than others. There -may be cultures where some professions or profession variants are not -represented at all. +Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all. - **Type:** Object @@ -264,8 +256,7 @@ The list of more common professions or profession variants. #### `weight` -The "weight" difference compared to other professions or profession -variants. Some professions or profession variants are simply more common +The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only). - **Type:** CommonnessWeight @@ -280,10 +271,7 @@ variants. Some professions or profession variants are simply more common ### `CommonProfessionConstraintsOperation` -This defines how the list of constraints should be offset against the -list of all mundane professions: Either only the professions are kept -that intersect with the constraints (include) or only the professions -are kept that are different from the constraints (exclude). +This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). - **Type:** Union - **Cases:** CommonProfessionConstraintsOperation'0 | CommonProfessionConstraintsOperation'1 @@ -304,8 +292,7 @@ are kept that are different from the constraints (exclude). ### `CommonProfessionConstraints` -A list of professions. The filter specifies how the list is applied to -all mundane professions. +A list of professions. The filter specifies how the list is applied to all mundane professions. - **Type:** Object @@ -324,10 +311,7 @@ The list of constraints. #### `operation` -This defines how the list of constraints should be offset against the -list of all mundane professions: Either only the professions are kept -that intersect with the constraints (include) or only the professions -are kept that are different from the constraints (exclude). +This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). - **Type:** CommonProfessionConstraintsOperation @@ -378,15 +362,13 @@ The profession's identifier. #### `weighted_variants?` -Some profession variants are more common than others. There may be -cultures where some variants are not represented at all. +Some profession variants are more common than others. There may be cultures where some variants are not represented at all. - **Type:** Weighted<ProfessionVariantReference> #### `rarity?` -Some professions may be found in a culture, but are not that -common. +Some professions may be found in a culture, but are not that common. - **Type:** Rarity @@ -437,8 +419,7 @@ The magical tradition's identifier. #### `weighted_professions?` -Some professions are more common than others. There may be cultures -where some professions are not represented at all. +Some professions are more common than others. There may be cultures where some professions are not represented at all. - **Type:** Weighted<ProfessionReference> @@ -468,8 +449,7 @@ The magical tradition's identifier. #### `weighted_professions?` -Some professions are more common than others. There may be cultures -where some professions are not represented at all. +Some professions are more common than others. There may be cultures where some professions are not represented at all. - **Type:** Weighted<ProfessionReference> @@ -598,25 +578,18 @@ Key | Description | Details ### `BlessedCommonProfessionConstraint` -- **Type:** Union -- **Cases:** BlessedCommonProfessionConstraint'Tradition - ---- - -### `BlessedCommonProfessionConstraint'Tradition` - - **Type:** Object Key | Description | Details :-- | :-- | :-- -`tag` | | See details -`tradition` | | See details +`tag` | | See details +`tradition` | | See details -#### `tag` +#### `tag` - **Constant:** `"Tradition"` -#### `tradition` +#### `tradition` - **Type:** BlessedTraditionConstraint @@ -657,10 +630,7 @@ Key | Description | Details ### `CommonProfessions` -A list of professions that are typical for the culture, as well as -professions that are rarely practiced or encountered in the culture. The -list is either defined by group (as multiple lists) or plain (as a single -list). +A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). - **Type:** Union - **Cases:** CommonProfessions'Plain | CommonProfessions'Grouped @@ -728,8 +698,7 @@ The skill's identifier. #### `points` -The skill points for the respective skill you get for buying the cultural -package. +The skill points for the respective skill you get for buying the cultural package. - **Type:** Integer - **Minimum:** `1` @@ -822,8 +791,7 @@ The full description without examples in parenthesis. #### `abbreviated` -A shorter version of the description, used in input fields and other UI -elements where the space might be to small to use the full description. +A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description. - **Type:** String - **Minimum Length:** `1` @@ -874,8 +842,7 @@ Key | Description | Details #### `first_name_groups?` -First names can be gender-neutral, but they can also be for a specific -binary sex. They are sorted into groups. +First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups. - **Type:** List - **Items:** CommonNames/first_name_groups[] @@ -883,8 +850,7 @@ binary sex. They are sorted into groups. #### `last_name_groups?` -Last names can be gender-neutral, like family names, but they can also be -for a specific binary sex. They are sorted into groups. +Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups. - **Type:** List - **Items:** CommonNames/last_name_groups[] diff --git a/docs/reference/Disadvantage.md b/docs/reference/Disadvantage.md index dc285db4..ee8e6118 100644 --- a/docs/reference/Disadvantage.md +++ b/docs/reference/Disadvantage.md @@ -45,15 +45,13 @@ Key | Description | Details #### `has_maximum_spent_influence` -Does this disadvantage count towards the maximum of AP to be spent on -disadvantages? +Does this disadvantage count towards the maximum of AP to be spent on disadvantages? - **Type:** Boolean #### `is_exclusive_to_arcane_spellworks` -Does this disadvantage exclusively applies to arcane spellworks and not -to magical actions and magical applications? +Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications? - **Type:** Boolean @@ -110,9 +108,7 @@ The range. #### `ap_value_append?` -A string that gets appended to the default AP Value text with a preceding -space. This always happens if present, even if the generated AP Value text -is replaced. +A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. - **Type:** AdventurePointsValueAppend diff --git a/docs/reference/Disease.md b/docs/reference/Disease.md index d0ab8df2..8f4efc40 100644 --- a/docs/reference/Disease.md +++ b/docs/reference/Disease.md @@ -31,17 +31,13 @@ The disease's level. #### `resistance` -Depending on the disease, apply Spirit or Toughness as a penalty to the -disease roll. It may also happen that the lower of both is applied as a -penalty. +Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. - **Type:** Resistance #### `cause` -What causes the disease? The GM rolls 1D20 to see if a character gets -infected. If the infection check succeeds, the GM makes a disease check to -determine the severity of the infection. +What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. - **Type:** List - **Items:** Disease/cause[] diff --git a/docs/reference/FamiliarsTrick.md b/docs/reference/FamiliarsTrick.md index 470533af..348a5433 100644 --- a/docs/reference/FamiliarsTrick.md +++ b/docs/reference/FamiliarsTrick.md @@ -25,11 +25,9 @@ The familiar's trick's identifier. An unique, increasing integer. #### `animal_types` -The animal types this trick is available to. Either it is available to all -or only a list of specific animal types. +The animal types this trick is available to. Either it is available to all or only a list of specific animal types. -If no animal types are given, the animal disease applies to all animal -types. +If no animal types are given, the animal disease applies to all animal types. - **Type:** List - **Items:** FamiliarsTrick/animal_types[] @@ -48,8 +46,7 @@ The property of the trick. #### `ap_value?` -The AP value the familiar has to pay for. It may also be that a specific is -known by all familiar by default. In the latter case the field is not set. +The AP value the familiar has to pay for. It may also be that a specific is known by all familiar by default. In the latter case the field is not set. - **Type:** Integer - **Minimum:** `1` @@ -388,8 +385,7 @@ Key | Description | Details #### `per?` -The cost have to be per a specific countable entity, e.g. `8 KP -per person`. +The cost have to be per a specific countable entity, e.g. `8 KP per person`. - **Type:** ResponsiveTextOptional diff --git a/docs/reference/Lessons_Curriculum.md b/docs/reference/Lessons_Curriculum.md index db69becb..9850936d 100644 --- a/docs/reference/Lessons_Curriculum.md +++ b/docs/reference/Lessons_Curriculum.md @@ -1,16 +1,12 @@ # Curriculum -This is a curriculum of a specified academy, containing the guideline, -elective and restricted spellworks as well as the lesson packages of that -academy. +This is a curriculum of a specified academy, containing the guideline, elective and restricted spellworks as well as the lesson packages of that academy. ## Definitions ### Curriculum (`Curriculum`) -This is a curriculum of a specified academy, containing the guideline, -elective and restricted spellworks as well as the lesson packages of that -academy. +This is a curriculum of a specified academy, containing the guideline, elective and restricted spellworks as well as the lesson packages of that academy. - **Type:** Object @@ -178,10 +174,7 @@ Key | Description | Details #### `restriction?` -The elective spellwork may only take effect if a certain condition is met. -The condition may be related to professions or profession variants, but it -is designed so that it can work without a specific profession, as multiple -may belong to an institute, but with referencing other entities instead. +The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. - **Type:** ElectiveSpellworkRestriction @@ -189,10 +182,7 @@ may belong to an institute, but with referencing other entities instead. ### `ElectiveSpellworkRestriction` -The elective spellwork may only take effect if a certain condition is met. -The condition may be related to professions or profession variants, but it is -designed so that it can work without a specific profession, as multiple may -belong to an institute, but with referencing other entities instead. +The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. - **Type:** Object @@ -389,9 +379,7 @@ Exclude specific spellworks from the restriction. #### `maximum?` -Spellworks from this property up to a certain number are allowed. -Spellworks excluded from this restriction definition using `exclude` do -not contribute to the maximum. +Spellworks from this property up to a certain number are allowed. Spellworks excluded from this restriction definition using `exclude` do not contribute to the maximum. - **Type:** Number @@ -441,10 +429,7 @@ The lesson package's identifier. An unique, increasing integer. #### `spellwork_changes?` -The spell values difference of the lesson package. This field reflects the -changes (difference) to the field of the same name in the profession -package. If a spell gets to SR 0 because of this, it will be removed -completely. +The spell values difference of the lesson package. This field reflects the changes (difference) to the field of the same name in the profession package. If a spell gets to SR 0 because of this, it will be removed completely. - **Type:** List - **Items:** LessonPackage/spellwork_changes[] @@ -511,8 +496,7 @@ The name of the lesson package. #### `spellwork_changes?` -The spell values difference of the lesson package. Use this field to -specify a text that is displayed instead of the generated +The spell values difference of the lesson package. Use this field to specify a text that is displayed instead of the generated `spellwork_changes` list. The field is displayed even if no list is present. @@ -599,8 +583,7 @@ Key | Description | Details #### `points` -The combat technique points that will be added to the current combat -technique rating. +The combat technique points that will be added to the current combat technique rating. - **Type:** Integer - **Minimum:** `-6` @@ -649,9 +632,7 @@ Key | Description | Details #### `points` -The skill points that will be added to the current skill rating. If a -spell gets to a skill rating of 0 because of this, it will be removed -completely. +The skill points that will be added to the current skill rating. If a spell gets to a skill rating of 0 because of this, it will be removed completely. - **Type:** Integer - **Minimum:** `-10` @@ -659,7 +640,6 @@ completely. #### `tradition?` -The target tradition. If the target spell is not from the Guild Mage -tradition, specify the tradition identifier here. +The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here. - **Type:** MagicalTraditionIdentifier diff --git a/docs/reference/LiturgicalChant.md b/docs/reference/LiturgicalChant.md index 3d4d0f5d..8f2e0db4 100644 --- a/docs/reference/LiturgicalChant.md +++ b/docs/reference/LiturgicalChant.md @@ -53,9 +53,7 @@ The target category – the kind of creature or object – the skill affects. #### `traditions` -The tradition(s) the liturgical chant is available for. Note that general -aspects do not have an associated tradition and thus need to be defined in -a special way. +The tradition(s) the liturgical chant is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. - **Type:** List - **Items:** LiturgicalChant/traditions[] @@ -117,17 +115,13 @@ The name of the liturgical chant. #### `name_compressed?` -A compressed name of the liturgical chant for use in small areas (e.g. -on character sheet). Should only be defined if the `name` does not fit -on character sheet. +A compressed name of the liturgical chant for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. - **Type:** NonEmptyString #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/Locale.md b/docs/reference/Locale.md index 761e4ff3..fba9d9c4 100644 --- a/docs/reference/Locale.md +++ b/docs/reference/Locale.md @@ -36,7 +36,6 @@ Region in which the language is spoken in it's language. #### `is_missing_implementation?` -The language is not (fully) implemented and thus needs to be excluded from -stable releases. +The language is not (fully) implemented and thus needs to be excluded from stable releases. - **Constant:** `true` diff --git a/docs/reference/MetaCondition.md b/docs/reference/MetaCondition.md index d111c0b0..599aded6 100644 --- a/docs/reference/MetaCondition.md +++ b/docs/reference/MetaCondition.md @@ -1,16 +1,12 @@ # Meta Condition -Meta Conditions are rule elements that work like conditions in the sense that -they have four levels with different effects, but which are not explicitly -listed as conditions. +Meta Conditions are rule elements that work like conditions in the sense that they have four levels with different effects, but which are not explicitly listed as conditions. ## Definitions ### Meta Condition (`MetaCondition`) -Meta Conditions are rule elements that work like conditions in the sense that -they have four levels with different effects, but which are not explicitly -listed as conditions. +Meta Conditions are rule elements that work like conditions in the sense that they have four levels with different effects, but which are not explicitly listed as conditions. - **Type:** Object diff --git a/docs/reference/Patron.md b/docs/reference/Patron.md index 5cfec255..798f43a2 100644 --- a/docs/reference/Patron.md +++ b/docs/reference/Patron.md @@ -45,17 +45,14 @@ The patron-specific skills. #### `culture` -The patron is only available to a certain set of cultures. It may be -available to all, it may be available to only specific ones (intersection) -and it may be available to all except specific ones to the listed cultures +The patron is only available to a certain set of cultures. It may be available to all, it may be available to only specific ones (intersection) and it may be available to all except specific ones to the listed cultures (difference). - **Type:** PatronCulture #### `primary_patron_cultures?` -The list of cultures where patrons from this category can be the primary -patron of. +The list of cultures where patrons from this category can be the primary patron of. - **Type:** List - **Items:** Patron/primary_patron_cultures[] @@ -63,15 +60,13 @@ patron of. #### `powers?` -The patron-specific powers. Used by animist power Animal Powers I–III and -should only be present on animal patrons. +The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons. - **Type:** AnimalPowers #### `ae_cost?` -The patron-specific AE cost. Used by several animist forces for animal -patrons. +The patron-specific AE cost. Used by several animist forces for animal patrons. - **Type:** Integer - **Minimum:** `2` @@ -79,15 +74,13 @@ patrons. #### `improvement_cost?` -The patron-specific improvement cost. Used by several animist forces for -animal patrons. +The patron-specific improvement cost. Used by several animist forces for animal patrons. - **Type:** ImprovementCost #### `common_advantages?` -The patron may grant common advantages that are taken into account during -character creation. +The patron may grant common advantages that are taken into account during character creation. *Source:* Geisterwald & Knochenklippen, p. 6-7 @@ -96,8 +89,7 @@ character creation. #### `common_disadvantages?` -The patron may grant common disadvantages that are taken into account -during character creation. +The patron may grant common disadvantages that are taken into account during character creation. *Source:* Geisterwald & Knochenklippen, p. 6-7 @@ -169,9 +161,7 @@ The name of the patron. ### `PatronCulture` -The patron cultures the patron is or is not part of. If the patron is part of -all patron cultures, the set should be empty and the operation should be -difference. +The patron cultures the patron is or is not part of. If the patron is part of all patron cultures, the set should be empty and the operation should be difference. - **Type:** Object @@ -199,10 +189,7 @@ Key | Description | Details ### `PatronCultureOperation` -The set operation to combine the set of all patron cultures with the -specified set of patron cultures: If they should intersect, the patron is -only part of the given cultures. If they should differ, the patron is only -part of the cultures that are not given. +The set operation to combine the set of all patron cultures with the specified set of patron cultures: If they should intersect, the patron is only part of the given cultures. If they should differ, the patron is only part of the cultures that are not given. - **Type:** Union - **Cases:** PatronCultureOperation'0 | PatronCultureOperation'1 diff --git a/docs/reference/PatronCategory.md b/docs/reference/PatronCategory.md index 3f270208..82d08e73 100644 --- a/docs/reference/PatronCategory.md +++ b/docs/reference/PatronCategory.md @@ -21,8 +21,7 @@ The patron category's identifier. An unique, increasing integer. #### `primary_patron_cultures` -The list of cultures where patrons from this category can be the primary -patron of. +The list of cultures where patrons from this category can be the primary patron of. - **Type:** List - **Items:** PatronCategory/primary_patron_cultures[] diff --git a/docs/reference/PersonalityTrait.md b/docs/reference/PersonalityTrait.md index ecd4d0fc..7f68a641 100644 --- a/docs/reference/PersonalityTrait.md +++ b/docs/reference/PersonalityTrait.md @@ -1,16 +1,12 @@ # Personality Trait -A personality trait describes character aspects of a person from a certain -region. Higher trait levels only cover a part of the region covered by -lower-level traits. +A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits. ## Definitions ### Personality Trait (`PersonalityTrait`) -A personality trait describes character aspects of a person from a certain -region. Higher trait levels only cover a part of the region covered by -lower-level traits. +A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits. - **Type:** Object @@ -87,8 +83,7 @@ The name of the personality trait. #### `effects` -The effects of the personality trait. They should be sorted like they -are in the book. +The effects of the personality trait. They should be sorted like they are in the book. - **Type:** List - **Items:** PersonalityTraitTranslation/effects[] diff --git a/docs/reference/Profession.md b/docs/reference/Profession.md index f5917154..b8209b00 100644 --- a/docs/reference/Profession.md +++ b/docs/reference/Profession.md @@ -27,17 +27,9 @@ The profession group. #### `versions` -A list of professions representing the same profession but with (slightly) -different stats. For example, there may be a profession in a regional -sourcebook or in the core rules and a profession in an extension rulebook -like Magic of Aventuria, where the profession is basically called the same -and almost has the same values, but the version from Magic of Aventuria -features a spell style special ability that does not exist in the core -rules or regional sourcebook. +A list of professions representing the same profession but with (slightly) different stats. For example, there may be a profession in a regional sourcebook or in the core rules and a profession in an extension rulebook like Magic of Aventuria, where the profession is basically called the same and almost has the same values, but the version from Magic of Aventuria features a spell style special ability that does not exist in the core rules or regional sourcebook. -The profession representation may feature different values for different -explicitly mentioned experience levels. In most cases, there is only one -stats package, which targets the experience level *Experienced*. +The profession representation may feature different values for different explicitly mentioned experience levels. In most cases, there is only one stats package, which targets the experience level *Experienced*. - **Type:** List - **Items:** Profession/versions[] @@ -220,8 +212,7 @@ Key | Description | Details #### `id` -The profession representation variant's identifier. An unique, increasing -integer. +The profession representation variant's identifier. An unique, increasing integer. - **Type:** Integer - **Minimum:** `1` @@ -255,8 +246,7 @@ Key | Description | Details #### `id` -The profession representation variant's identifier. An unique, increasing -integer. +The profession representation variant's identifier. An unique, increasing integer. - **Type:** Integer - **Minimum:** `1` @@ -295,8 +285,7 @@ Key | Description | Details #### `experience_level_id` -The experience level this profession targets. The experience level -must be unique for this representation. +The experience level this profession targets. The experience level must be unique for this representation. - **Type:** Integer - **Default:** `3` @@ -338,16 +327,13 @@ What does the professional package cost in adventure points? #### `prerequisites?` -Which prerequisites must be met to buy the stat block? For example, a -character might need the advantage Spellcaster or Blessed. Note: the AP -cost for a profession package does not include these prerequisites. +Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. - **Type:** ProfessionPrerequisites #### `options?` -In some areas, the profession package grants a loose set of stats where the -player must choose between different options for the profession package. +In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. - **Type:** ProfessionPackageOptions @@ -360,8 +346,7 @@ Any special abilities the profession receives from the package. #### `combat_techniques?` -Provides ratings for the combat techniques that the hero receives from the -package. +Provides ratings for the combat techniques that the hero receives from the package. - **Type:** List - **Items:** ProfessionPackage/combat_techniques[] @@ -375,17 +360,14 @@ The skill ratings the package grants to the hero. #### `spells?` -The skill ratings a magical profession receives for spells; these spells -are considered activated. Spells from an unfamiliar Tradition, if any, are -identified as such. +The skill ratings a magical profession receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. - **Type:** List - **Items:** ProfessionPackage/spells[] #### `liturgical_chants?` -Clerical professions receive these liturgical chants at the listed skill -ratings. These liturgical chants are considered activated. +Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. - **Type:** List - **Items:** ProfessionPackage/liturgical_chants[] @@ -408,8 +390,7 @@ Typical disadvantages for the profession. #### `unsuitable_advantages?` -These advantages do not fit well with this profession; to be checked with -the GM before taking any of them. +These advantages do not fit well with this profession; to be checked with the GM before taking any of them. - **Type:** List - **Items:** ProfessionPackage/unsuitable_advantages[] @@ -417,8 +398,7 @@ the GM before taking any of them. #### `unsuitable_disadvantages?` -These disadvantages do not fit well with this profession; to be checked -with the GM before taking any of them. +These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. - **Type:** List - **Items:** ProfessionPackage/unsuitable_disadvantages[] @@ -426,11 +406,7 @@ with the GM before taking any of them. #### `variants?` -Provides examples of variants for the profession, which may include changes -to AP values and additional or modified skill ratings, special abilities, -or combat techniques, as compared to the basic profession. Usually picking -a variant is optional, but there are some rare exceptions where picking a -variant is required. +Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. - **Type:** ProfessionVariants @@ -512,9 +488,7 @@ Name of the basic profession. #### `specification?` -A name addition of the profession. This will contain texts like name of -the academy or the witch circle. It is enclosed in parenthesis, but the -database entry must not contain parenthesis. +A name addition of the profession. This will contain texts like name of the academy or the witch circle. It is enclosed in parenthesis, but the database entry must not contain parenthesis. - **Type:** ProfessionName @@ -532,15 +506,13 @@ Typical disadvantages for the profession. #### `unsuitable_advantages?` -These advantages do not fit well with this profession; to be checked with -the GM before taking any of them. +These advantages do not fit well with this profession; to be checked with the GM before taking any of them. - **Type:** NonEmptyString #### `unsuitable_disadvantages?` -These disadvantages do not fit well with this profession; to be checked -with the GM before taking any of them. +These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. - **Type:** NonEmptyString @@ -552,11 +524,7 @@ with the GM before taking any of them. ### `ProfessionVariants` -Provides examples of variants for the profession, which may include changes -to AP values and additional or modified skill ratings, special abilities, or -combat techniques, as compared to the basic profession. Usually picking a -variant is optional, but there are some rare exceptions where picking a -variant is required. +Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. - **Type:** Object @@ -619,9 +587,7 @@ The AP value you have to pay for the package variant. #### `prerequisites?` -Which prerequisites must be met to buy the stat block? For example, a -character might need the advantage Spellcaster or Blessed. Note: the AP -cost for a profession package does not include these prerequisites. +Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. - **Type:** ProfessionPrerequisites @@ -638,8 +604,7 @@ Any special abilities the profession receives from the package variant. #### `combat_techniques?` -Provides ratings for the combat techniques that the hero receives from the -package variant. +Provides ratings for the combat techniques that the hero receives from the package variant. - **Type:** List - **Items:** ProfessionVariant/combat_techniques[] @@ -653,17 +618,14 @@ The skill ratings the package variant grants to the hero. #### `spells?` -The skill ratings a magical profession variant receives for spells; these -spells are considered activated. Spells from an unfamiliar Tradition, if -any, are identified as such. +The skill ratings a magical profession variant receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. - **Type:** List - **Items:** ProfessionVariant/spells[] #### `liturgical_chants?` -Clerical professions receive these liturgical chants at the listed skill -ratings. These liturgical chants are considered activated. +Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. - **Type:** List - **Items:** ProfessionVariant/liturgical_chants[] @@ -836,8 +798,7 @@ The level of the received special ability. #### `options?` -Received select options. Order is important. Typically, you only need the -first array index, though. +Received select options. Order is important. Typically, you only need the first array index, though. - **Type:** List - **Items:** SpecialAbilityDefinition/options[] @@ -915,8 +876,7 @@ The identifier of the combat technique to provide the rating for. #### `active?` -if set to `false`, if the selection is granted by the basic package, it -is removed. +if set to `false`, if the selection is granted by the basic package, it is removed. - **Constant:** `false` @@ -929,8 +889,7 @@ The level of the received special ability. #### `options?` -Received select options. Order is important. Typically, you only need the -first array index, though. +Received select options. Order is important. Typically, you only need the first array index, though. - **Type:** List - **Items:** FixedVariantSpecialAbility/options[] @@ -955,8 +914,7 @@ Key | Description | Details #### `active?` -if set to `false`, if the selection is granted by the basic package, it -is removed. +if set to `false`, if the selection is granted by the basic package, it is removed. - **Constant:** `false` @@ -991,8 +949,7 @@ The identifier of the combat technique to provide the rating for. #### `rating` -The rating bonus provided for the combat technique. If used in a profession -variant, it can also be used to lower the bonus of the base profession. +The rating bonus provided for the combat technique. If used in a profession variant, it can also be used to lower the bonus of the base profession. **Note:** This is a rating *bonus*, so it will be *added* to the default value of 6. @@ -1020,8 +977,7 @@ The identifier of the skill to provide the rating for. #### `rating` -The rating bonus provided for the skill. If used in a profession variant, -it can also be used to lower the bonus of the base profession +The rating bonus provided for the skill. If used in a profession variant, it can also be used to lower the bonus of the base profession - **Type:** Integer - **Minimum:** `-8` @@ -1040,9 +996,7 @@ Key | Description | Details #### `id` -The identifier(s) of the spell(s) to choose from to provide the rating for. -If multiple spells are provided, they must all have the same improvement -cost. +The identifier(s) of the spell(s) to choose from to provide the rating for. If multiple spells are provided, they must all have the same improvement cost. - **Type:** List - **Items:** SpellRating/id[] @@ -1050,8 +1004,7 @@ cost. #### `rating` -The rating bonus provided for the (selected) spell. If used in a profession -variant, it can also be used to lower the bonus of the base profession. +The rating bonus provided for the (selected) spell. If used in a profession variant, it can also be used to lower the bonus of the base profession. - **Type:** Integer - **Minimum:** `-10` @@ -1127,11 +1080,7 @@ The identifier of the spell to provide the rating for. #### `tradition?` -If the spell is not part of the magical tradition required by the -package, this references the magical tradition it is part of. It can also -be used to define the target magical tradition of a spell if multiple -magical traditions are required and the spell is available to multiple -of them. +If the spell is not part of the magical tradition required by the package, this references the magical tradition it is part of. It can also be used to define the target magical tradition of a spell if multiple magical traditions are required and the spell is available to multiple of them. - **Type:** MagicalTraditionReference @@ -1164,9 +1113,7 @@ Key | Description | Details #### `id` -The identifier(s) of the liturgical chant(s) to choose from to provide -the rating for. If multiple liturgical chants are provided, they must all -have the same improvement cost. +The identifier(s) of the liturgical chant(s) to choose from to provide the rating for. If multiple liturgical chants are provided, they must all have the same improvement cost. - **Type:** List - **Items:** LiturgicalChantRating/id[] @@ -1174,9 +1121,7 @@ have the same improvement cost. #### `rating` -The rating bonus provided for the selected liturgical chant. If used in a -profession variant, it can also be used to lower the bonus of the base -profession. +The rating bonus provided for the selected liturgical chant. If used in a profession variant, it can also be used to lower the bonus of the base profession. - **Type:** Integer - **Minimum:** `-10` @@ -1192,8 +1137,7 @@ profession. ### `ProfessionPackageOptions` -In some areas, the profession package grants a loose set of stats where the -player must choose between different options for the profession package. +In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. - **Type:** Object - **Minimum Properties:** `1` @@ -1240,9 +1184,7 @@ Key | Description | Details ### `ProfessionVariantPackageOptions` -In some areas, the profession package grants a loose set of stats where the -player must choose between different options for the profession package. The -variant may override or remove those options. +In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. The variant may override or remove those options. - **Type:** Object - **Minimum Properties:** `1` @@ -1340,9 +1282,7 @@ Key | Description | Details ### `SkillSpecializationOptions` -Select an application from a skill or from one of a list of skills where you -get a skill specialization for. You can also specify a skill groups from -which you can choose a skill. +Select an application from a skill or from one of a list of skills where you get a skill specialization for. You can also specify a skill groups from which you can choose a skill. - **Type:** Union - **Cases:** SkillSpecializationOptions'Single | SkillSpecializationOptions'Group @@ -1452,9 +1392,7 @@ Key | Description | Details #### `fixed` -Specify the number of combat techniques that can be selected so that they -get increased to a specific CtR. There can be multiple selections with -different CtRs. +Specify the number of combat techniques that can be selected so that they get increased to a specific CtR. There can be multiple selections with different CtRs. - **Type:** List - **Items:** CombatTechniquesOptions/fixed[] @@ -1462,8 +1400,7 @@ different CtRs. #### `rest_rating?` -Define if after the fixed selections the remaining unselected combat -techniques will receive a certain rating bonus as well. +Define if after the fixed selections the remaining unselected combat techniques will receive a certain rating bonus as well. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/Property.md b/docs/reference/Property.md index d72befbd..169258b8 100644 --- a/docs/reference/Property.md +++ b/docs/reference/Property.md @@ -21,8 +21,7 @@ The property's identifier. An unique, increasing integer. #### `check?` -The property check's attributes. Only the properties from the Core Rules -have defined property checks. +The property check's attributes. Only the properties from the Core Rules have defined property checks. - **Type:** SkillCheck diff --git a/docs/reference/Race.md b/docs/reference/Race.md index aadc8172..d8d92588 100644 --- a/docs/reference/Race.md +++ b/docs/reference/Race.md @@ -47,16 +47,13 @@ The race’s base values. #### `attribute_adjustments` -Describes how to raise or lower maximum attribute values during character -creation. +Describes how to raise or lower maximum attribute values during character creation. - **Type:** AttributeAdjustments #### `automatic_advantages?` -A list of automatically applied advantages. This does only work for -advantages with no further configuration such as level or special -selection. +A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection. - **Type:** List - **Items:** Race/automatic_advantages[] @@ -86,8 +83,7 @@ Configuration for random weight generation. #### `starting_age` -Defines the starting ages for the race. It depends on the selected -experience level. +Defines the starting ages for the race. It depends on the selected experience level. - **Type:** List - **Items:** Race/starting_age[] @@ -96,9 +92,7 @@ experience level. #### `variants` -A list of available race variants where one has to be selected. If no -variants are to be selected, a single variant with no name has to be provided -which will be used as the missing values for the base race. +A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. - **Type:** RaceVariants @@ -180,8 +174,7 @@ The race’s tactical movement rate. ### `AttributeAdjustments` -Describes how to raise or lower maximum attribute values during character -creation. +Describes how to raise or lower maximum attribute values during character creation. - **Type:** Object - **Minimum Properties:** `1` @@ -201,12 +194,9 @@ The values by which the maximum of the respective attribute is modified. #### `selectable?` -An array of attribute maximum modifiers, where the attribute they apply to -is selected from a list of options. +An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options. -The array only permits a single entry because no race specified more than -one selectable attribute adjustment so far. But the schema allows for -multiple entries to be future-proof. +The array only permits a single entry because no race specified more than one selectable attribute adjustment so far. But the schema allows for multiple entries to be future-proof. - **Type:** List - **Items:** AttributeAdjustments/selectable[] @@ -255,9 +245,7 @@ The value by which the specified attribute's maximum is modified ### `SelectableAttributeAdjustment` -A value that will be added to the current maximum of the selected attribute -that has been chosen from the listed attributes (negative values will lower -the maximum). +A value that will be added to the current maximum of the selected attribute that has been chosen from the listed attributes (negative values will lower the maximum). - **Type:** Object @@ -349,9 +337,7 @@ Number of sides on every die. Example: 6 in 2D6. #### `offset_strategy` -The strategy how to offset the randomly generated values against the -base value. Either they are all added or subtracted or even results are -added and odd results are subtracted. +The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. - **Type:** WeightDiceOffsetStrategy @@ -359,9 +345,7 @@ added and odd results are subtracted. ### `WeightDiceOffsetStrategy` -The strategy how to offset the randomly generated values against the -base value. Either they are all added or subtracted or even results are -added and odd results are subtracted. +The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. - **Type:** Union - **Cases:** WeightDiceOffsetStrategy'0 | WeightDiceOffsetStrategy'1 | WeightDiceOffsetStrategy'2 @@ -411,8 +395,7 @@ The base value for the selected experience level. #### `random` -The random value for the selected experience level. It is going to be -added to the base value. +The random value for the selected experience level. It is going to be added to the base value. - **Type:** Dice @@ -420,9 +403,7 @@ added to the base value. ### `RaceVariants` -A list of available race variants where one has to be selected. If no -variants are to be selected, a single variant with no name has to be provided -which will be used as the missing values for the base race. +A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. - **Type:** List - **Items:** RaceVariants[] @@ -502,8 +483,7 @@ A list of uncommon disadvantages. #### `hair_color` -An array containing 20 (numeric) hair color identifiers. The array also -represents the 20-sided die for a random hair color. +An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color. - **Type:** List - **Items:** RaceVariant/hair_color[] @@ -512,8 +492,7 @@ represents the 20-sided die for a random hair color. #### `eye_color` -An array containing 20 (numeric) eye color identifiers. The array also -represents the 20-sided die for a random eye color. +An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color. - **Type:** List - **Items:** RaceVariant/eye_color[] @@ -624,9 +603,7 @@ Key | Description | Details #### `name?` -The race variant's name. If left empty, it defaults to the base race name. -This can be used if the race has no (visible) variants so that a single -variant has to be provided. +The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided. - **Type:** NonEmptyString @@ -695,8 +672,7 @@ The respective strongly recommended advantages text from the source book. #### `strongly_recommended_disadvantages?` -The respective strongly recommended disadvantages text from the source -book. +The respective strongly recommended disadvantages text from the source book. - **Type:** NonEmptyString diff --git a/docs/reference/Ritual.md b/docs/reference/Ritual.md index 3d885094..147ad25c 100644 --- a/docs/reference/Ritual.md +++ b/docs/reference/Ritual.md @@ -60,9 +60,7 @@ The associated property. #### `traditions` -The tradition(s) the ritual is available for. It may be *generally* -available to all traditions or it may be only familiar in specific -traditions. +The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. - **Type:** Traditions @@ -116,9 +114,7 @@ The name of the ritual. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/SexPractice.md b/docs/reference/SexPractice.md index 9303d21e..221b1d1e 100644 --- a/docs/reference/SexPractice.md +++ b/docs/reference/SexPractice.md @@ -63,8 +63,7 @@ How long a round of this sex practice takes. #### `prerequisites?` -Prerequisites of participants and environment. Do not specify if the -sex practice has no prerequisites. +Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites. - **Type:** NonEmptyString diff --git a/docs/reference/Skill.md b/docs/reference/Skill.md index cf77a57c..76bd5c70 100644 --- a/docs/reference/Skill.md +++ b/docs/reference/Skill.md @@ -32,9 +32,7 @@ Lists the linked three attributes used to make a skill check. #### `applications` -Lists applications for the skill, if any. This does not necessarily include -all possible applications. There may also be new applications that could be -purchased via certain advantages or special abilities. +Lists applications for the skill, if any. This does not necessarily include all possible applications. There may also be new applications that could be purchased via certain advantages or special abilities. - **Type:** Applications @@ -92,24 +90,19 @@ The name of the skill. #### `applications_input_label?` -If there are options available that can not be put into a selection -list (like different cults), provide the label text for the input -element here. Otherwise leave empty. +If there are options available that can not be put into a selection list (like different cults), provide the label text for the input element here. Otherwise leave empty. - **Type:** NonEmptyString #### `encumbrance_description?` -The text listing the certain circumstances in which the encumbrance may -count. This text must be used if `encumbrance` is set to `"Maybe"`, -otherwise it is ignored if defined. +The text listing the certain circumstances in which the encumbrance may count. This text must be used if `encumbrance` is set to `"Maybe"`, otherwise it is ignored if defined. - **Type:** NonEmptyString #### `tools?` -Mentions any tools from the equipment list that are necessary to employ -the skill. +Mentions any tools from the equipment list that are necessary to employ the skill. - **Type:** NonEmptyMarkdown @@ -145,8 +138,7 @@ Lists examples of results for botches. ### `ApplicationCategory` -A category. All available entries from the specified category will be -included as separate applications. +A category. All available entries from the specified category will be included as separate applications. - **Type:** Union - **Cases:** ApplicationCategory'0 | ApplicationCategory'1 | ApplicationCategory'2 diff --git a/docs/reference/SkillModificationLevel.md b/docs/reference/SkillModificationLevel.md index 9f6be390..ff23a6d7 100644 --- a/docs/reference/SkillModificationLevel.md +++ b/docs/reference/SkillModificationLevel.md @@ -161,15 +161,13 @@ Key | Description | Details #### `fast?` -Configuration for this level for fast skills (spells, liturgical chants). -Values set here override the default generated text. +Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text. - **Type:** LevelTypeConfigTranslation #### `slow?` -Configuration for this level for slow skills (rituals, ceremonies). Values -set here override the default generated text. +Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text. - **Type:** LevelTypeConfigTranslation @@ -177,8 +175,7 @@ set here override the default generated text. ### `LevelTypeConfigTranslation` -Configuration translation of a type for a level. Values set here override the -default generated text. +Configuration translation of a type for a level. Values set here override the default generated text. - **Type:** Object diff --git a/docs/reference/Spell.md b/docs/reference/Spell.md index ba5e8c40..bda55f4f 100644 --- a/docs/reference/Spell.md +++ b/docs/reference/Spell.md @@ -60,9 +60,7 @@ The associated property. #### `traditions` -The tradition(s) the spell is available for. It may be *generally* -available to all traditions or it may be only familiar in specific -traditions. +The tradition(s) the spell is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. - **Type:** Traditions @@ -115,9 +113,7 @@ The name of the spell. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/_Activatable.md b/docs/reference/_Activatable.md index 65a3c96a..b300a391 100644 --- a/docs/reference/_Activatable.md +++ b/docs/reference/_Activatable.md @@ -24,8 +24,7 @@ The name of the activatable entry. ### `NameInLibrary` -The full name of the entry as stated in the sources. Only use when `name` -needs to be different from full name for text generation purposes. +The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. - **Type:** String - **Minimum Length:** `1` @@ -43,8 +42,7 @@ Number of available levels. ### `Maximum` -The number stating how often you can buy the entry. The **default** depends on -the entry type: +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**) @@ -60,18 +58,9 @@ The maximum is only set if it differs from the defaults specified above. ### `SelectOptions` -Definitions for possible options for the activatable entry. They can either -be derived from entry categories or be defined explicitly. Both can happen as -well, but if there is an explicitly defined select option and a derived -select option has the same identifier (which may only happen if skill or -combat technique identifiers are used for explicit select options), the -explicit definition overwrites the derived option. +Definitions for possible options for the activatable entry. They can either be derived from entry categories or be defined explicitly. Both can happen as well, but if there is an explicitly defined select option and a derived select option has the same identifier (which may only happen if skill or combat technique identifiers are used for explicit select options), the explicit definition overwrites the derived option. -Note that this is only a full definition of options for simple logic that can -be made explicit using the more detailed configuration for both derived -categories and explicit options. There are quite a few entries whose option -logic cannot be fully represented here, so that it needs to be implemented -manually. +Note that this is only a full definition of options for simple logic that can be made explicit using the more detailed configuration for both derived categories and explicit options. There are quite a few entries whose option logic cannot be fully represented here, so that it needs to be implemented manually. - **Type:** Object - **Minimum Properties:** `1` @@ -83,21 +72,13 @@ Key | Description | Details #### `derived?` -An entry category with optional further configuration. All available -entries from the specified categories will be included as separate select -options. You can also specify a set of groups that should only be -included. Groups not mentioned will be excluded then. +An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then. - **Type:** SelectOptionCategory #### `explicit?` -A list of explicit select options. If the identifier has a specific type, -its entry is the base of this select option, where values defined here -override values from the base. Define the `src` property if the options -are not derived from the rules text of the advantage/disadvantage/special -ability but instead are listed in a separate block and/or on a separate -page. +A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the `src` property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page. - **Type:** List - **Items:** SelectOptions/explicit[] @@ -200,28 +181,19 @@ The option's identifier. An unique, increasing integer. #### `profession_only?` -Sometimes, professions use specific text selections that are not -contained in described lists. This ensures you can use them for -professions only. They are not going to be displayed as options to the -user. +Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user. - **Constant:** `true` #### `skill_applications?` -Registers new applications, which get enabled once this entry is -activated with its respective select option. It specifies an entry-unique -identifier and the skill it belongs to. A translation can be left out if -its name equals the name of the origin select option. +Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. - **Type:** SkillApplications #### `skill_uses?` -Registers uses, which get enabled once this entry is activated with its -respective select option. It specifies an entry-unique identifier and the -skill it belongs to. A translation can be left out if its name equals the -name of the origin select option. +Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. - **Type:** SkillUses @@ -231,8 +203,7 @@ name of the origin select option. #### `binding_cost?` -Specific binding cost for the select option. Only has an effect if the -associated entry supports binding costs. +Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. - **Type:** Integer - **Minimum:** `0` @@ -276,16 +247,14 @@ The name of the select option. #### `name_in_profession?` -The name of the select option when displayed in a generated -profession text. +The name of the select option when displayed in a generated profession text. - **Type:** String - **Minimum Length:** `1` #### `description?` -The description of the select option. Useful for Bad Habits, Trade -Secrets and other entries where a description is available. +The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available. - **Type:** Markdown-formatted text - **Minimum Length:** `1` @@ -319,10 +288,7 @@ The skill's identifier. An unique, increasing integer. #### `skill_applications?` -Registers new applications, which get enabled once this entry is -activated with its respective select option. It specifies an entry-unique -identifier and the skill it belongs to. A translation can be left out if -its name equals the name of the origin select option. +Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. - **Type:** List - **Items:** ExplicitSkillSelectOption/skill_applications[] @@ -330,10 +296,7 @@ its name equals the name of the origin select option. #### `skill_uses?` -Registers uses, which get enabled once this entry is activated with its -respective select option. It specifies an entry-unique identifier and the -skill it belongs to. A translation can be left out if its name equals the -name of the origin select option. +Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. - **Type:** List - **Items:** ExplicitSkillSelectOption/skill_uses[] @@ -345,8 +308,7 @@ name of the origin select option. #### `binding_cost?` -Specific binding cost for the select option. Only has an effect if the -associated entry supports binding costs. +Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. - **Type:** Integer - **Minimum:** `0` @@ -422,8 +384,7 @@ The combat technique's identifier. #### `binding_cost?` -Specific binding cost for the select option. Only has an effect if the -associated entry supports binding costs. +Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. - **Type:** Integer - **Minimum:** `0` @@ -507,8 +468,7 @@ The definition of how the combat special ability can be used in combat. ### `CombatSpecialAbilityType` -The definition of if the combat special ability can be used when armed or -when unarmed. +The definition of if the combat special ability can be used when armed or when unarmed. - **Type:** Union - **Cases:** CombatSpecialAbilityType'0 | CombatSpecialAbilityType'1 @@ -529,10 +489,7 @@ when unarmed. ### `SkillApplications` -Registers new skill applications, which get enabled once this entry is -activated. It specifies an entry-unique identifier and the skill it belongs -to. A translation can be left out if its name equals the name of the origin -activatable entry. +Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. - **Type:** List - **Items:** SkillApplications[] @@ -641,9 +598,7 @@ The skills this application belongs to. #### `required_skill_rating?` -If an application applies to multiple skills, it may need to ensure the -respective skill is on a certain skill rating if the activatable entry -cannot ensure this prerequisite. +If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite. - **Type:** Integer - **Minimum:** `1` @@ -674,9 +629,7 @@ The name of the application if different from the activatable entry's name. ### `SkillUses` -Registers uses, which get enabled once this entry is activated. It specifies -an entry-unique identifier and the skill it belongs to. A translation can be -left out if its name equals the name of the origin activatable entry. +Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. - **Type:** List - **Items:** SkillUses[] @@ -1171,9 +1124,7 @@ Key | Description | Details #### `levels` -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. +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. - **Type:** List - **Items:** PenaltyByLevel/levels[] @@ -1181,8 +1132,7 @@ second level, and so on. #### `external?` -The combat-related special ability of which the level defines the penalty -instead. +The combat-related special ability of which the level defines the penalty instead. - **Type:** PenaltyByExternalLevel @@ -1212,8 +1162,7 @@ The penalty value for this level. ### `PenaltyByExternalLevel` -The combat-related special ability of which the level defines the penalty -instead. +The combat-related special ability of which the level defines the penalty instead. - **Type:** Object @@ -1223,8 +1172,7 @@ Key | Description | Details #### `id` -The identifier of the combat-related special ability of which the level -defines the penalty instead. +The identifier of the combat-related special ability of which the level defines the penalty instead. - **Type:** CombatRelatedSpecialAbilityIdentifier @@ -1242,12 +1190,7 @@ Key | Description | Details #### `list` -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. +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. - **Type:** List - **Items:** PenaltyByAttack/list[] @@ -1525,9 +1468,7 @@ Specified if the AE cost `value` has to be paid for each time interval. #### `per_level?` -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`). +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`). - **Type:** FixedArcaneEnergyCostPerLevel @@ -1541,9 +1482,7 @@ All translations for the entry, identified by IETF language tag (BCP47). ### `FixedArcaneEnergyCostPerLevel` -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`). +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`). - **Type:** Union - **Cases:** FixedArcaneEnergyCostPerLevel'0 | FixedArcaneEnergyCostPerLevel'1 @@ -1598,8 +1537,7 @@ The AE cost value that has to be per a specific countable entity. #### `base_value?` -If defined, in addition to the cost per entity you have to pay a flat -amount, regardless of the entity count. +If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count. - **Type:** Integer - **Minimum:** `1` @@ -1623,8 +1561,7 @@ Key | Description | Details #### `per` -The cost have to be per a specific countable entity, e.g. `8 AE per -person`. +The cost have to be per a specific countable entity, e.g. `8 AE per person`. - **Type:** ResponsiveText @@ -1671,8 +1608,7 @@ Key | Description | Details #### `value` -The AE cost value that has to be payed for activation. Half of this value -has to be payed each interval. +The AE cost value that has to be payed for activation. Half of this value has to be payed each interval. - **Type:** Integer - **Minimum:** `2` @@ -1697,8 +1633,7 @@ Key | Description | Details #### `modifier?` -Specified if the indefinite AP cost description needs to be modified by a -certain value. +Specified if the indefinite AP cost description needs to be modified by a certain value. - **Type:** IndefiniteArcaneEnergyCostModifier @@ -1767,8 +1702,7 @@ Key | Description | Details #### `interval?` -Specified if the selected AE cost option has to be paid for each time -interval. +Specified if the selected AE cost option has to be paid for each time interval. - **Type:** ArcaneEnergyCostDisjunctionInterval @@ -1816,8 +1750,7 @@ 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. +This works different than other sustained spells, since for them the end of the cast usually already counts as part of the first interval. - **Type:** Boolean @@ -2046,9 +1979,7 @@ Key | Description | Details #### `list` -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. +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. - **Type:** List - **Items:** VolumeByLevel/list[] @@ -2081,9 +2012,7 @@ The volume points for this level. ### `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: +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: @@ -2119,9 +2048,7 @@ options: 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. +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. - **Type:** Object @@ -2177,10 +2104,7 @@ Place a string after the grouped map option labels. #### `replacement?` -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. +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. - **Type:** String @@ -2257,8 +2181,7 @@ The description of the option for cost string generation. #### `label_standalone?` -The description of the option if used standalone. Only used if -different from `label`. +The description of the option if used standalone. Only used if different from `label`. - **Type:** NonEmptyString @@ -2378,8 +2301,7 @@ Key | Description | Details The permanent AE cost. -If the enchantment has multiple levels, it is only applied for the first -level. +If the enchantment has multiple levels, it is only applied for the first level. - **Type:** Integer - **Minimum:** `1` @@ -2405,9 +2327,7 @@ The permanent AE cost per level. ### `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: +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: @@ -2485,10 +2405,7 @@ Place a string after the grouped map option labels. #### `replacement?` -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. +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. - **Type:** NonEmptyString @@ -2535,8 +2452,7 @@ The description of the option for cost string generation. #### `label_standalone?` -The description of the option if used standalone. Only used if -different from `label`. +The description of the option if used standalone. Only used if different from `label`. - **Type:** NonEmptyString @@ -2561,8 +2477,7 @@ The binding cost for the selection if it does not define a specific one. ### `PropertyDeclaration` -The magic property's identifier. `DependingOnProperty` can only be used if -the special ability has an option to select a property. +The magic property's identifier. `DependingOnProperty` can only be used if the special ability has an option to select a property. - **Type:** Union - **Cases:** PropertyDeclaration'DependingOnSelection | PropertyDeclaration'Fixed @@ -2723,8 +2638,7 @@ The advanced special ability’s identifier. #### `option` -Specify the select option(s) that only are allowed for the referenced -advanced special ability; others are disallowed. +Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed. - **Type:** List - **Items:** RestrictAdvancedSpecialAbilityOptions/option[] @@ -2758,8 +2672,7 @@ The possible advanced special abilities. #### `is_selection_required_on_purchase` -Do have to choose the advanced special ability when buying the style -special ability? Otherwise the decision can be made later. +Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later. - **Type:** Boolean @@ -2813,8 +2726,7 @@ Map options from the external entry to allowed advanced special abilities. ### `AdvancedSpecialAbilityDerivedFromExternalOptionMapping` -Mapping from an option of the external entry to an allowed advanced special -ability. +Mapping from an option of the external entry to an allowed advanced special ability. - **Type:** Object @@ -2851,11 +2763,7 @@ The advanced special ability's identifier. ### `AdvancedSpecialAbilities` -The Advanced Special Abilities for the respective Style Special Ability. -Sometimes, only a specific select option or a set of select options of an -entry is allowed, which can be modelled by the option property. It can also -be that you can choose from a set of special abilities, but then you can't -specify an option. +The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option. - **Type:** List - **Items:** AdvancedSpecialAbilities[] @@ -2872,8 +2780,7 @@ specify an option. ### `PrerequisitesReplacement` -The prerequisites text. It is only used if the text cannot be generated from -the given information. +The prerequisites text. It is only used if the text cannot be generated from the given information. - **Type:** NonEmptyMarkdown @@ -3865,8 +3772,7 @@ Key | Description | Details ### `FixedAdventurePointsValue` -A fixed adventure points value. If the entry has levels, this is the cost per -level as well. +A fixed adventure points value. If the entry has levels, this is the cost per level as well. - **Type:** AdventurePointsSingleValue @@ -3874,8 +3780,7 @@ level as well. ### `AdventurePointsValueByLevel` -An entry with levels may have different costs for each level. The length of -the list must match the amount of levels the special ability has. +An entry with levels may have different costs for each level. The length of the list must match the amount of levels the special ability has. - **Type:** List - **Items:** AdventurePointsValueByLevel[] @@ -3891,10 +3796,7 @@ the list must match the amount of levels the special ability has. ### `AdventurePointsDerivedFromSelection` -The adventure points value is derived from the selection of the special -ability. Its display value may be able to be derived from the given -information for the select options. If that is not the case or the generated -text would not match the original one, a replacement text can be provided. +The adventure points value is derived from the selection of the special ability. Its display value may be able to be derived from the given information for the select options. If that is not the case or the generated text would not match the original one, a replacement text can be provided. - **Type:** Object @@ -3921,8 +3823,7 @@ Key | Description | Details #### `replacement?` -A replacement for the generated text if it would not match the original -one. +A replacement for the generated text if it would not match the original one. - **Type:** NonEmptyMarkdown @@ -3947,8 +3848,7 @@ A string that is used as a label for an input field. ### `AdventurePointsValueReplacement` -The AP value. It is only used if the text cannot be generated from the given -information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** NonEmptyMarkdown @@ -3956,8 +3856,6 @@ information. ### `AdventurePointsValueAppend` -A string that gets appended to the default AP Value text with a preceding -space. This always happens if present, even if the generated AP Value text is -replaced. +A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. - **Type:** NonEmptyMarkdown diff --git a/docs/reference/_ActivatableSelectOptionCategory.md b/docs/reference/_ActivatableSelectOptionCategory.md index 9e42d34f..7dbe346e 100644 --- a/docs/reference/_ActivatableSelectOptionCategory.md +++ b/docs/reference/_ActivatableSelectOptionCategory.md @@ -484,8 +484,7 @@ Key | Description | Details #### `require_principles?` -Should the principles (code) of the tradition be required to select the -respective tradition? +Should the principles (code) of the tradition be required to select the respective tradition? - **Constant:** `true` @@ -533,8 +532,7 @@ Does each property require it's corresponding property knowledge? #### `require_minimum_spellworks_on?` -Require a minimum number of spellworks of the respective property to be -on a minimum skill rating. +Require a minimum number of spellworks of the respective property to be on a minimum skill rating. - **Type:** RequiredMinimumSkillsToBeOnSkillRating @@ -558,17 +556,13 @@ Does each aspect require it's corresponding aspect knowledge? #### `use_master_of_suffix_as_name?` -The generated name should be the *Master of (Aspect)* suffix for this -aspect instead of the aspect's name. If an aspect does not provide a -suffix (such as the General aspect), it is automatically excluded from -the list. +The generated name should be the *Master of (Aspect)* suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list. - **Constant:** `true` #### `require_minimum_liturgies_on?` -Require a minimum number of liturgies of the respective aspect to be on a -minimum skill rating. +Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating. - **Type:** RequiredMinimumSkillsToBeOnSkillRating @@ -576,8 +570,7 @@ minimum skill rating. ### `RequiredMinimumSkillsToBeOnSkillRating` -Require a minimum number of spellworks/liturgies of the respective -property/aspect to be on a minimum skill rating. +Require a minimum number of spellworks/liturgies of the respective property/aspect to be on a minimum skill rating. - **Type:** Object @@ -588,16 +581,14 @@ Key | Description | Details #### `number` -The minimum number of liturgies that need to be on the defined minimum -skill rating. +The minimum number of liturgies that need to be on the defined minimum skill rating. - **Type:** Integer - **Minimum:** `1` #### `rating` -The minimum skill rating the defined minimum number of liturgies need -to be on. +The minimum skill rating the defined minimum number of liturgies need to be on. - **Type:** Integer - **Minimum:** `1` @@ -819,18 +810,13 @@ Only include entries of the specified groups. #### `specific?` -Only include (`Intersection`) or exclude (`Difference`) specific -skills. +Only include (`Intersection`) or exclude (`Difference`) specific skills. - **Type:** SpecificFromSkillSelectOptionCategoryCategory<SkillReference> #### `skill_applications?` -Registers new applications, which get enabled once this entry is -activated with its respective select option. It specifies an -entry-unique identifier, the skill it belongs to is derived from the -select option automatically. A translation can be left out if its -name equals the name of the origin entry. +Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. - **Type:** List - **Items:** SkillSelectOptionCategoryCategory/skill_applications[] @@ -838,11 +824,7 @@ name equals the name of the origin entry. #### `skill_uses?` -Registers uses, which get enabled once this entry is activated with -its respective select option. It specifies an entry-unique -identifier, the skill it belongs to is derived from the select option -automatically. A translation can be left out if its name equals the -name of the origin entry. +Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. - **Type:** List - **Items:** SkillSelectOptionCategoryCategory/skill_uses[] @@ -998,8 +980,7 @@ Key | Description | Details #### `name` -The name of the application or use if different from the activatable -entry's name. +The name of the application or use if different from the activatable entry's name. - **Type:** String - **Minimum Length:** `1` @@ -1279,8 +1260,7 @@ A mapping of skill identifiers to their specific AP values. #### `default` -The default value of an entry. Used as a fallback if no value is -found in `list`. +The default value of an entry. Used as a fallback if no value is found in `list`. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/_ActivatableSkillCastingTime.md b/docs/reference/_ActivatableSkillCastingTime.md index c862ca86..f39e0bf3 100644 --- a/docs/reference/_ActivatableSkillCastingTime.md +++ b/docs/reference/_ActivatableSkillCastingTime.md @@ -67,9 +67,7 @@ The initial skill modification identifier/level. ### `CastingTimeIncludingLovemaking` -The casting time may have two different values: One for use in “normal” time, -i. e. actions, combat rounds and others, and one for use during lovemaking, -which is a rule set from Aventurian Intimacy. +The casting time may have two different values: One for use in “normal” time, i. e. actions, combat rounds and others, and one for use during lovemaking, which is a rule set from Aventurian Intimacy. There must always be at least one casting time value. @@ -89,9 +87,7 @@ The default casting time definition. #### `during_lovemaking?` -The casting time during lovemaking. In Aventurian Intimacy, you may only -use an activatable skill during lovemaking if it has a casting time used -during lovemaking. +The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. - **Type:** CastingTimeDuringLovemaking @@ -99,9 +95,7 @@ during lovemaking. ### `CastingTimeDuringLovemaking` -The casting time during lovemaking. In Aventurian Intimacy, you may only use -an activatable skill during lovemaking if it has a casting time used during -lovemaking. +The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. - **Type:** Object diff --git a/docs/reference/_ActivatableSkillCost.md b/docs/reference/_ActivatableSkillCost.md index 4125dcf3..5a05e301 100644 --- a/docs/reference/_ActivatableSkillCost.md +++ b/docs/reference/_ActivatableSkillCost.md @@ -246,8 +246,7 @@ The part of the cost value that has to be spent permanently. #### `per?` -The cost have to be per a specific countable entity, e.g. `8 KP per -person`. +The cost have to be per a specific countable entity, e.g. `8 KP per person`. - **Type:** NonModifiableOneTimeCostPerCountable @@ -271,8 +270,7 @@ Key | Description | Details #### `minimum_total?` -If defined, the minimum total AE that have to be spent casting the -skill. +If defined, the minimum total AE that have to be spent casting the skill. - **Type:** Number @@ -351,8 +349,7 @@ A description of where the cost come from. ### `CostMap` -A content that is `2/4/8/16 AE for an item the size of a -cup/chest/door/castle gate` may be respresented as the following map: +A content that is `2/4/8/16 AE for an item the size of a cup/chest/door/castle gate` may be respresented as the following map: ```yaml options: @@ -367,8 +364,7 @@ options: for_append: "an item the size of a" ``` -This will generate the exact same string as seen above – given it is set -for a spellwork and thus `AE` is used. +This will generate the exact same string as seen above – given it is set for a spellwork and thus `AE` is used. - **Type:** Object @@ -448,8 +444,7 @@ The description of the option for cost string generation. #### `label_standalone?` -The description of the option if used standalone. Only used if -different from `label`. +The description of the option if used standalone. Only used if different from `label`. - **Type:** NonEmptyString @@ -479,10 +474,7 @@ Place a string after the grouped map option labels. #### `replacement?` -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. +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. - **Type:** NonEmptyString @@ -584,8 +576,7 @@ The AE cost value. #### `per?` -The cost have to be per a specific countable entity, e.g. `8 KP per -person per 5 minutes`. +The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`. - **Type:** NonModifiableSustainedCostPerCountable @@ -608,8 +599,7 @@ Key | Description | Details #### `minimum_total?` -If defined, the minimum total AE that have to be spent casting the -skill. +If defined, the minimum total AE that have to be spent casting the skill. - **Type:** Number diff --git a/docs/reference/_ActivatableSkillEffect.md b/docs/reference/_ActivatableSkillEffect.md index 05621bcf..ef3d5916 100644 --- a/docs/reference/_ActivatableSkillEffect.md +++ b/docs/reference/_ActivatableSkillEffect.md @@ -4,9 +4,7 @@ ### `ActivatableSkillEffect` -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. +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. - **Type:** Union - **Cases:** ActivatableSkillEffect'Plain | ActivatableSkillEffect'ForEachQualityLevel | ActivatableSkillEffect'ForEachTwoQualityLevels @@ -98,23 +96,20 @@ Key | Description | Details #### `text_before` -The effect description before the list of effects for each quality -level. +The effect description before the list of effects for each quality level. - **Type:** NonEmptyMarkdown #### `quality_levels` -The list of effects for each quality level. The first element -represents QL 1, the second element QL 2, and so on. +The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. - **Type:** List - **Items:** ActivatableSkillEffectForEachQualityLevel/quality_levels[] #### `text_after?` -The effect description after the list of effects for each quality -level. +The effect description after the list of effects for each quality level. - **Type:** NonEmptyMarkdown @@ -138,24 +133,20 @@ Key | Description | Details #### `text_before` -The effect description before the list of effects for each quality -level. +The effect description before the list of effects for each quality level. - **Type:** NonEmptyMarkdown #### `quality_levels` -The list of effects for each two quality levels. The first element -represents QL 1–2, the second element QL 3–4 and the third element QL -5–6. +The list of effects for each two quality levels. The first element represents QL 1–2, the second element QL 3–4 and the third element QL 5–6. - **Type:** List - **Items:** ActivatableSkillEffectForEachTwoQualityLevels/quality_levels[] #### `text_after?` -The effect description after the list of effects for each quality -level. +The effect description after the list of effects for each quality level. - **Type:** NonEmptyMarkdown diff --git a/docs/reference/_ActivatableSkillRange.md b/docs/reference/_ActivatableSkillRange.md index 4fb6a87c..d61d5bee 100644 --- a/docs/reference/_ActivatableSkillRange.md +++ b/docs/reference/_ActivatableSkillRange.md @@ -315,16 +315,13 @@ Key | Description | Details #### `note?` -A note, appended to the generated string in parenthesis. If the -generated is modified using `replacement`, the note is appended to -the modifier string. +A note, appended to the generated string in parenthesis. If the generated is modified using `replacement`, the note is appended to the modifier string. - **Type:** ResponsiveTextOptional #### `replacement?` -A replacement string. If `note` is provided, it is appended to the -replaced string. +A replacement string. If `note` is provided, it is appended to the replaced string. - **Type:** ResponsiveTextReplace diff --git a/docs/reference/_ActivatableSkillTargetCategory.md b/docs/reference/_ActivatableSkillTargetCategory.md index 210dd40f..5d5f18a5 100644 --- a/docs/reference/_ActivatableSkillTargetCategory.md +++ b/docs/reference/_ActivatableSkillTargetCategory.md @@ -6,8 +6,7 @@ The target category – the kind of creature or object – the skill affects. -If no target categories are given, the skill applies to all target -categories. +If no target categories are given, the skill applies to all target categories. - **Type:** List - **Items:** AffectedTargetCategories[] diff --git a/docs/reference/_Blessed.md b/docs/reference/_Blessed.md index 27654d6b..33b39ad7 100644 --- a/docs/reference/_Blessed.md +++ b/docs/reference/_Blessed.md @@ -64,9 +64,7 @@ The blessed tradition. #### `aspects?` -The aspect(s) from the tradition the ceremony belongs to. Note that not -all traditions have aspects. Traditions with aspects must have at least one -aspect specified. +The aspect(s) from the tradition the ceremony belongs to. Note that not all traditions have aspects. Traditions with aspects must have at least one aspect specified. - **Type:** List - **Items:** SkillTraditionWithAspects/aspects[] diff --git a/docs/reference/_DiseasePoison.md b/docs/reference/_DiseasePoison.md index dca3af48..8c56e7b5 100644 --- a/docs/reference/_DiseasePoison.md +++ b/docs/reference/_DiseasePoison.md @@ -6,9 +6,7 @@ This file defines some shared types for different diseases and poisons. ### `Resistance` -Depending on the disease, apply Spirit or Toughness as a penalty to the -disease roll. It may also happen that the lower of both is applied as a -penalty. +Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. - **Type:** Union - **Cases:** Resistance'0 | Resistance'1 | Resistance'2 @@ -35,9 +33,7 @@ penalty. ### `Cause` -What causes the disease? The GM rolls 1D20 to see if a character gets -infected. If the infection check succeeds, the GM makes a disease check to -determine the severity of the infection. +What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. - **Type:** Object @@ -82,9 +78,7 @@ The name of the cause. #### `chance?` -The chance to get infected by this cause. If present for this -language, this overrides the universal `chance` field; they cannot be -used at the same time. +The chance to get infected by this cause. If present for this language, this overrides the universal `chance` field; they cannot be used at the same time. - **Type:** NonEmptyString @@ -141,15 +135,13 @@ After infection, how much time passes before symptoms appear? #### `damage` -The damage caused by the disease. If the disease check fails, apply the -lessened effects. +The damage caused by the disease. If the disease check fails, apply the lessened effects. - **Type:** Reduceable<NonEmptyMarkdown> #### `duration` -The duration of the disease. If the disease check fails, use the -lessened duration. +The duration of the disease. If the disease check fails, use the lessened duration. - **Type:** Reduceable<NonEmptyMarkdown> @@ -185,11 +177,9 @@ Known remedies for the disease. ### `Reduceable` -An effect or other parameter that may be reduced by a failed disease check -for lessening or a degraded poison. +An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison. -This streamlines the wording for diseases and poison by using a unified -wording for *lessened* (disease) and *degraded* (poison). +This streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison). - **Type:** Object @@ -206,7 +196,6 @@ The default value. In the source, it's the text before the slash. #### `reduced?` -The reduced value. In the source, it's the text after the slash. Some -entries may not have a reduced value. +The reduced value. In the source, it's the text after the slash. Some entries may not have a reduced value. - **Type:** Content diff --git a/docs/reference/_Enhancements.md b/docs/reference/_Enhancements.md index 63c3800b..1d5686ff 100644 --- a/docs/reference/_Enhancements.md +++ b/docs/reference/_Enhancements.md @@ -49,8 +49,7 @@ The skill rating required to learn this enhancement. #### `adventure_points_modifier` -The value to multiply with the numeric representation of the associated -skill's improvement cost to form the final AP cost of this enhancement. +The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/_I18n.md b/docs/reference/_I18n.md index a5187d05..fdb0f17c 100644 --- a/docs/reference/_I18n.md +++ b/docs/reference/_I18n.md @@ -4,14 +4,7 @@ ### `PluralizationCategories` -The item can be present in multiple pluralization categories; this object -unifies handling of them. Not all of the options must be present, however, -every possible category for that language should be defined. This means, that -different languages may have a different amount of properties defined here. -More information on pluralization and the Intl.PluralRules API on -https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, -https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and -http://cldr.unicode.org/index/cldr-spec/plural-rules. +The item can be present in multiple pluralization categories; this object unifies handling of them. Not all of the options must be present, however, every possible category for that language should be defined. This means, that different languages may have a different amount of properties defined here. More information on pluralization and the Intl.PluralRules API on https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and http://cldr.unicode.org/index/cldr-spec/plural-rules. From the third link: diff --git a/docs/reference/_Influence.md b/docs/reference/_Influence.md index bf97a2d5..dc7ed596 100644 --- a/docs/reference/_Influence.md +++ b/docs/reference/_Influence.md @@ -54,8 +54,7 @@ The influence name. #### `effects` -The effects of the influence. They should be sorted like they are in -the book. +The effects of the influence. They should be sorted like they are in the book. - **Type:** List - **Items:** InfluenceTranslation/effects[] @@ -84,8 +83,7 @@ Key | Description | Details #### `label?` -An optional label that is displayed and placed before the actual -text. +An optional label that is displayed and placed before the actual text. - **Type:** NonEmptyString diff --git a/docs/reference/_Prerequisite.md b/docs/reference/_Prerequisite.md index 509576a1..0c3c5d60 100644 --- a/docs/reference/_Prerequisite.md +++ b/docs/reference/_Prerequisite.md @@ -4,9 +4,7 @@ ### `PrerequisiteGroup` -A prerequisite group has no influence on validation logic. It serves as a -single unit for displaying purposes, where the source uses a prerequisites -item that cannot be represented as a single prerequisite. +A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite. - **Type:** Object diff --git a/docs/reference/_ResponsiveText.md b/docs/reference/_ResponsiveText.md index c058ef25..7164b4f2 100644 --- a/docs/reference/_ResponsiveText.md +++ b/docs/reference/_ResponsiveText.md @@ -4,8 +4,7 @@ ### `ResponsiveText` -A text from the source that can be also displayed in small areas using a -compressed version. +A text from the source that can be also displayed in small areas using a compressed version. - **Type:** Object @@ -30,9 +29,7 @@ A compressed text for use in small areas (e.g. on character sheet). ### `ResponsiveTextReplace` -A text from the source that can be also displayed in small areas using a -compressed version. It is used as a replacement for a generated text while -the generated text is still provided and should be used. +A text from the source that can be also displayed in small areas using a compressed version. It is used as a replacement for a generated text while the generated text is still provided and should be used. - **Type:** Object @@ -43,9 +40,7 @@ Key | Description | Details #### `full` -The full replacement string. It must contain `$1`, which is going to be -replaced with the generated string, so additional information can be -provided without duplicating concrete numeric values. +The full replacement string. It must contain `$1`, which is going to be replaced with the generated string, so additional information can be provided without duplicating concrete numeric values. - **Type:** String - **Minimum Length:** `1` @@ -53,10 +48,7 @@ provided without duplicating concrete numeric values. #### `compressed` -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 string, so additional information can be provided without -duplicating concrete numeric values. +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 string, so additional information can be provided without duplicating concrete numeric values. - **Type:** String - **Minimum Length:** `1` @@ -66,8 +58,7 @@ duplicating concrete numeric values. ### `ResponsiveTextOptional` -A text from the source that can be also displayed in small areas using a -compressed version, if available. +A text from the source that can be also displayed in small areas using a compressed version, if available. - **Type:** Object @@ -84,7 +75,6 @@ The full text from the source. #### `compressed?` -A compressed text for use in small areas (e.g. on character sheet). If this -is not present, it should not appear in those areas. +A compressed text for use in small areas (e.g. on character sheet). If this is not present, it should not appear in those areas. - **Type:** NonEmptyString diff --git a/docs/reference/_Spellwork.md b/docs/reference/_Spellwork.md index 82061d85..93784b78 100644 --- a/docs/reference/_Spellwork.md +++ b/docs/reference/_Spellwork.md @@ -4,9 +4,7 @@ ### `Traditions` -The tradition(s) the ritual is available for. It may be *generally* -available to all traditions or it may be only familiar in specific -traditions. +The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. - **Type:** Union - **Cases:** Traditions'General | Traditions'Specific diff --git a/docs/reference/equipment/EquipmentPackage.md b/docs/reference/equipment/EquipmentPackage.md index a7505247..ba7a7ed8 100644 --- a/docs/reference/equipment/EquipmentPackage.md +++ b/docs/reference/equipment/EquipmentPackage.md @@ -22,9 +22,7 @@ The equipment package's identifier. An unique, increasing integer. #### `items` -All items in the package. You have to provide the item (template) -identifier and you can optionally provide the number of how often an item -is included in the package. +All items in the package. You have to provide the item (template) identifier and you can optionally provide the number of how often an item is included in the package. - **Type:** List - **Items:** EquipmentPackage/items[] diff --git a/docs/reference/equipment/item/Armor.md b/docs/reference/equipment/item/Armor.md index a51bda42..a8dd2b11 100644 --- a/docs/reference/equipment/item/Armor.md +++ b/docs/reference/equipment/item/Armor.md @@ -370,8 +370,7 @@ Key | Description | Details #### `combination_possibilities?` -In some cases, multiple armors for the same hit zone can be combined. -They're listed at the item that can be combined with others. +In some cases, multiple armors for the same hit zone can be combined. They're listed at the item that can be combined with others. - **Type:** HeadHitZoneCombinationPossibilities @@ -396,8 +395,7 @@ A list of armors that can be combined with this armor. #### `protection?` -The PRO value that is added to the PRO value of the other armor instead -of adding the normale PRO value. +The PRO value that is added to the PRO value of the other armor instead of adding the normale PRO value. - **Type:** Integer - **Minimum:** `0` diff --git a/docs/reference/equipment/item/BandageOrRemedy.md b/docs/reference/equipment/item/BandageOrRemedy.md index 1f4b8259..71eaa41e 100644 --- a/docs/reference/equipment/item/BandageOrRemedy.md +++ b/docs/reference/equipment/item/BandageOrRemedy.md @@ -36,15 +36,13 @@ The complexity of crafting the item. #### `structure_points?` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse diff --git a/docs/reference/equipment/item/Book.md b/docs/reference/equipment/item/Book.md index a98eb75d..c3ff314b 100644 --- a/docs/reference/equipment/item/Book.md +++ b/docs/reference/equipment/item/Book.md @@ -35,8 +35,7 @@ The complexity of crafting the item. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints diff --git a/docs/reference/equipment/item/CeremonialItem.md b/docs/reference/equipment/item/CeremonialItem.md index 2e14034c..c4a3bd51 100644 --- a/docs/reference/equipment/item/CeremonialItem.md +++ b/docs/reference/equipment/item/CeremonialItem.md @@ -37,8 +37,7 @@ The complexity of crafting the item. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints @@ -50,8 +49,7 @@ The deity associated with the equipment item. #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse diff --git a/docs/reference/equipment/item/Elixir.md b/docs/reference/equipment/item/Elixir.md index ae50915e..9cab78a6 100644 --- a/docs/reference/equipment/item/Elixir.md +++ b/docs/reference/equipment/item/Elixir.md @@ -37,8 +37,7 @@ The laboratory level needed to brew the elixir. #### `brewing_difficulty` -The brewing difficulty, which represents the challenge of creating an -elixir. +The brewing difficulty, which represents the challenge of creating an elixir. - **Type:** Integer @@ -104,8 +103,7 @@ Prerequsites for the brewing process, if any. #### `quality_levels` -The list of effects for each quality level. The first element -represents QL 1, the second element QL 2, and so on. +The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. - **Type:** List - **Items:** ElixirTranslation/quality_levels[] diff --git a/docs/reference/equipment/item/EquipmentOfBlessedOnes.md b/docs/reference/equipment/item/EquipmentOfBlessedOnes.md index eb3f524b..4db6502c 100644 --- a/docs/reference/equipment/item/EquipmentOfBlessedOnes.md +++ b/docs/reference/equipment/item/EquipmentOfBlessedOnes.md @@ -22,8 +22,7 @@ The cost in silverthalers. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints diff --git a/docs/reference/equipment/item/IlluminationLightSource.md b/docs/reference/equipment/item/IlluminationLightSource.md index 4fb6d405..fa2708fc 100644 --- a/docs/reference/equipment/item/IlluminationLightSource.md +++ b/docs/reference/equipment/item/IlluminationLightSource.md @@ -37,22 +37,19 @@ The complexity of crafting the item. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints #### `burning_time` -The burning time is the time how long the light source can be lit. After -that time you have to use a new light source. +The burning time is the time how long the light source can be lit. After that time you have to use a new light source. - **Type:** BurningTime #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse @@ -145,11 +142,4 @@ The time unit. ### `LimitedBurningTimeUnit` -- **Type:** Union -- **Cases:** LimitedBurningTimeUnit'0 - ---- - -### `LimitedBurningTimeUnit'0` - - **Constant:** `"Hours"` diff --git a/docs/reference/equipment/item/Jewelry.md b/docs/reference/equipment/item/Jewelry.md index bd3ba6b3..edf07ee1 100644 --- a/docs/reference/equipment/item/Jewelry.md +++ b/docs/reference/equipment/item/Jewelry.md @@ -35,8 +35,7 @@ The complexity of crafting the item. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints diff --git a/docs/reference/equipment/item/LuxuryGood.md b/docs/reference/equipment/item/LuxuryGood.md index 85f8305e..2bb612fd 100644 --- a/docs/reference/equipment/item/LuxuryGood.md +++ b/docs/reference/equipment/item/LuxuryGood.md @@ -36,15 +36,13 @@ The complexity of crafting the item. #### `structure_points?` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse diff --git a/docs/reference/equipment/item/MusicalInstrument.md b/docs/reference/equipment/item/MusicalInstrument.md index 9681761a..ded9cccb 100644 --- a/docs/reference/equipment/item/MusicalInstrument.md +++ b/docs/reference/equipment/item/MusicalInstrument.md @@ -35,8 +35,7 @@ The complexity of crafting the item. #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse diff --git a/docs/reference/equipment/item/Poison.md b/docs/reference/equipment/item/Poison.md index 182ee5cf..a8ca9f46 100644 --- a/docs/reference/equipment/item/Poison.md +++ b/docs/reference/equipment/item/Poison.md @@ -546,8 +546,7 @@ The laboratory level needed to brew the elixir. #### `brewing_difficulty` -The brewing difficulty, which represents the challenge of creating an -elixir. +The brewing difficulty, which represents the challenge of creating an elixir. - **Type:** Integer @@ -752,13 +751,6 @@ Key | Description | Details ### `QualityLevelDemonicPoisonLevelSource` -- **Type:** Union -- **Cases:** QualityLevelDemonicPoisonLevelSource'0 - ---- - -### `QualityLevelDemonicPoisonLevelSource'0` - - **Constant:** `"Spellwork"` --- @@ -810,16 +802,13 @@ Key | Description | Details #### `legality` -Whether the use of the intoxicant is legal or not, usually from the -perspective of most middle-Aventurian an northern-Aventurian nations. +Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. - **Type:** IntoxicantLegality #### `addiction?` -The chance of getting addicted after an ingestion in addition to the -maximum interval at which it, while addicted, must be ingested to not -suffer from withdrawal symptoms. +The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. - **Type:** IntoxicantAddiction @@ -834,8 +823,7 @@ All translations for the entry, identified by IETF language tag ### `IntoxicantLegality` -Whether the use of the intoxicant is legal or not, usually from the -perspective of most middle-Aventurian an northern-Aventurian nations. +Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. - **Type:** Object @@ -851,9 +839,7 @@ Key | Description | Details ### `IntoxicantAddiction` -The chance of getting addicted after an ingestion in addition to the maximum -interval at which it, while addicted, must be ingested to not suffer from -withdrawal symptoms. +The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. - **Type:** Object @@ -870,8 +856,7 @@ The chance of getting addicted after an ingestion. #### `interval` -The maximum interval at which it, while addicted, must be ingested to not -suffer from withdrawal symptoms. +The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. - **Type:** IntoxicantAddictionInterval @@ -879,8 +864,7 @@ suffer from withdrawal symptoms. ### `IntoxicantAddictionInterval` -The maximum interval at which it, while addicted, must be ingested to not -suffer from withdrawal symptoms. +The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. - **Type:** Union - **Cases:** IntoxicantAddictionInterval'Constant | IntoxicantAddictionInterval'DiceBased @@ -976,15 +960,13 @@ How to ingest the intoxicant. #### `side_effect?` -The intoxicants side effects that always happen, no matter whether the -intoxicant has the default or the reduced effect. +The intoxicants side effects that always happen, no matter whether the intoxicant has the default or the reduced effect. - **Type:** NonEmptyMarkdown #### `overdose` -What happens if the intoxicant has been overdosed, that is, it has been -ingested another time within the duration. +What happens if the intoxicant has been overdosed, that is, it has been ingested another time within the duration. - **Type:** NonEmptyMarkdown diff --git a/docs/reference/equipment/item/ToolOfTheTrade.md b/docs/reference/equipment/item/ToolOfTheTrade.md index 7094873f..8b4bfeb9 100644 --- a/docs/reference/equipment/item/ToolOfTheTrade.md +++ b/docs/reference/equipment/item/ToolOfTheTrade.md @@ -36,8 +36,7 @@ The complexity of crafting the item. #### `structure_points?` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints diff --git a/docs/reference/equipment/item/Weapon.md b/docs/reference/equipment/item/Weapon.md index ef3bea86..b1672d8f 100644 --- a/docs/reference/equipment/item/Weapon.md +++ b/docs/reference/equipment/item/Weapon.md @@ -39,15 +39,13 @@ The complexity of crafting the item. #### `structure_points?` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints #### `uses` -A list of stat blocks for each combat technique this weapon can be used -with. +A list of stat blocks for each combat technique this weapon can be used with. - **Type:** List - **Items:** Weapon/uses[] @@ -55,22 +53,19 @@ with. #### `sanctified_by?` -If the weapon is sanctified by a god and thus restricted to it's Blessed -Ones. +If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. - **Type:** SanctifiedBy #### `restricted_to_cultures?` -Define if during character creation this weapon can only be bought by -characters of a specific race or culture. +Define if during character creation this weapon can only be bought by characters of a specific race or culture. - **Type:** RestrictedToCultures #### `restricted_to_traditions?` -Define if during character creation this weapon can only be bought by -characters of specific magical or blessed traditions. +Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. - **Type:** List - **Items:** Weapon/restricted_to_traditions[] @@ -170,8 +165,7 @@ Key | Description | Details #### `uses` -A list of stat blocks for each combat technique this weapon can be used -with. +A list of stat blocks for each combat technique this weapon can be used with. - **Type:** List - **Items:** SecondaryWeapon/uses[] @@ -179,22 +173,19 @@ with. #### `sanctified_by?` -If the weapon is sanctified by a god and thus restricted to it's Blessed -Ones. +If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. - **Type:** SanctifiedBy #### `restricted_to_cultures?` -Define if during character creation this weapon can only be bought by -characters of a specific race or culture. +Define if during character creation this weapon can only be bought by characters of a specific race or culture. - **Type:** RestrictedToCultures #### `restricted_to_traditions?` -Define if during character creation this weapon can only be bought by -characters of specific magical or blessed traditions. +Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. - **Type:** List - **Items:** SecondaryWeapon/restricted_to_traditions[] @@ -313,8 +304,7 @@ Key | Description | Details ### `SanctifiedBy` -If the weapon is sanctified by a god and thus restricted to it's Blessed -Ones. +If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. - **Type:** List - **Items:** SanctifiedBy[] @@ -330,8 +320,7 @@ Ones. ### `RestrictedToCultures` -Define if during character creation this weapon can only be bought by -characters of a specific race or culture. +Define if during character creation this weapon can only be bought by characters of a specific race or culture. - **Type:** Union - **Cases:** RestrictedToCultures'CulturesOfRace | RestrictedToCultures'Cultures diff --git a/docs/reference/equipment/item/_Item.md b/docs/reference/equipment/item/_Item.md index d3bb7785..a6ef81c8 100644 --- a/docs/reference/equipment/item/_Item.md +++ b/docs/reference/equipment/item/_Item.md @@ -36,15 +36,13 @@ The complexity of crafting the item. #### `structure_points` -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** StructurePoints #### `combat_use?` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** CombatUse @@ -62,8 +60,7 @@ All translations for the entry, identified by IETF language tag (BCP47). ### `CombatUse` -The item can also be used either as an improvised weapon or as an armor, -although this is not the primary use case of the item. +The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. - **Type:** Union - **Cases:** CombatUse'Weapon | CombatUse'Armor @@ -152,8 +149,7 @@ Special rules text. ### Structure Points (`StructurePoints`) -The structure points of the item. Use an array if the item consists of -multiple components that have individual structure points. +The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. - **Type:** List - **Items:** StructurePoints[] diff --git a/docs/reference/equipment/item/_MeleeWeapon.md b/docs/reference/equipment/item/_MeleeWeapon.md index 3d4fac7a..3cf6ba85 100644 --- a/docs/reference/equipment/item/_MeleeWeapon.md +++ b/docs/reference/equipment/item/_MeleeWeapon.md @@ -22,8 +22,7 @@ The PA modifier. ### `MeleeDamage` -The damage of a weapon consists of a random part using dice and an optional -flat part. +The damage of a weapon consists of a random part using dice and an optional flat part. - **Type:** Object @@ -168,8 +167,7 @@ The combat techniques and dependent values. #### `damage` -The damage of a weapon consists of a random part using dice and an optional -flat part. +The damage of a weapon consists of a random part using dice and an optional flat part. - **Type:** MeleeDamage diff --git a/docs/reference/equipment/item/_RangedWeapon.md b/docs/reference/equipment/item/_RangedWeapon.md index 9d21e298..e74cbcd1 100644 --- a/docs/reference/equipment/item/_RangedWeapon.md +++ b/docs/reference/equipment/item/_RangedWeapon.md @@ -6,10 +6,7 @@ Auxiliary types for ranged weapons. ### `RangedDamage` -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. +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. - **Type:** Union - **Cases:** RangedDamage'Default | RangedDamage'NotApplicable | RangedDamage'Special @@ -87,8 +84,7 @@ Key | Description | Details ### `DefaultRangedDamage` -The damage of a weapon consists of a random part using dice and an optional -flat part. +The damage of a weapon consists of a random part using dice and an optional flat part. - **Type:** Object @@ -134,8 +130,7 @@ The combat techniques and dependent values. #### `damage` -The damage of a weapon consists of a random part using dice and an optional -flat part. +The damage of a weapon consists of a random part using dice and an optional flat part. - **Type:** RangedDamage diff --git a/docs/reference/equipment/item/_Weapon.md b/docs/reference/equipment/item/_Weapon.md index 26665c8f..e3c6cf62 100644 --- a/docs/reference/equipment/item/_Weapon.md +++ b/docs/reference/equipment/item/_Weapon.md @@ -4,16 +4,7 @@ ### `PrimaryAttributeDamageThreshold` -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). +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). - **Type:** Union - **Cases:** PrimaryAttributeDamageThreshold'Default | PrimaryAttributeDamageThreshold'List @@ -68,8 +59,7 @@ Key | Description | Details #### `threshold` -The attribute value representing the damage threshold for the primary -attribute of the item's combat technique. +The attribute value representing the damage threshold for the primary attribute of the item's combat technique. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/equipment/item/sub/ArmorType.md b/docs/reference/equipment/item/sub/ArmorType.md index 95555a27..62c6df19 100644 --- a/docs/reference/equipment/item/sub/ArmorType.md +++ b/docs/reference/equipment/item/sub/ArmorType.md @@ -21,9 +21,7 @@ The armor type's identifier. An unique, increasing integer. #### `sturdiness_rating?` -An armor type can have a *sturdiness rating*. The higher the rating, the -more durable the armor. Rolling higher than this rating during a sturdiness -check means the armor receives one level of the new condition *Wear*. +An armor type can have a *sturdiness rating*. The higher the rating, the more durable the armor. Rolling higher than this rating during a sturdiness check means the armor receives one level of the new condition *Wear*. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/magicalActions/AnimistPower.md b/docs/reference/magicalActions/AnimistPower.md index 1bf5d440..afeca4ce 100644 --- a/docs/reference/magicalActions/AnimistPower.md +++ b/docs/reference/magicalActions/AnimistPower.md @@ -46,11 +46,9 @@ The associated property. #### `tribe_tradition` -The tribe traditions the animist power is available to. It may be available -to all or only specific tribes. +The tribe traditions the animist power is available to. It may be available to all or only specific tribes. -If no tribe tradition is given, the animist power is generally available to -all tribe traditions. +If no tribe tradition is given, the animist power is generally available to all tribe traditions. - **Type:** List - **Items:** AnimistPower/tribe_tradition[] @@ -58,8 +56,7 @@ all tribe traditions. #### `improvement_cost` -States which column is used to improve the skill. It is a fixed value or -depends on the primary patron. +States which column is used to improve the skill. It is a fixed value or depends on the primary patron. - **Type:** AnimistPowerImprovementCost @@ -69,11 +66,7 @@ depends on the primary patron. #### `levels?` -The animist power can have multiple levels. Each level is skilled -separately. A previous level must be on at least 10 so that the next higher -level can be activated and skilled. A higher level cannot be skilled higher -than a lower level. Each level also adds an effect text to the text of the -first level. +The animist power can have multiple levels. Each level is skilled separately. A previous level must be on at least 10 so that the next higher level can be activated and skilled. A higher level cannot be skilled higher than a lower level. Each level also adds an effect text to the text of the first level. - **Type:** List - **Items:** AnimistPower/levels[] @@ -133,9 +126,7 @@ purposes. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -264,8 +255,7 @@ Key | Description | Details #### `cost` -The AE cost value, either a flat value or defined dynamically by the -primary patron. +The AE cost value, either a flat value or defined dynamically by the primary patron. - **Type:** OneTimeAnimistPowerCost @@ -449,8 +439,7 @@ Key | Description | Details #### `cost` -The AE cost value, either a flat value or defined dynamically by the -primary patron. +The AE cost value, either a flat value or defined dynamically by the primary patron. - **Type:** SustainedAnimistPowerCost diff --git a/docs/reference/magicalActions/Curse.md b/docs/reference/magicalActions/Curse.md index 6e3c918a..bd757837 100644 --- a/docs/reference/magicalActions/Curse.md +++ b/docs/reference/magicalActions/Curse.md @@ -79,9 +79,7 @@ The name of the curse. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -205,8 +203,7 @@ Key | Description | Details #### `per?` -The cost have to be per a specific countable entity, e.g. `8 KP -per person`. +The cost have to be per a specific countable entity, e.g. `8 KP per person`. - **Type:** ResponsiveText diff --git a/docs/reference/magicalActions/DominationRitual.md b/docs/reference/magicalActions/DominationRitual.md index 5b6b24ad..a001b10d 100644 --- a/docs/reference/magicalActions/DominationRitual.md +++ b/docs/reference/magicalActions/DominationRitual.md @@ -79,9 +79,7 @@ The name of the domination ritual. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/magicalActions/ElvenMagicalSong.md b/docs/reference/magicalActions/ElvenMagicalSong.md index e0b61364..c30d92f4 100644 --- a/docs/reference/magicalActions/ElvenMagicalSong.md +++ b/docs/reference/magicalActions/ElvenMagicalSong.md @@ -104,9 +104,7 @@ The name of the elven magical song. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -226,7 +224,6 @@ Key | Description | Details #### `per` -The cost have to be per a specific countable entity, e.g. `8 AE -per person`. +The cost have to be per a specific countable entity, e.g. `8 AE per person`. - **Type:** ResponsiveText diff --git a/docs/reference/magicalActions/GeodeRitual.md b/docs/reference/magicalActions/GeodeRitual.md index 4db724ed..b2ca10ce 100644 --- a/docs/reference/magicalActions/GeodeRitual.md +++ b/docs/reference/magicalActions/GeodeRitual.md @@ -87,9 +87,7 @@ The name of the geode ritual. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/magicalActions/JesterTrick.md b/docs/reference/magicalActions/JesterTrick.md index aaf8ce2e..6234b404 100644 --- a/docs/reference/magicalActions/JesterTrick.md +++ b/docs/reference/magicalActions/JesterTrick.md @@ -96,9 +96,7 @@ The name of the jester trick. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/magicalActions/MagicalDance.md b/docs/reference/magicalActions/MagicalDance.md index 99bf4c9b..7bf3be06 100644 --- a/docs/reference/magicalActions/MagicalDance.md +++ b/docs/reference/magicalActions/MagicalDance.md @@ -44,8 +44,7 @@ The associated property. #### `music_tradition` -The music tradition(s) the magical dance is available for. This also -defines the different names in each music tradition. +The music tradition(s) the magical dance is available for. This also defines the different names in each music tradition. - **Type:** List - **Items:** MagicalDance/music_tradition[] @@ -95,9 +94,7 @@ The name of the magical dance. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -216,8 +213,7 @@ Key | Description | Details #### `modifier?` -Specified if the indefinite description's result value is to be -modified by a certain number. +Specified if the indefinite description's result value is to be modified by a certain number. - **Type:** CheckResultBasedModifier diff --git a/docs/reference/magicalActions/MagicalMelody.md b/docs/reference/magicalActions/MagicalMelody.md index 68c45170..620f0d8a 100644 --- a/docs/reference/magicalActions/MagicalMelody.md +++ b/docs/reference/magicalActions/MagicalMelody.md @@ -40,8 +40,7 @@ In some cases, the target's Spirit or Toughness is applied as a penalty. #### `skill` -Arcane bards must make a *Singing (area of application)* or *Music (area of -application)* check for each magical melody. +Arcane bards must make a *Singing (area of application)* or *Music (area of application)* check for each magical melody. - **Type:** List - **Items:** MagicalMelody/skill[] @@ -63,8 +62,7 @@ The associated property. #### `music_tradition` -The music tradition(s) the magical melody is available for. This also -defines the different names in each music tradition. +The music tradition(s) the magical melody is available for. This also defines the different names in each music tradition. - **Type:** List - **Items:** MagicalMelody/music_tradition[] @@ -120,9 +118,7 @@ The name of the magical melody. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -233,8 +229,7 @@ Key | Description | Details #### `value` -The (temporary) AE cost value for the first targeted person. The AE -cost for each additional person is half this value. +The (temporary) AE cost value for the first targeted person. The AE cost for each additional person is half this value. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/magicalActions/MagicalRune.md b/docs/reference/magicalActions/MagicalRune.md index f672024c..c448fa4d 100644 --- a/docs/reference/magicalActions/MagicalRune.md +++ b/docs/reference/magicalActions/MagicalRune.md @@ -29,8 +29,7 @@ The magical rune's identifier. An unique, increasing integer. The options the magical rune has, if any. -If there are multiple options, the magical rune may be activated for each -option, that is, multiple times. +If there are multiple options, the magical rune may be activated for each option, that is, multiple times. - **Type:** List - **Items:** MagicalRune/options[] @@ -102,16 +101,13 @@ Key | Description | Details The name of the magical rune. -If the rune has an option, the option’s name will/should not be included in -the name as well as its surrounding parenthesis. It will/should be combined -on demand. +If the rune has an option, the option’s name will/should not be included in the name as well as its surrounding parenthesis. It will/should be combined on demand. - **Type:** NonEmptyString #### `name_in_library?` -The full name of the entry as stated in the sources. Only use when `name` -needs to be different from full name for text generation purposes. +The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. - **Type:** NonEmptyString @@ -123,9 +119,7 @@ The native name of the magical rune. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect @@ -497,8 +491,7 @@ Key | Description | Details #### `per` -The crafting time has to be per a specific countable entity, e.g. `8 -action per person`. +The crafting time has to be per a specific countable entity, e.g. `8 action per person`. - **Type:** ResponsiveText @@ -706,8 +699,7 @@ Key | Description | Details The name of the option. -The surrounding parenthesis will/should not be included, they will/should -be generated. +The surrounding parenthesis will/should not be included, they will/should be generated. - **Type:** NonEmptyString diff --git a/docs/reference/magicalActions/ZibiljaRitual.md b/docs/reference/magicalActions/ZibiljaRitual.md index fff1f4c8..ed1dec50 100644 --- a/docs/reference/magicalActions/ZibiljaRitual.md +++ b/docs/reference/magicalActions/ZibiljaRitual.md @@ -96,9 +96,7 @@ The name of the zibilja ritual. #### `effect` -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. +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. - **Type:** ActivatableSkillEffect diff --git a/docs/reference/magicalActions/_MusicTradition.md b/docs/reference/magicalActions/_MusicTradition.md index 739f2834..99cecac0 100644 --- a/docs/reference/magicalActions/_MusicTradition.md +++ b/docs/reference/magicalActions/_MusicTradition.md @@ -4,8 +4,7 @@ ### `MusicTraditionReference` -A reference to a music tradition with the music-tradition-specific name of -the entry +A reference to a music tradition with the music-tradition-specific name of the entry - **Type:** Object diff --git a/docs/reference/prerequisites/ConditionalPrerequisites.md b/docs/reference/prerequisites/ConditionalPrerequisites.md index bedf21e1..e9cecdb7 100644 --- a/docs/reference/prerequisites/ConditionalPrerequisites.md +++ b/docs/reference/prerequisites/ConditionalPrerequisites.md @@ -4,8 +4,7 @@ ### Preconditions (`when`) (`Preconditions`) -A list of preconditions for the prerequisite it is defined on, so that it -only takes effect if the prerequisites in this list are matched. +A list of preconditions for the prerequisite it is defined on, so that it only takes effect if the prerequisites in this list are matched. Usually appears at the `when` property of the parent prerequisite. diff --git a/docs/reference/prerequisites/DisplayOption.md b/docs/reference/prerequisites/DisplayOption.md index 4280e446..b5115d20 100644 --- a/docs/reference/prerequisites/DisplayOption.md +++ b/docs/reference/prerequisites/DisplayOption.md @@ -64,16 +64,9 @@ Key | Description | Details #### `sentence_type?` -If the replacement text is a sentence or sentence-like fragment, this -property ensures it is integrated into the prerequisite string correctly. +If the replacement text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. -A standalone sentence is connected to the previous prerequisite string with -a period and a period is also added at the end of the sentence -automatically, if it is not present. A connected sentence is connected to -the previous prerequisite string with a semicolon and a period is not added -to the end of the sentence. In this case, if there are prerequisites after -this one, they will be connected using a semicolon again, unless a -different punctuation mark is present at the end of the given text. +A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. - **Type:** SentenceType diff --git a/docs/reference/prerequisites/single/ActivatablePrerequisite.md b/docs/reference/prerequisites/single/ActivatablePrerequisite.md index 644eef77..b93ab25b 100644 --- a/docs/reference/prerequisites/single/ActivatablePrerequisite.md +++ b/docs/reference/prerequisites/single/ActivatablePrerequisite.md @@ -38,8 +38,7 @@ The required minimum level of the entry. #### `options?` -Required select options. Order is important. Typically, you only need the -first array index, though. +Required select options. Order is important. Typically, you only need the first array index, though. - **Type:** List - **Items:** ActivatablePrerequisite/options[] diff --git a/docs/reference/prerequisites/single/EnhancementPrerequisite.md b/docs/reference/prerequisites/single/EnhancementPrerequisite.md index da2129ad..398a57cc 100644 --- a/docs/reference/prerequisites/single/EnhancementPrerequisite.md +++ b/docs/reference/prerequisites/single/EnhancementPrerequisite.md @@ -4,9 +4,7 @@ ### External Enhancement Prerequisite (`ExternalEnhancementPrerequisite`) -Requires a specific enhancement from a skill. This should **not** be used -for enhancements themselves; they can only require enhancements from the same -skill they enhance. +Requires a specific enhancement from a skill. This should **not** be used for enhancements themselves; they can only require enhancements from the same skill they enhance. - **Type:** Object @@ -69,7 +67,6 @@ The enhancement's identifier. ### Internal Enhancement Prerequisite (`InternalEnhancementPrerequisite`) -Requires a specific enhancement from a skill. This can only be used by an -enhancement to require another enhancement from the same skill. +Requires a specific enhancement from a skill. This can only be used by an enhancement to require another enhancement from the same skill. - **Type:** EnhancementsReference diff --git a/docs/reference/prerequisites/single/RacePrerequisite.md b/docs/reference/prerequisites/single/RacePrerequisite.md index c26b4e95..7a07d416 100644 --- a/docs/reference/prerequisites/single/RacePrerequisite.md +++ b/docs/reference/prerequisites/single/RacePrerequisite.md @@ -4,9 +4,7 @@ ### Race Prerequisite (`RacePrerequisite`) -Requires a specific race or one of a specific set of races. You can also -provide an object to say whether the hero must meet one of the races or -if the entry does not allow one of the races. +Requires a specific race or one of a specific set of races. You can also provide an object to say whether the hero must meet one of the races or if the entry does not allow one of the races. - **Type:** Object diff --git a/docs/reference/prerequisites/single/RatedMinimumNumberPrerequisite.md b/docs/reference/prerequisites/single/RatedMinimumNumberPrerequisite.md index 55fe981a..abf36180 100644 --- a/docs/reference/prerequisites/single/RatedMinimumNumberPrerequisite.md +++ b/docs/reference/prerequisites/single/RatedMinimumNumberPrerequisite.md @@ -15,16 +15,14 @@ Key | Description | Details #### `number` -The minimum number of skills that need to be on the defined minimum skill -rating. +The minimum number of skills that need to be on the defined minimum skill rating. - **Type:** Integer - **Minimum:** `1` #### `value` -The minimum skill rating the defined minimum number of skills need to be -on. +The minimum skill rating the defined minimum number of skills need to be on. - **Type:** Integer - **Minimum:** `1` diff --git a/docs/reference/prerequisites/single/TextPrerequisite.md b/docs/reference/prerequisites/single/TextPrerequisite.md index 203328b2..cce763ce 100644 --- a/docs/reference/prerequisites/single/TextPrerequisite.md +++ b/docs/reference/prerequisites/single/TextPrerequisite.md @@ -4,10 +4,7 @@ ### Text Prerequisite (`TextPrerequisite`) -A prerequisite that is either not verifyable in general – e.g. roleplay or -background information – or the referenced entities were not made available -for use yet – e.g. races –, but which should be displayed, because it is part -of the prerequisite string from the sources. +A prerequisite that is either not verifyable in general – e.g. roleplay or background information – or the referenced entities were not made available for use yet – e.g. races –, but which should be displayed, because it is part of the prerequisite string from the sources. - **Type:** Object @@ -20,36 +17,23 @@ Key | Description | Details #### `verification` -The method how the prerequisite should be verified. Either is passes all -verification text or it denies all verification tests. The latter results -in the associated entry to never be available for purchase. +The method how the prerequisite should be verified. Either is passes all verification text or it denies all verification tests. The latter results in the associated entry to never be available for purchase. - **Type:** TextVerificationRule #### `sentence_type?` -If the text is a sentence or sentence-like fragment, this property ensures -it is integrated into the prerequisite string correctly. +If the text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. -A standalone sentence is connected to the previous prerequisite string with -a period and a period is also added at the end of the sentence -automatically, if it is not present. A connected sentence is connected to -the previous prerequisite string with a semicolon and a period is not added -to the end of the sentence. In this case, if there are prerequisites after -this one, they will be connected using a semicolon again, unless a -different punctuation mark is present at the end of the given text. +A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. - **Type:** SentenceType #### `is_meta?` -If the text does not represent an actual prerequisite but a prerequisite -for the use of certain aspects or the entry the prerequisite is associated -with, or something like that, this property is set to `true`. +If the text does not represent an actual prerequisite but a prerequisite for the use of certain aspects or the entry the prerequisite is associated with, or something like that, this property is set to `true`. -If all prerequisites of an entry are marked as meta, the entry is -considered to have no prerequisites and thus the string `none` must be -rendered before the list of meta prerequisites. +If all prerequisites of an entry are marked as meta, the entry is considered to have no prerequisites and thus the string `none` must be rendered before the list of meta prerequisites. This is the only use case for this property. diff --git a/docs/reference/prerequisites/single/TraditionPrerequisite.md b/docs/reference/prerequisites/single/TraditionPrerequisite.md index 44b43a21..f078f50d 100644 --- a/docs/reference/prerequisites/single/TraditionPrerequisite.md +++ b/docs/reference/prerequisites/single/TraditionPrerequisite.md @@ -13,8 +13,7 @@ Key | Description | Details #### `restriction?` -The blessed tradition prerequisite may only be satified if the blessed -tradition is either church or shamanistic. +The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. - **Type:** BlessedTraditionPrerequisiteRestriction @@ -26,8 +25,7 @@ tradition is either church or shamanistic. ### `BlessedTraditionPrerequisiteRestriction` -The blessed tradition prerequisite may only be satified if the blessed -tradition is either church or shamanistic. +The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. - **Type:** Union - **Cases:** BlessedTraditionPrerequisiteRestriction'0 | BlessedTraditionPrerequisiteRestriction'1 @@ -57,8 +55,7 @@ Key | Description | Details #### `restriction?` -The magical tradition prerequisite may only be satified if the magical -tradition can learn rituals or can bind familiars. +The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. - **Type:** MagicalTraditionPrerequisiteRestriction @@ -70,8 +67,7 @@ tradition can learn rituals or can bind familiars. ### `MagicalTraditionPrerequisiteRestriction` -The magical tradition prerequisite may only be satified if the magical -tradition can learn rituals or can bind familiars. +The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. - **Type:** Union - **Cases:** MagicalTraditionPrerequisiteRestriction'0 | MagicalTraditionPrerequisiteRestriction'1 diff --git a/docs/reference/rule/CoreRule.md b/docs/reference/rule/CoreRule.md index a04d347c..6600a185 100644 --- a/docs/reference/rule/CoreRule.md +++ b/docs/reference/rule/CoreRule.md @@ -149,9 +149,7 @@ Key | Description | Details ### `ChildNode` -A core rule nested inside this core rule. It may be displayed as a separate -page or its content may be included in this rule's text, which will -automatically generate a proper heading. No content node of a type other than +A core rule nested inside this core rule. It may be displayed as a separate page or its content may be included in this rule's text, which will automatically generate a proper heading. No content node of a type other than `Child` should follow a child node, since then it may look like the the text may be part of the child node. @@ -170,9 +168,7 @@ The nested core rule's identifier. #### `include` -If the nested core rule's content should be integrated into this core rule -and a proper heading should be added. Otherwise create a link to a separate -view of that core rule. +If the nested core rule's content should be integrated into this core rule and a proper heading should be added. Otherwise create a link to a separate view of that core rule. - **Type:** Boolean @@ -180,8 +176,7 @@ view of that core rule. ### `TextNode` -A simple text block, containing one or multiple paragraphs. Headings are not -allowed, they should be handled as nested core rules instead. +A simple text block, containing one or multiple paragraphs. Headings are not allowed, they should be handled as nested core rules instead. - **Type:** Object @@ -1748,9 +1743,7 @@ Key | Description | Details #### `target` -Define if the cost for attributes or skills should be defined. The -cost for attributes start with value 9, while the cost for skills -start with 1 in addition to possible activation cost. +Define if the cost for attributes or skills should be defined. The cost for attributes start with value 9, while the cost for skills start with 1 in addition to possible activation cost. - **Type:** ReferenceListNodeImprovementCostSourceTarget @@ -1758,12 +1751,7 @@ start with 1 in addition to possible activation cost. The highest value the improvement cost are displayed for. -The minimum maximum value should depend on what is the upper bound of -the range of adventure point cost that are equal across multiple -values (value increases for attributes are always 15 up to (and -including) value 14, while value increases for skills are always 1 to -4, depending on the improvement cost, up to (and including) value -12), since those ranges should be combined into a single table row. +The minimum maximum value should depend on what is the upper bound of the range of adventure point cost that are equal across multiple values (value increases for attributes are always 15 up to (and including) value 14, while value increases for skills are always 1 to 4, depending on the improvement cost, up to (and including) value 12), since those ranges should be combined into a single table row. - **Type:** Integer - **Minimum:** `12` diff --git a/docs/reference/rule/FocusRule.md b/docs/reference/rule/FocusRule.md index 94c307e9..c67a6913 100644 --- a/docs/reference/rule/FocusRule.md +++ b/docs/reference/rule/FocusRule.md @@ -38,8 +38,7 @@ The focus rule's level. #### `is_missing_implementation` -Has the focus rule not been implemented in Optolith yet? This is also true -if the focus rule does not (currently) apply to any Optolith feature. +Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. - **Type:** Boolean diff --git a/docs/reference/rule/OptionalRule.md b/docs/reference/rule/OptionalRule.md index edc0b6ab..e4f67bfe 100644 --- a/docs/reference/rule/OptionalRule.md +++ b/docs/reference/rule/OptionalRule.md @@ -22,8 +22,7 @@ The optional rule's identifier. An unique, increasing integer. #### `is_missing_implementation` -Has the focus rule not been implemented in Optolith yet? This is also true -if the focus rule does not (currently) apply to any Optolith feature. +Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. - **Type:** Boolean diff --git a/docs/reference/source/Publication.md b/docs/reference/source/Publication.md index dc419f0d..c4f5a5bb 100644 --- a/docs/reference/source/Publication.md +++ b/docs/reference/source/Publication.md @@ -36,8 +36,7 @@ If the publication may contain adult content. #### `is_missing_implementation` -If the publication is not (fully) implemented and thus needs to be excluded -from * stable releases. +If the publication is not (fully) implemented and thus needs to be excluded from * stable releases. - **Type:** Boolean @@ -95,8 +94,7 @@ The publication's release date. #### `is_missing_implementation` -If this publication translation is not (fully) implemented and thus needs -to be excluded from stable releases. +If this publication translation is not (fully) implemented and thus needs to be excluded from stable releases. - **Type:** Boolean diff --git a/docs/reference/source/_PublicationRef.md b/docs/reference/source/_PublicationRef.md index f7d82036..82eaac9b 100644 --- a/docs/reference/source/_PublicationRef.md +++ b/docs/reference/source/_PublicationRef.md @@ -22,9 +22,7 @@ The publications where you can find the entry. ### Publication Reference (`PublicationRef`) -A source reference. It contains the book's publisher identifier and the page -where it occurs. If an entry spans multiple pages, provide the last page as -well. +A source reference. It contains the book's publisher identifier and the page where it occurs. If an entry spans multiple pages, provide the last page as well. - **Type:** Object @@ -97,16 +95,14 @@ Key | Description | Details #### `first_page` -The page where it occurs. If the entry spans multiple pages, use this as -the first page and `last_page` as the last page. +The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. - **Type:** Integer - **Minimum:** `1` #### `last_page?` -The last page where it occurs. If there is only one page, set this to the -same as `first_page` oder remove it. +The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. - **Type:** Integer - **Minimum:** `2` @@ -130,8 +126,7 @@ The initial occurrence of the entry. #### `revisions?` -Revisions of the entry, resulting in either changed page references or -re-addition or removal of an entry. +Revisions of the entry, resulting in either changed page references or re-addition or removal of an entry. - **Type:** List - **Items:** VersionedOccurrence/revisions[] @@ -156,8 +151,7 @@ Key | Description | Details #### `printing?` -The publication's printing since which the entry is present. Leave -empty if present since the beginning. +The publication's printing since which the entry is present. Leave empty if present since the beginning. - **Type:** Integer - **Minimum:** `2` @@ -180,8 +174,7 @@ The initial page references. ### Revision (`Revision`) -A revision of the entry, resulting in either changed page references or -re-addition or removal of an entry. +A revision of the entry, resulting in either changed page references or re-addition or removal of an entry. - **Type:** Union - **Cases:** Revision'Since | Revision'Deprecated @@ -237,8 +230,7 @@ Key | Description | Details #### `printing` -The publication's printing since which the entry is present again or has -changed page references. +The publication's printing since which the entry is present again or has changed page references. - **Type:** Integer - **Minimum:** `2` @@ -287,15 +279,13 @@ Key | Description | Details #### `first_page` -The page where it occurs. If the entry spans multiple pages, use this as -the first page and `last_page` as the last page. +The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. - **Type:** Page #### `last_page?` -The last page where it occurs. If there is only one page, set this to the -same as `first_page` oder remove it. +The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. - **Type:** Page diff --git a/docs/reference/specialAbility/AdvancedCombatSpecialAbility.md b/docs/reference/specialAbility/AdvancedCombatSpecialAbility.md index 1056f048..4d19c171 100644 --- a/docs/reference/specialAbility/AdvancedCombatSpecialAbility.md +++ b/docs/reference/specialAbility/AdvancedCombatSpecialAbility.md @@ -110,16 +110,13 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement #### `ap_value_append?` -A string that gets appended to the default AP Value text with a preceding -space. This always happens if present, even if the generated AP Value text -is replaced. +A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. - **Type:** AdventurePointsValueAppend diff --git a/docs/reference/specialAbility/BlessedTradition.md b/docs/reference/specialAbility/BlessedTradition.md index 8413b2d2..80760e74 100644 --- a/docs/reference/specialAbility/BlessedTradition.md +++ b/docs/reference/specialAbility/BlessedTradition.md @@ -43,8 +43,7 @@ Key | Description | Details #### `primary?` -The tradition's primary attribute. Leave empty if the tradition does not -have one. +The tradition's primary attribute. Leave empty if the tradition does not have one. - **Type:** AttributeReference @@ -80,8 +79,7 @@ A list of favored skills. #### `favored_skills_selection?` -On activation of the tradition, a specific number of skills from a list of -skills must be selected as being favored. +On activation of the tradition, a specific number of skills from a list of skills must be selected as being favored. - **Type:** FavoredSkillsSelection @@ -93,8 +91,7 @@ The type of the tradition. May be either church or shamanistic. #### `associated_principles_id?` -The select option's identifier of the disadvantage *Principles* that -represent this tradition's code, if any. +The select option's identifier of the disadvantage *Principles* that represent this tradition's code, if any. - **Type:** Number @@ -456,8 +453,7 @@ Key | Description | Details #### `name_compressed?` -A shorter name of the tradition's name, used in liturgical chant -descriptions. +A shorter name of the tradition's name, used in liturgical chant descriptions. - **Type:** String - **Minimum Length:** `1` @@ -468,8 +464,7 @@ descriptions. #### `special_rules` -The special rules of the tradition. They should be sorted like they are -in the book. +The special rules of the tradition. They should be sorted like they are in the book. - **Type:** List - **Items:** BlessedTraditionTranslation/special_rules[] diff --git a/docs/reference/specialAbility/CeremonialItemSpecialAbility.md b/docs/reference/specialAbility/CeremonialItemSpecialAbility.md index 46bf5321..97e2e490 100644 --- a/docs/reference/specialAbility/CeremonialItemSpecialAbility.md +++ b/docs/reference/specialAbility/CeremonialItemSpecialAbility.md @@ -94,8 +94,7 @@ Key | Description | Details #### `prerequisites?` -The prerequisites text. It is only used if the text cannot be generated -from the given information. +The prerequisites text. It is only used if the text cannot be generated from the given information. - **Type:** PrerequisitesReplacement diff --git a/docs/reference/specialAbility/FatePointSpecialAbility.md b/docs/reference/specialAbility/FatePointSpecialAbility.md index a9fdc35a..f07aef7d 100644 --- a/docs/reference/specialAbility/FatePointSpecialAbility.md +++ b/docs/reference/specialAbility/FatePointSpecialAbility.md @@ -89,8 +89,7 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/specialAbility/GeneralSpecialAbility.md b/docs/reference/specialAbility/GeneralSpecialAbility.md index 06accb44..771227e4 100644 --- a/docs/reference/specialAbility/GeneralSpecialAbility.md +++ b/docs/reference/specialAbility/GeneralSpecialAbility.md @@ -96,9 +96,7 @@ A string that is used as a label for an input field. #### `ap_value_append?` -A string that gets appended to the default AP Value text with a preceding -space. This always happens if present, even if the generated AP Value text -is replaced. +A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. - **Type:** AdventurePointsValueAppend diff --git a/docs/reference/specialAbility/KarmaSpecialAbility.md b/docs/reference/specialAbility/KarmaSpecialAbility.md index 1e95a2be..216423b1 100644 --- a/docs/reference/specialAbility/KarmaSpecialAbility.md +++ b/docs/reference/specialAbility/KarmaSpecialAbility.md @@ -79,8 +79,7 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/specialAbility/MagicalSpecialAbility.md b/docs/reference/specialAbility/MagicalSpecialAbility.md index 0353ea36..1aac9228 100644 --- a/docs/reference/specialAbility/MagicalSpecialAbility.md +++ b/docs/reference/specialAbility/MagicalSpecialAbility.md @@ -96,8 +96,7 @@ A string that is used as a label for an input field. #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/specialAbility/MagicalTradition.md b/docs/reference/specialAbility/MagicalTradition.md index 221f4ff5..477b9e38 100644 --- a/docs/reference/specialAbility/MagicalTradition.md +++ b/docs/reference/specialAbility/MagicalTradition.md @@ -51,8 +51,7 @@ Key | Description | Details #### `primary?` -The tradition's primary attribute. Leave empty if the tradition does not -have one. +The tradition's primary attribute. Leave empty if the tradition does not have one. - **Type:** PrimaryAttribute @@ -82,15 +81,13 @@ Can this magical tradition bind familiars? #### `allows_multiple_traditions` -Does the tradition allow learning more traditions or having learned a -different tradition before learning this tradition? +Does the tradition allow learning more traditions or having learned a different tradition before learning this tradition? - **Type:** Boolean #### `alternative_magical_adventure_points_maximum?` -Is the maximum AP you're able to spent on magical advantages and able to -get by magical disadvantages different than the default of 50 AP? +Is the maximum AP you're able to spent on magical advantages and able to get by magical disadvantages different than the default of 50 AP? - **Type:** Integer - **Minimum:** `25` @@ -99,8 +96,7 @@ get by magical disadvantages different than the default of 50 AP? #### `require_non_spellwork_exclusive_effects` -Are advantages/disadvantages required to not exclusively apply to arcane -spellworks, but also to the tradition's magical actions or applications? +Are advantages/disadvantages required to not exclusively apply to arcane spellworks, but also to the tradition's magical actions or applications? - **Type:** Boolean @@ -112,8 +108,7 @@ Is this a magical dilettante tradition? #### `use_arcane_spellworks_from_tradition?` -If arcane spellworks from a different tradition count as arcane spellworks -of this tradition, this is the different tradition's reference. +If arcane spellworks from a different tradition count as arcane spellworks of this tradition, this is the different tradition's reference. - **Type:** MagicalTraditionReference @@ -168,9 +163,7 @@ The attribute's identifier. #### `use_half_for_arcane_energy` -Typically, the value of the primary attribute (if one exists) is added -onto the base of 20 AE to get the actual AE. But sometimes, only half the -value is added. +Typically, the value of the primary attribute (if one exists) is added onto the base of 20 AE to get the actual AE. But sometimes, only half the value is added. - **Type:** Boolean @@ -194,8 +187,7 @@ Key | Description | Details #### `name_for_arcane_spellworks?` -The name used for the traditions list of arcane spellworks if it is -different than the `name` of the special ability. +The name used for the traditions list of arcane spellworks if it is different than the `name` of the special ability. - **Type:** String - **Minimum Length:** `1` @@ -206,8 +198,7 @@ different than the `name` of the special ability. #### `special_rules` -The special rules of the tradition. They should be sorted like they are -in the book. +The special rules of the tradition. They should be sorted like they are in the book. - **Type:** List - **Items:** MagicalTraditionTranslation/special_rules[] diff --git a/docs/reference/specialAbility/PactGift.md b/docs/reference/specialAbility/PactGift.md index 9478aac6..21b5b118 100644 --- a/docs/reference/specialAbility/PactGift.md +++ b/docs/reference/specialAbility/PactGift.md @@ -41,8 +41,7 @@ Key | Description | Details #### `automatic_entries?` -This pact gift has direct influence on the existence of other entries. It -may add or remove entries. +This pact gift has direct influence on the existence of other entries. It may add or remove entries. - **Type:** List - **Items:** PactGift/automatic_entries[] @@ -147,8 +146,7 @@ Key | Description | Details #### `levels` -The levels of *Demonic Consumption* the pact gift causes per activated -level of the pact gift. +The levels of *Demonic Consumption* the pact gift causes per activated level of the pact gift. - **Type:** Integer - **Minimum:** `1` @@ -174,15 +172,13 @@ What type of action is applied to the target entry? #### `apply_ap_value` -If an entry is added or removed, does is cost or grant adventure points -or is it free of charge? +If an entry is added or removed, does is cost or grant adventure points or is it free of charge? - **Type:** Boolean #### `target` -The entry that is to be added or removed. It can be a fixed entry or a -selection where the player must choose one entry. +The entry that is to be added or removed. It can be a fixed entry or a selection where the player must choose one entry. - **Type:** AutomaticEntryTarget diff --git a/docs/reference/specialAbility/SikaryanDrainSpecialAbility.md b/docs/reference/specialAbility/SikaryanDrainSpecialAbility.md index 0125d124..281ddca3 100644 --- a/docs/reference/specialAbility/SikaryanDrainSpecialAbility.md +++ b/docs/reference/specialAbility/SikaryanDrainSpecialAbility.md @@ -79,8 +79,7 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/specialAbility/VampiricGift.md b/docs/reference/specialAbility/VampiricGift.md index 0f1456f2..5908187f 100644 --- a/docs/reference/specialAbility/VampiricGift.md +++ b/docs/reference/specialAbility/VampiricGift.md @@ -79,8 +79,7 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/specialAbility/_Tradition.md b/docs/reference/specialAbility/_Tradition.md index 136ac137..6e93561a 100644 --- a/docs/reference/specialAbility/_Tradition.md +++ b/docs/reference/specialAbility/_Tradition.md @@ -13,8 +13,7 @@ Key | Description | Details #### `label?` -An optional label that is displayed and placed before the actual -text. +An optional label that is displayed and placed before the actual text. - **Type:** NonEmptyString diff --git a/docs/reference/specialAbility/sub/Language.md b/docs/reference/specialAbility/sub/Language.md index cf4b4cf5..4f0e2c5c 100644 --- a/docs/reference/specialAbility/sub/Language.md +++ b/docs/reference/specialAbility/sub/Language.md @@ -33,8 +33,7 @@ The continents this language is present on. #### `specializations?` -Language-specific specializations. Either a list of possible options or a -indefinite description of what may be a specialization. +Language-specific specializations. Either a list of possible options or a indefinite description of what may be a specialization. - **Type:** Specializations @@ -44,8 +43,7 @@ indefinite description of what may be a specialization. #### `max_level?` -The maximum possible level of the language. Only specified if lower than -default of 3. +The maximum possible level of the language. Only specified if lower than default of 3. - **Type:** Number - **Default:** `3` @@ -180,8 +178,7 @@ The name of the specialization. #### `description?` -The specialization description. It will be appended to the name in -parenthesis. +The specialization description. It will be appended to the name in parenthesis. - **Type:** NonEmptyString @@ -220,8 +217,7 @@ The specializations description. #### `label?` -An input label or placeholder text for an UI element if it differs -from the `description`. +An input label or placeholder text for an UI element if it differs from the `description`. - **Type:** NonEmptyString diff --git a/docs/reference/traditionArtifacts/CauldronEnchantment.md b/docs/reference/traditionArtifacts/CauldronEnchantment.md index c7864f2d..25b921bc 100644 --- a/docs/reference/traditionArtifacts/CauldronEnchantment.md +++ b/docs/reference/traditionArtifacts/CauldronEnchantment.md @@ -47,8 +47,7 @@ Key | Description | Details #### `brew` -Witches can learn to brew special things in their Witch's Cauldron. These -brews can be categorized in different types. +Witches can learn to brew special things in their Witch's Cauldron. These brews can be categorized in different types. - **Type:** BrewReference diff --git a/docs/reference/traditionArtifacts/SpellSwordEnchantment.md b/docs/reference/traditionArtifacts/SpellSwordEnchantment.md index 9276909c..dc7ed969 100644 --- a/docs/reference/traditionArtifacts/SpellSwordEnchantment.md +++ b/docs/reference/traditionArtifacts/SpellSwordEnchantment.md @@ -109,8 +109,7 @@ Key | Description | Details #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/docs/reference/traditionArtifacts/StaffEnchantment.md b/docs/reference/traditionArtifacts/StaffEnchantment.md index 1174570d..ccee4b75 100644 --- a/docs/reference/traditionArtifacts/StaffEnchantment.md +++ b/docs/reference/traditionArtifacts/StaffEnchantment.md @@ -116,8 +116,7 @@ A note, appended to the generated cost string in parenthesis. #### `ap_value?` -The AP value. It is only used if the text cannot be generated from the -given information. +The AP value. It is only used if the text cannot be generated from the given information. - **Type:** AdventurePointsValueReplacement diff --git a/schema/Advantage.schema.json b/schema/Advantage.schema.json index 835f995a..3e824413 100644 --- a/schema/Advantage.schema.json +++ b/schema/Advantage.schema.json @@ -32,12 +32,12 @@ "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValue" }, "has_maximum_spent_influence": { - "description": "Does this advantage count towards the maximum of AP to be spent on\nadvantages?", + "description": "Does this advantage count towards the maximum of AP to be spent on advantages?", "type": "boolean", "default": true }, "is_exclusive_to_arcane_spellworks": { - "description": "Does this advantage exclusively applies to arcane spellworks and not\nto magical actions and magical applications?", + "description": "Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications?", "type": "boolean", "default": false }, @@ -91,7 +91,7 @@ "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "ap_value_append": { - "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.", + "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.", "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueAppend" }, "errata": { diff --git a/schema/AnimalDisease.schema.json b/schema/AnimalDisease.schema.json index e18e3f76..b825525d 100644 --- a/schema/AnimalDisease.schema.json +++ b/schema/AnimalDisease.schema.json @@ -18,11 +18,11 @@ "minimum": 1 }, "resistance": { - "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the\ndisease roll. It may also happen that the lower of both is applied as a\npenalty.", + "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty.", "$ref": "./_DiseasePoison.schema.json#/$defs/Resistance" }, "cause": { - "description": "What causes the disease? The GM rolls 1D20 to see if a character gets\ninfected. If the infection check succeeds, the GM makes a disease check to\ndetermine the severity of the infection.", + "description": "What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection.", "type": "array", "items": { "$ref": "./_DiseasePoison.schema.json#/$defs/Cause" @@ -30,14 +30,14 @@ "minItems": 1 }, "animal_types": { - "description": "The animal types this disease applies to.\n\nIf no animal types are given, the animal disease applies to all animal\ntypes.", + "description": "The animal types this disease applies to.\n\nIf no animal types are given, the animal disease applies to all animal types.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/AnimalTypeReference" } }, "communicability_to_intelligent_creatures": { - "description": "If and at which chance the disease can be communicated to intelligent\ncreatures.\n\nIf no causes are given, the disease is not communicable to intelligent\ncreatures.", + "description": "If and at which chance the disease can be communicated to intelligent creatures.\n\nIf no causes are given, the disease is not communicable to intelligent creatures.", "type": "array", "items": { "$ref": "./_DiseasePoison.schema.json#/$defs/Cause" diff --git a/schema/Aspect.schema.json b/schema/Aspect.schema.json index b8f9835c..383498ee 100644 --- a/schema/Aspect.schema.json +++ b/schema/Aspect.schema.json @@ -38,7 +38,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "master_of_aspect_suffix": { - "description": "The aspect's name appended to the simple name (not `name_in_library`)\nof the special ability *Master of (Aspect)*.", + "description": "The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, diff --git a/schema/Cantrip.schema.json b/schema/Cantrip.schema.json index c889b31b..66349f86 100644 --- a/schema/Cantrip.schema.json +++ b/schema/Cantrip.schema.json @@ -25,7 +25,7 @@ "$ref": "./_SimpleReferences.schema.json#/$defs/PropertyReference" }, "note": { - "description": "A note specifying the dissemination of the cantrip in different traditions.\nSometimes a cantrip is exclusively available to one or more specific\ntraditions, but usually one the academies and traditions are listed the\ncantrip is most commonly teached in.", + "description": "A note specifying the dissemination of the cantrip in different traditions. Sometimes a cantrip is exclusively available to one or more specific traditions, but usually one the academies and traditions are listed the cantrip is most commonly teached in.", "$ref": "#/$defs/CantripNote" }, "src": { diff --git a/schema/Ceremony.schema.json b/schema/Ceremony.schema.json index 237e2516..a3b86ce5 100644 --- a/schema/Ceremony.schema.json +++ b/schema/Ceremony.schema.json @@ -29,7 +29,7 @@ "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/AffectedTargetCategories" }, "traditions": { - "description": "The tradition(s) the ceremony is available for. Note that general aspects\ndo not have an associated tradition and thus need to be defined in a\nspecial way.", + "description": "The tradition(s) the ceremony is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way.", "type": "array", "items": { "$ref": "./_Blessed.schema.json#/$defs/SkillTradition" @@ -81,11 +81,11 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "name_compressed": { - "description": "A compressed name of the ceremony for use in small areas (e.g. on\ncharacter sheet). Should only be defined if the `name` does not fit on\ncharacter sheet.", + "description": "A compressed name of the ceremony for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "./_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/CombatTechnique_Close.schema.json b/schema/CombatTechnique_Close.schema.json index ca6799af..561d4adb 100644 --- a/schema/CombatTechnique_Close.schema.json +++ b/schema/CombatTechnique_Close.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "special": { - "description": "Special rules for the combat technique that apply to all weapons in this\ncategory.", + "description": "Special rules for the combat technique that apply to all weapons in this category.", "$ref": "#/$defs/CloseCombatTechniqueSpecialRules" }, "primary_attribute": { @@ -61,7 +61,7 @@ "additionalProperties": false }, "CloseCombatTechniqueSpecialRules": { - "description": "Special rules for the combat technique that apply to all weapons in this\ncategory.", + "description": "Special rules for the combat technique that apply to all weapons in this category.", "type": "object", "properties": { "can_parry": { diff --git a/schema/CombatTechnique_Ranged.schema.json b/schema/CombatTechnique_Ranged.schema.json index f4f6cc30..0caaa6bf 100644 --- a/schema/CombatTechnique_Ranged.schema.json +++ b/schema/CombatTechnique_Ranged.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "special": { - "description": "Special rules for the combat technique that apply to all weapons in this\ncategory.", + "description": "Special rules for the combat technique that apply to all weapons in this category.", "$ref": "#/$defs/RangedCombatTechniqueSpecialRules" }, "primary_attribute": { @@ -61,7 +61,7 @@ "additionalProperties": false }, "RangedCombatTechniqueSpecialRules": { - "description": "Special rules for the combat technique that apply to all weapons in this\ncategory.", + "description": "Special rules for the combat technique that apply to all weapons in this category.", "type": "object", "properties": { "has_ammunition": { diff --git a/schema/Continent.schema.json b/schema/Continent.schema.json index 929a67d1..83fcfaef 100644 --- a/schema/Continent.schema.json +++ b/schema/Continent.schema.json @@ -5,7 +5,7 @@ "$defs": { "Continent": { "title": "Continent", - "description": "Continents are mostly referenced to in languages and scripts that occur on a\nspecific continent.", + "description": "Continents are mostly referenced to in languages and scripts that occur on a specific continent.", "type": "object", "properties": { "id": { diff --git a/schema/Culture.schema.json b/schema/Culture.schema.json index 9857fae2..04ac65c9 100644 --- a/schema/Culture.schema.json +++ b/schema/Culture.schema.json @@ -21,7 +21,7 @@ "minItems": 1 }, "script": { - "description": "A list of native scripts (usually it is only one). If the culture does not\nuse any script, leave this field empty.", + "description": "A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/ScriptReference" @@ -41,7 +41,7 @@ "minItems": 1 }, "common_professions": { - "description": "A list of professions that are typical for the culture, as well as\nprofessions that are rarely practiced or encountered in the culture. The\nlist is either defined by group (as multiple lists) or plain (as a single\nlist).", + "description": "A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list).", "$ref": "#/$defs/CommonProfessions" }, "common_advantages": { @@ -187,7 +187,7 @@ "additionalProperties": false }, "CommonnessWeight": { - "description": "The \"weight\" difference compared to other professions or profession variants.\nSome professions or profession variants are simply more common (Mostly), but\nsometimes only specific elements are used (Only).", + "description": "The \"weight\" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only).", "oneOf": [ { "const": "Mostly" @@ -198,7 +198,7 @@ ] }, "CommonProfessionConstraintsOperation": { - "description": "This defines how the list of constraints should be offset against the\nlist of all mundane professions: Either only the professions are kept\nthat intersect with the constraints (include) or only the professions\nare kept that are different from the constraints (exclude).", + "description": "This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).", "oneOf": [ { "const": "Intersection" @@ -227,7 +227,7 @@ "$ref": "./_Identifier.schema.json#/$defs/ProfessionIdentifier" }, "weighted_variants": { - "description": "Some professions or profession variants are more common than others. There\nmay be cultures where some professions or profession variants are not\nrepresented at all.", + "description": "Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all.", "type": "object", "properties": { "elements": { @@ -239,7 +239,7 @@ "minItems": 1 }, "weight": { - "description": "The \"weight\" difference compared to other professions or profession\nvariants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", + "description": "The \"weight\" difference compared to other professions or profession variants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", "$ref": "#/$defs/CommonnessWeight" } }, @@ -250,7 +250,7 @@ "additionalProperties": false }, "rarity": { - "description": "Some professions may be found in a culture, but are not that\ncommon.", + "description": "Some professions may be found in a culture, but are not that common.", "$ref": "#/$defs/Rarity" } }, @@ -281,7 +281,7 @@ "$ref": "./_Identifier.schema.json#/$defs/MagicalTraditionIdentifier" }, "weighted_professions": { - "description": "Some professions or profession variants are more common than others. There\nmay be cultures where some professions or profession variants are not\nrepresented at all.", + "description": "Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all.", "type": "object", "properties": { "elements": { @@ -293,7 +293,7 @@ "minItems": 1 }, "weight": { - "description": "The \"weight\" difference compared to other professions or profession\nvariants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", + "description": "The \"weight\" difference compared to other professions or profession variants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", "$ref": "#/$defs/CommonnessWeight" } }, @@ -321,7 +321,7 @@ "$ref": "./_Identifier.schema.json#/$defs/BlessedTraditionIdentifier" }, "weighted_professions": { - "description": "Some professions or profession variants are more common than others. There\nmay be cultures where some professions or profession variants are not\nrepresented at all.", + "description": "Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all.", "type": "object", "properties": { "elements": { @@ -333,7 +333,7 @@ "minItems": 1 }, "weight": { - "description": "The \"weight\" difference compared to other professions or profession\nvariants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", + "description": "The \"weight\" difference compared to other professions or profession variants. Some professions or profession variants are simply more common\n(Mostly), but sometimes only specific elements are used (Only).", "$ref": "#/$defs/CommonnessWeight" } }, @@ -445,27 +445,23 @@ ] }, "BlessedCommonProfessionConstraint": { - "oneOf": [ - { - "type": "object", - "properties": { - "tag": { - "const": "Tradition" - }, - "tradition": { - "$ref": "#/$defs/BlessedTraditionConstraint" - } - }, - "required": [ - "tag", - "tradition" - ], - "additionalProperties": false + "type": "object", + "properties": { + "tag": { + "const": "Tradition" + }, + "tradition": { + "$ref": "#/$defs/BlessedTraditionConstraint" } - ] + }, + "required": [ + "tag", + "tradition" + ], + "additionalProperties": false }, "PlainCommonProfessions": { - "description": "A list of professions. The filter specifies how the list is applied to\nall mundane professions.", + "description": "A list of professions. The filter specifies how the list is applied to all mundane professions.", "type": "object", "properties": { "constraints": { @@ -477,7 +473,7 @@ "minItems": 1 }, "operation": { - "description": "This defines how the list of constraints should be offset against the\nlist of all mundane professions: Either only the professions are kept\nthat intersect with the constraints (include) or only the professions\nare kept that are different from the constraints (exclude).", + "description": "This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).", "$ref": "#/$defs/CommonProfessionConstraintsOperation" } }, @@ -492,7 +488,7 @@ "type": "object", "properties": { "mundane": { - "description": "A list of professions. The filter specifies how the list is applied to\nall mundane professions.", + "description": "A list of professions. The filter specifies how the list is applied to all mundane professions.", "type": "object", "properties": { "constraints": { @@ -504,7 +500,7 @@ "minItems": 1 }, "operation": { - "description": "This defines how the list of constraints should be offset against the\nlist of all mundane professions: Either only the professions are kept\nthat intersect with the constraints (include) or only the professions\nare kept that are different from the constraints (exclude).", + "description": "This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).", "$ref": "#/$defs/CommonProfessionConstraintsOperation" } }, @@ -515,7 +511,7 @@ "additionalProperties": false }, "magic": { - "description": "A list of professions. The filter specifies how the list is applied to\nall mundane professions.", + "description": "A list of professions. The filter specifies how the list is applied to all mundane professions.", "type": "object", "properties": { "constraints": { @@ -527,7 +523,7 @@ "minItems": 1 }, "operation": { - "description": "This defines how the list of constraints should be offset against the\nlist of all mundane professions: Either only the professions are kept\nthat intersect with the constraints (include) or only the professions\nare kept that are different from the constraints (exclude).", + "description": "This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).", "$ref": "#/$defs/CommonProfessionConstraintsOperation" } }, @@ -538,7 +534,7 @@ "additionalProperties": false }, "blessed": { - "description": "A list of professions. The filter specifies how the list is applied to\nall mundane professions.", + "description": "A list of professions. The filter specifies how the list is applied to all mundane professions.", "type": "object", "properties": { "constraints": { @@ -550,7 +546,7 @@ "minItems": 1 }, "operation": { - "description": "This defines how the list of constraints should be offset against the\nlist of all mundane professions: Either only the professions are kept\nthat intersect with the constraints (include) or only the professions\nare kept that are different from the constraints (exclude).", + "description": "This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).", "$ref": "#/$defs/CommonProfessionConstraintsOperation" } }, @@ -566,7 +562,7 @@ "additionalProperties": false }, "CommonProfessions": { - "description": "A list of professions that are typical for the culture, as well as\nprofessions that are rarely practiced or encountered in the culture. The\nlist is either defined by group (as multiple lists) or plain (as a single\nlist).", + "description": "A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list).", "oneOf": [ { "type": "object", @@ -613,7 +609,7 @@ "$ref": "./_Identifier.schema.json#/$defs/SkillIdentifier" }, "points": { - "description": "The skill points for the respective skill you get for buying the cultural\npackage.", + "description": "The skill points for the respective skill you get for buying the cultural package.", "type": "integer", "maximum": 2, "minimum": 1 @@ -678,7 +674,7 @@ "minLength": 1 }, "abbreviated": { - "description": "A shorter version of the description, used in input fields and other UI\nelements where the space might be to small to use the full description.", + "description": "A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description.", "type": "string", "minLength": 1 }, @@ -715,7 +711,7 @@ "type": "object", "properties": { "first_name_groups": { - "description": "First names can be gender-neutral, but they can also be for a specific\nbinary sex. They are sorted into groups.", + "description": "First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups.", "type": "array", "items": { "$ref": "#/$defs/CommonNameGroup" @@ -723,7 +719,7 @@ "minItems": 1 }, "last_name_groups": { - "description": "Last names can be gender-neutral, like family names, but they can also be\nfor a specific binary sex. They are sorted into groups.", + "description": "Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups.", "type": "array", "items": { "$ref": "#/$defs/CommonNameGroup" diff --git a/schema/Disadvantage.schema.json b/schema/Disadvantage.schema.json index 2e93beda..ff0a3eea 100644 --- a/schema/Disadvantage.schema.json +++ b/schema/Disadvantage.schema.json @@ -26,11 +26,11 @@ "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValue" }, "has_maximum_spent_influence": { - "description": "Does this disadvantage count towards the maximum of AP to be spent on\ndisadvantages?", + "description": "Does this disadvantage count towards the maximum of AP to be spent on disadvantages?", "type": "boolean" }, "is_exclusive_to_arcane_spellworks": { - "description": "Does this disadvantage exclusively applies to arcane spellworks and not\nto magical actions and magical applications?", + "description": "Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications?", "type": "boolean" }, "src": { @@ -80,7 +80,7 @@ "minLength": 1 }, "ap_value_append": { - "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.", + "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.", "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueAppend" }, "errata": { diff --git a/schema/Disease.schema.json b/schema/Disease.schema.json index 0586c625..fe0fc40a 100644 --- a/schema/Disease.schema.json +++ b/schema/Disease.schema.json @@ -18,11 +18,11 @@ "minimum": 1 }, "resistance": { - "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the\ndisease roll. It may also happen that the lower of both is applied as a\npenalty.", + "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty.", "$ref": "./_DiseasePoison.schema.json#/$defs/Resistance" }, "cause": { - "description": "What causes the disease? The GM rolls 1D20 to see if a character gets\ninfected. If the infection check succeeds, the GM makes a disease check to\ndetermine the severity of the infection.", + "description": "What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection.", "type": "array", "items": { "$ref": "./_DiseasePoison.schema.json#/$defs/Cause" diff --git a/schema/FamiliarsTrick.schema.json b/schema/FamiliarsTrick.schema.json index a5806f4c..984c38c8 100644 --- a/schema/FamiliarsTrick.schema.json +++ b/schema/FamiliarsTrick.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "animal_types": { - "description": "The animal types this trick is available to. Either it is available to all\nor only a list of specific animal types.\n\nIf no animal types are given, the animal disease applies to all animal\ntypes.", + "description": "The animal types this trick is available to. Either it is available to all or only a list of specific animal types.\n\nIf no animal types are given, the animal disease applies to all animal types.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/AnimalTypeReference" @@ -28,7 +28,7 @@ "$ref": "#/$defs/FamiliarsTrickProperty" }, "ap_value": { - "description": "The AP value the familiar has to pay for. It may also be that a specific is\nknown by all familiar by default. In the latter case the field is not set.", + "description": "The AP value the familiar has to pay for. It may also be that a specific is known by all familiar by default. In the latter case the field is not set.", "type": "integer", "minimum": 1 }, @@ -316,7 +316,7 @@ "type": "object", "properties": { "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 KP\nper person`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 KP per person`.", "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextOptional" } }, diff --git a/schema/Lessons_Curriculum.schema.json b/schema/Lessons_Curriculum.schema.json index 6cdecf53..59d8b6c8 100644 --- a/schema/Lessons_Curriculum.schema.json +++ b/schema/Lessons_Curriculum.schema.json @@ -5,7 +5,7 @@ "$defs": { "Curriculum": { "title": "Curriculum", - "description": "This is a curriculum of a specified academy, containing the guideline,\nelective and restricted spellworks as well as the lesson packages of that\nacademy.", + "description": "This is a curriculum of a specified academy, containing the guideline, elective and restricted spellworks as well as the lesson packages of that academy.", "type": "object", "properties": { "id": { @@ -132,7 +132,7 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/SpellworkIdentifier" }, "restriction": { - "description": "The elective spellwork may only take effect if a certain condition is met.\nThe condition may be related to professions or profession variants, but it\nis designed so that it can work without a specific profession, as multiple\nmay belong to an institute, but with referencing other entities instead.", + "description": "The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead.", "$ref": "#/$defs/ElectiveSpellworkRestriction" } }, @@ -142,7 +142,7 @@ "additionalProperties": false }, "ElectiveSpellworkRestriction": { - "description": "The elective spellwork may only take effect if a certain condition is met.\nThe condition may be related to professions or profession variants, but it is\ndesigned so that it can work without a specific profession, as multiple may\nbelong to an institute, but with referencing other entities instead.", + "description": "The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead.", "type": "object", "properties": { "tag": { @@ -288,7 +288,7 @@ "minItems": 1 }, "maximum": { - "description": "Spellworks from this property up to a certain number are allowed.\nSpellworks excluded from this restriction definition using `exclude` do\nnot contribute to the maximum.", + "description": "Spellworks from this property up to a certain number are allowed. Spellworks excluded from this restriction definition using `exclude` do not contribute to the maximum.", "type": "number" } }, @@ -316,7 +316,7 @@ "minimum": 1 }, "spellwork_changes": { - "description": "The spell values difference of the lesson package. This field reflects the\nchanges (difference) to the field of the same name in the profession\npackage. If a spell gets to SR 0 because of this, it will be removed\ncompletely.", + "description": "The spell values difference of the lesson package. This field reflects the changes (difference) to the field of the same name in the profession package. If a spell gets to SR 0 because of this, it will be removed completely.", "type": "array", "items": { "$ref": "#/$defs/SpellworkChange" @@ -372,7 +372,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "spellwork_changes": { - "description": "The spell values difference of the lesson package. Use this field to\nspecify a text that is displayed instead of the generated\n`spellwork_changes` list. The field is displayed even if no list is\npresent.", + "description": "The spell values difference of the lesson package. Use this field to specify a text that is displayed instead of the generated\n`spellwork_changes` list. The field is displayed even if no list is\npresent.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -440,7 +440,7 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/CombatTechniqueIdentifier" }, "points": { - "description": "The combat technique points that will be added to the current combat\ntechnique rating.", + "description": "The combat technique points that will be added to the current combat technique rating.", "type": "integer", "maximum": 6, "minimum": -6 @@ -479,13 +479,13 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/SpellworkIdentifier" }, "points": { - "description": "The skill points that will be added to the current skill rating. If a\nspell gets to a skill rating of 0 because of this, it will be removed\ncompletely.", + "description": "The skill points that will be added to the current skill rating. If a spell gets to a skill rating of 0 because of this, it will be removed completely.", "type": "integer", "maximum": 10, "minimum": -10 }, "tradition": { - "description": "The target tradition. If the target spell is not from the Guild Mage\ntradition, specify the tradition identifier here.", + "description": "The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here.", "$ref": "./_Identifier.schema.json#/$defs/MagicalTraditionIdentifier" } }, diff --git a/schema/LiturgicalChant.schema.json b/schema/LiturgicalChant.schema.json index 2730ea77..3bb2a41e 100644 --- a/schema/LiturgicalChant.schema.json +++ b/schema/LiturgicalChant.schema.json @@ -29,7 +29,7 @@ "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/AffectedTargetCategories" }, "traditions": { - "description": "The tradition(s) the liturgical chant is available for. Note that general\naspects do not have an associated tradition and thus need to be defined in\na special way.", + "description": "The tradition(s) the liturgical chant is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way.", "type": "array", "items": { "$ref": "./_Blessed.schema.json#/$defs/SkillTradition" @@ -81,11 +81,11 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "name_compressed": { - "description": "A compressed name of the liturgical chant for use in small areas (e.g.\non character sheet). Should only be defined if the `name` does not fit\non character sheet.", + "description": "A compressed name of the liturgical chant for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "./_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/Locale.schema.json b/schema/Locale.schema.json index f5fad0d2..b5091efd 100644 --- a/schema/Locale.schema.json +++ b/schema/Locale.schema.json @@ -23,7 +23,7 @@ "minLength": 1 }, "is_missing_implementation": { - "description": "The language is not (fully) implemented and thus needs to be excluded from\nstable releases.", + "description": "The language is not (fully) implemented and thus needs to be excluded from stable releases.", "const": true } }, diff --git a/schema/MetaCondition.schema.json b/schema/MetaCondition.schema.json index d154794f..f931cb4b 100644 --- a/schema/MetaCondition.schema.json +++ b/schema/MetaCondition.schema.json @@ -5,7 +5,7 @@ "$defs": { "MetaCondition": { "title": "Meta Condition", - "description": "Meta Conditions are rule elements that work like conditions in the sense that\nthey have four levels with different effects, but which are not explicitly\nlisted as conditions.", + "description": "Meta Conditions are rule elements that work like conditions in the sense that they have four levels with different effects, but which are not explicitly listed as conditions.", "type": "object", "properties": { "id": { diff --git a/schema/Patron.schema.json b/schema/Patron.schema.json index a353e196..6a216c5c 100644 --- a/schema/Patron.schema.json +++ b/schema/Patron.schema.json @@ -26,11 +26,11 @@ "maxItems": 3 }, "culture": { - "description": "The patron is only available to a certain set of cultures. It may be\navailable to all, it may be available to only specific ones (intersection)\nand it may be available to all except specific ones to the listed cultures\n(difference).", + "description": "The patron is only available to a certain set of cultures. It may be available to all, it may be available to only specific ones (intersection) and it may be available to all except specific ones to the listed cultures\n(difference).", "$ref": "#/$defs/PatronCulture" }, "primary_patron_cultures": { - "description": "The list of cultures where patrons from this category can be the primary\npatron of.", + "description": "The list of cultures where patrons from this category can be the primary patron of.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/CultureReference" @@ -38,28 +38,28 @@ "uniqueItems": true }, "powers": { - "description": "The patron-specific powers. Used by animist power Animal Powers I–III and\nshould only be present on animal patrons.", + "description": "The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons.", "$ref": "#/$defs/AnimalPowers" }, "ae_cost": { - "description": "The patron-specific AE cost. Used by several animist forces for animal\npatrons.", + "description": "The patron-specific AE cost. Used by several animist forces for animal patrons.", "type": "integer", "minimum": 2, "multipleOf": 2 }, "improvement_cost": { - "description": "The patron-specific improvement cost. Used by several animist forces for\nanimal patrons.", + "description": "The patron-specific improvement cost. Used by several animist forces for animal patrons.", "$ref": "./_ImprovementCost.schema.json#/$defs/ImprovementCost" }, "common_advantages": { - "description": "The patron may grant common advantages that are taken into account during\ncharacter creation.\n\n*Source:* Geisterwald & Knochenklippen, p. 6-7", + "description": "The patron may grant common advantages that are taken into account during character creation.\n\n*Source:* Geisterwald & Knochenklippen, p. 6-7", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/AdvantageReference" } }, "common_disadvantages": { - "description": "The patron may grant common disadvantages that are taken into account\nduring character creation.\n\n*Source:* Geisterwald & Knochenklippen, p. 6-7", + "description": "The patron may grant common disadvantages that are taken into account during character creation.\n\n*Source:* Geisterwald & Knochenklippen, p. 6-7", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/DisadvantageReference" @@ -107,7 +107,7 @@ "additionalProperties": false }, "PatronCulture": { - "description": "The patron cultures the patron is or is not part of. If the patron is part of\nall patron cultures, the set should be empty and the operation should be\ndifference.", + "description": "The patron cultures the patron is or is not part of. If the patron is part of all patron cultures, the set should be empty and the operation should be difference.", "type": "object", "properties": { "set": { @@ -127,7 +127,7 @@ "additionalProperties": false }, "PatronCultureOperation": { - "description": "The set operation to combine the set of all patron cultures with the\nspecified set of patron cultures: If they should intersect, the patron is\nonly part of the given cultures. If they should differ, the patron is only\npart of the cultures that are not given.", + "description": "The set operation to combine the set of all patron cultures with the specified set of patron cultures: If they should intersect, the patron is only part of the given cultures. If they should differ, the patron is only part of the cultures that are not given.", "oneOf": [ { "const": "Intersection" diff --git a/schema/PatronCategory.schema.json b/schema/PatronCategory.schema.json index caf171c9..b7369bff 100644 --- a/schema/PatronCategory.schema.json +++ b/schema/PatronCategory.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "primary_patron_cultures": { - "description": "The list of cultures where patrons from this category can be the primary\npatron of.", + "description": "The list of cultures where patrons from this category can be the primary patron of.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/CultureReference" diff --git a/schema/PersonalityTrait.schema.json b/schema/PersonalityTrait.schema.json index 43876888..4c60f5bc 100644 --- a/schema/PersonalityTrait.schema.json +++ b/schema/PersonalityTrait.schema.json @@ -5,7 +5,7 @@ "$defs": { "PersonalityTrait": { "title": "Personality Trait", - "description": "A personality trait describes character aspects of a person from a certain\nregion. Higher trait levels only cover a part of the region covered by\nlower-level traits.", + "description": "A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits.", "type": "object", "properties": { "id": { @@ -62,7 +62,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effects": { - "description": "The effects of the personality trait. They should be sorted like they\nare in the book.", + "description": "The effects of the personality trait. They should be sorted like they are in the book.", "type": "array", "items": { "$ref": "#/$defs/PersonalityTraitEffect" diff --git a/schema/Profession.schema.json b/schema/Profession.schema.json index f4e00d83..f38e80d1 100644 --- a/schema/Profession.schema.json +++ b/schema/Profession.schema.json @@ -17,7 +17,7 @@ "$ref": "#/$defs/ProfessionGroup" }, "versions": { - "description": "A list of professions representing the same profession but with (slightly)\ndifferent stats. For example, there may be a profession in a regional\nsourcebook or in the core rules and a profession in an extension rulebook\nlike Magic of Aventuria, where the profession is basically called the same\nand almost has the same values, but the version from Magic of Aventuria\nfeatures a spell style special ability that does not exist in the core\nrules or regional sourcebook.\n\nThe profession representation may feature different values for different\nexplicitly mentioned experience levels. In most cases, there is only one\nstats package, which targets the experience level *Experienced*.", + "description": "A list of professions representing the same profession but with (slightly) different stats. For example, there may be a profession in a regional sourcebook or in the core rules and a profession in an extension rulebook like Magic of Aventuria, where the profession is basically called the same and almost has the same values, but the version from Magic of Aventuria features a spell style special ability that does not exist in the core rules or regional sourcebook.\n\nThe profession representation may feature different values for different explicitly mentioned experience levels. In most cases, there is only one stats package, which targets the experience level *Experienced*.", "type": "array", "items": { "$ref": "#/$defs/ProfessionVersion" @@ -151,7 +151,7 @@ "type": "object", "properties": { "id": { - "description": "The profession representation variant's identifier. An unique, increasing\ninteger.", + "description": "The profession representation variant's identifier. An unique, increasing integer.", "type": "integer", "minimum": 1 }, @@ -185,7 +185,7 @@ "type": "object", "properties": { "id": { - "description": "The profession representation variant's identifier. An unique, increasing\ninteger.", + "description": "The profession representation variant's identifier. An unique, increasing integer.", "type": "integer", "minimum": 1 }, @@ -222,7 +222,7 @@ "type": "object", "properties": { "experience_level_id": { - "description": "The experience level this profession targets. The experience level\nmust be unique for this representation.", + "description": "The experience level this profession targets. The experience level must be unique for this representation.", "type": "integer", "default": 3, "maximum": 7, @@ -248,11 +248,11 @@ "minimum": 0 }, "prerequisites": { - "description": "Which prerequisites must be met to buy the stat block? For example, a\ncharacter might need the advantage Spellcaster or Blessed. Note: the AP\ncost for a profession package does not include these prerequisites.", + "description": "Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites.", "$ref": "./_Prerequisite.schema.json#/$defs/ProfessionPrerequisites" }, "options": { - "description": "In some areas, the profession package grants a loose set of stats where the\nplayer must choose between different options for the profession package.", + "description": "In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package.", "$ref": "#/$defs/ProfessionPackageOptions" }, "special_abilities": { @@ -263,7 +263,7 @@ } }, "combat_techniques": { - "description": "Provides ratings for the combat techniques that the hero receives from the\npackage.", + "description": "Provides ratings for the combat techniques that the hero receives from the package.", "type": "array", "items": { "$ref": "#/$defs/CombatTechniqueRating" @@ -277,14 +277,14 @@ } }, "spells": { - "description": "The skill ratings a magical profession receives for spells; these spells\nare considered activated. Spells from an unfamiliar Tradition, if any, are\nidentified as such.", + "description": "The skill ratings a magical profession receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such.", "type": "array", "items": { "$ref": "#/$defs/SpellRating" } }, "liturgical_chants": { - "description": "Clerical professions receive these liturgical chants at the listed skill\nratings. These liturgical chants are considered activated.", + "description": "Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated.", "type": "array", "items": { "$ref": "#/$defs/LiturgicalChantRating" @@ -329,7 +329,7 @@ "minItems": 1 }, "unsuitable_advantages": { - "description": "These advantages do not fit well with this profession; to be checked with\nthe GM before taking any of them.", + "description": "These advantages do not fit well with this profession; to be checked with the GM before taking any of them.", "type": "array", "items": { "title": "Commonness-rated Advantage/Disadvantage", @@ -348,7 +348,7 @@ "minItems": 1 }, "unsuitable_disadvantages": { - "description": "These disadvantages do not fit well with this profession; to be checked\nwith the GM before taking any of them.", + "description": "These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them.", "type": "array", "items": { "title": "Commonness-rated Advantage/Disadvantage", @@ -367,7 +367,7 @@ "minItems": 1 }, "variants": { - "description": "Provides examples of variants for the profession, which may include changes\nto AP values and additional or modified skill ratings, special abilities,\nor combat techniques, as compared to the basic profession. Usually picking\na variant is optional, but there are some rare exceptions where picking a\nvariant is required.", + "description": "Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required.", "$ref": "#/$defs/ProfessionVariants" } }, @@ -384,7 +384,7 @@ "$ref": "#/$defs/ProfessionName" }, "specification": { - "description": "A name addition of the profession. This will contain texts like name of\nthe academy or the witch circle. It is enclosed in parenthesis, but the\ndatabase entry must not contain parenthesis.", + "description": "A name addition of the profession. This will contain texts like name of the academy or the witch circle. It is enclosed in parenthesis, but the database entry must not contain parenthesis.", "$ref": "#/$defs/ProfessionName" }, "suggested_advantages": { @@ -396,11 +396,11 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "unsuitable_advantages": { - "description": "These advantages do not fit well with this profession; to be checked with\nthe GM before taking any of them.", + "description": "These advantages do not fit well with this profession; to be checked with the GM before taking any of them.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "unsuitable_disadvantages": { - "description": "These disadvantages do not fit well with this profession; to be checked\nwith the GM before taking any of them.", + "description": "These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "errata": { @@ -413,7 +413,7 @@ "additionalProperties": false }, "ProfessionVariants": { - "description": "Provides examples of variants for the profession, which may include changes\nto AP values and additional or modified skill ratings, special abilities, or\ncombat techniques, as compared to the basic profession. Usually picking a\nvariant is optional, but there are some rare exceptions where picking a\nvariant is required.", + "description": "Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required.", "type": "object", "properties": { "is_selection_required": { @@ -449,7 +449,7 @@ "type": "integer" }, "prerequisites": { - "description": "Which prerequisites must be met to buy the stat block? For example, a\ncharacter might need the advantage Spellcaster or Blessed. Note: the AP\ncost for a profession package does not include these prerequisites.", + "description": "Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites.", "$ref": "./_Prerequisite.schema.json#/$defs/ProfessionPrerequisites" }, "options": { @@ -463,7 +463,7 @@ } }, "combat_techniques": { - "description": "Provides ratings for the combat techniques that the hero receives from the\npackage variant.", + "description": "Provides ratings for the combat techniques that the hero receives from the package variant.", "type": "array", "items": { "$ref": "#/$defs/CombatTechniqueRating" @@ -477,14 +477,14 @@ } }, "spells": { - "description": "The skill ratings a magical profession variant receives for spells; these\nspells are considered activated. Spells from an unfamiliar Tradition, if\nany, are identified as such.", + "description": "The skill ratings a magical profession variant receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such.", "type": "array", "items": { "$ref": "#/$defs/SpellRating" } }, "liturgical_chants": { - "description": "Clerical professions receive these liturgical chants at the listed skill\nratings. These liturgical chants are considered activated.", + "description": "Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated.", "type": "array", "items": { "$ref": "#/$defs/LiturgicalChantRating" @@ -598,7 +598,7 @@ "minimum": 1 }, "options": { - "description": "Received select options. Order is important. Typically, you only need the\nfirst array index, though.", + "description": "Received select options. Order is important. Typically, you only need the first array index, though.", "type": "array", "items": { "$ref": "./_IdentifierGroup.schema.json#/$defs/RequirableSelectOptionIdentifier" @@ -655,7 +655,7 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/SpecialAbilityIdentifier" }, "active": { - "description": "if set to `false`, if the selection is granted by the basic package, it\nis removed.", + "description": "if set to `false`, if the selection is granted by the basic package, it is removed.", "const": false }, "level": { @@ -664,7 +664,7 @@ "minimum": 1 }, "options": { - "description": "Received select options. Order is important. Typically, you only need the\nfirst array index, though.", + "description": "Received select options. Order is important. Typically, you only need the first array index, though.", "type": "array", "items": { "$ref": "./_IdentifierGroup.schema.json#/$defs/RequirableSelectOptionIdentifier" @@ -681,7 +681,7 @@ "type": "object", "properties": { "active": { - "description": "if set to `false`, if the selection is granted by the basic package, it\nis removed.", + "description": "if set to `false`, if the selection is granted by the basic package, it is removed.", "const": false }, "options": { @@ -705,7 +705,7 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/CombatTechniqueIdentifier" }, "rating": { - "description": "The rating bonus provided for the combat technique. If used in a profession\nvariant, it can also be used to lower the bonus of the base profession.\n\n**Note:** This is a rating *bonus*, so it will be *added* to the default\nvalue of 6.", + "description": "The rating bonus provided for the combat technique. If used in a profession variant, it can also be used to lower the bonus of the base profession.\n\n**Note:** This is a rating *bonus*, so it will be *added* to the default\nvalue of 6.", "type": "integer", "maximum": 6, "minimum": -6 @@ -725,7 +725,7 @@ "$ref": "./_Identifier.schema.json#/$defs/SkillIdentifier" }, "rating": { - "description": "The rating bonus provided for the skill. If used in a profession variant,\nit can also be used to lower the bonus of the base profession", + "description": "The rating bonus provided for the skill. If used in a profession variant, it can also be used to lower the bonus of the base profession", "type": "integer", "maximum": 8, "minimum": -8 @@ -741,7 +741,7 @@ "type": "object", "properties": { "id": { - "description": "The identifier(s) of the spell(s) to choose from to provide the rating for.\nIf multiple spells are provided, they must all have the same improvement\ncost.", + "description": "The identifier(s) of the spell(s) to choose from to provide the rating for. If multiple spells are provided, they must all have the same improvement cost.", "type": "array", "items": { "$ref": "#/$defs/ProfessionSpellIdentifier" @@ -749,7 +749,7 @@ "minItems": 1 }, "rating": { - "description": "The rating bonus provided for the (selected) spell. If used in a profession\nvariant, it can also be used to lower the bonus of the base profession.", + "description": "The rating bonus provided for the (selected) spell. If used in a profession variant, it can also be used to lower the bonus of the base profession.", "type": "integer", "maximum": 10, "minimum": -10 @@ -805,7 +805,7 @@ "$ref": "./_IdentifierGroup.schema.json#/$defs/SpellworkIdentifier" }, "tradition": { - "description": "If the spell is not part of the magical tradition required by the\npackage, this references the magical tradition it is part of. It can also\nbe used to define the target magical tradition of a spell if multiple\nmagical traditions are required and the spell is available to multiple\nof them.", + "description": "If the spell is not part of the magical tradition required by the package, this references the magical tradition it is part of. It can also be used to define the target magical tradition of a spell if multiple magical traditions are required and the spell is available to multiple of them.", "$ref": "./_SimpleReferences.schema.json#/$defs/MagicalTraditionReference" } }, @@ -831,7 +831,7 @@ "type": "object", "properties": { "id": { - "description": "The identifier(s) of the liturgical chant(s) to choose from to provide\nthe rating for. If multiple liturgical chants are provided, they must all\nhave the same improvement cost.", + "description": "The identifier(s) of the liturgical chant(s) to choose from to provide the rating for. If multiple liturgical chants are provided, they must all have the same improvement cost.", "type": "array", "items": { "$ref": "./_IdentifierGroup.schema.json#/$defs/LiturgyIdentifier" @@ -839,7 +839,7 @@ "minItems": 1 }, "rating": { - "description": "The rating bonus provided for the selected liturgical chant. If used in a\nprofession variant, it can also be used to lower the bonus of the base\nprofession.", + "description": "The rating bonus provided for the selected liturgical chant. If used in a profession variant, it can also be used to lower the bonus of the base profession.", "type": "integer", "maximum": 10, "minimum": -10 @@ -852,7 +852,7 @@ "additionalProperties": false }, "ProfessionPackageOptions": { - "description": "In some areas, the profession package grants a loose set of stats where the\nplayer must choose between different options for the profession package.", + "description": "In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package.", "type": "object", "properties": { "skill_specialization": { @@ -882,7 +882,7 @@ "additionalProperties": false }, "ProfessionVariantPackageOptions": { - "description": "In some areas, the profession package grants a loose set of stats where the\nplayer must choose between different options for the profession package. The\nvariant may override or remove those options.", + "description": "In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. The variant may override or remove those options.", "type": "object", "properties": { "skill_specialization": { @@ -1164,7 +1164,7 @@ "additionalProperties": false }, "SkillSpecializationOptions": { - "description": "Select an application from a skill or from one of a list of skills where you\nget a skill specialization for. You can also specify a skill groups from\nwhich you can choose a skill.", + "description": "Select an application from a skill or from one of a list of skills where you get a skill specialization for. You can also specify a skill groups from which you can choose a skill.", "oneOf": [ { "type": "object", @@ -1242,7 +1242,7 @@ "type": "object", "properties": { "fixed": { - "description": "Specify the number of combat techniques that can be selected so that they\nget increased to a specific CtR. There can be multiple selections with\ndifferent CtRs.", + "description": "Specify the number of combat techniques that can be selected so that they get increased to a specific CtR. There can be multiple selections with different CtRs.", "type": "array", "items": { "$ref": "#/$defs/RatingForCombatTechniquesNumber" @@ -1250,7 +1250,7 @@ "minItems": 1 }, "rest_rating": { - "description": "Define if after the fixed selections the remaining unselected combat\ntechniques will receive a certain rating bonus as well.", + "description": "Define if after the fixed selections the remaining unselected combat techniques will receive a certain rating bonus as well.", "type": "integer", "maximum": 6, "minimum": 1 diff --git a/schema/Property.schema.json b/schema/Property.schema.json index bffde3f6..45a5656d 100644 --- a/schema/Property.schema.json +++ b/schema/Property.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "check": { - "description": "The property check's attributes. Only the properties from the Core Rules\nhave defined property checks.", + "description": "The property check's attributes. Only the properties from the Core Rules have defined property checks.", "$ref": "./_SkillCheck.schema.json#/$defs/SkillCheck" }, "translations": { diff --git a/schema/Race.schema.json b/schema/Race.schema.json index b68ea4f4..ba82848c 100644 --- a/schema/Race.schema.json +++ b/schema/Race.schema.json @@ -23,11 +23,11 @@ "$ref": "#/$defs/BaseValues" }, "attribute_adjustments": { - "description": "Describes how to raise or lower maximum attribute values during character\ncreation.", + "description": "Describes how to raise or lower maximum attribute values during character creation.", "$ref": "#/$defs/AttributeAdjustments" }, "automatic_advantages": { - "description": "A list of automatically applied advantages. This does only work for\nadvantages with no further configuration such as level or special\nselection.", + "description": "A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/AdvantageReference" @@ -77,7 +77,7 @@ "$ref": "#/$defs/RandomWeightGeneration" }, "starting_age": { - "description": "Defines the starting ages for the race. It depends on the selected\nexperience level.", + "description": "Defines the starting ages for the race. It depends on the selected experience level.", "type": "array", "items": { "$ref": "#/$defs/StartingAgeConfigForExperienceLevel" @@ -86,7 +86,7 @@ "maxItems": 7 }, "variants": { - "description": "A list of available race variants where one has to be selected. If no\nvariants are to be selected, a single variant with no name has to be provided\nwhich will be used as the missing values for the base race.", + "description": "A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race.", "$ref": "#/$defs/RaceVariants" }, "src": { @@ -148,7 +148,7 @@ "additionalProperties": false }, "AttributeAdjustments": { - "description": "Describes how to raise or lower maximum attribute values during character\ncreation.", + "description": "Describes how to raise or lower maximum attribute values during character creation.", "type": "object", "properties": { "fixed": { @@ -160,7 +160,7 @@ "minItems": 1 }, "selectable": { - "description": "An array of attribute maximum modifiers, where the attribute they apply to\nis selected from a list of options.\n\nThe array only permits a single entry because no race specified more than\none selectable attribute adjustment so far. But the schema allows for\nmultiple entries to be future-proof.", + "description": "An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options.\n\nThe array only permits a single entry because no race specified more than one selectable attribute adjustment so far. But the schema allows for multiple entries to be future-proof.", "type": "array", "items": { "$ref": "#/$defs/SelectableAttributeAdjustment" @@ -193,7 +193,7 @@ "additionalProperties": false }, "SelectableAttributeAdjustment": { - "description": "A value that will be added to the current maximum of the selected attribute\nthat has been chosen from the listed attributes (negative values will lower\nthe maximum).", + "description": "A value that will be added to the current maximum of the selected attribute that has been chosen from the listed attributes (negative values will lower the maximum).", "type": "object", "properties": { "list": { @@ -252,7 +252,7 @@ "$ref": "./_Dice.schema.json#/$defs/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.", + "description": "The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted.", "$ref": "#/$defs/WeightDiceOffsetStrategy" } }, @@ -264,7 +264,7 @@ "additionalProperties": false }, "WeightDiceOffsetStrategy": { - "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.", + "description": "The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted.", "oneOf": [ { "const": "Add" @@ -290,7 +290,7 @@ "minimum": 1 }, "random": { - "description": "The random value for the selected experience level. It is going to be\nadded to the base value.", + "description": "The random value for the selected experience level. It is going to be added to the base value.", "$ref": "./_Dice.schema.json#/$defs/Dice" } }, @@ -302,7 +302,7 @@ "additionalProperties": false }, "RaceVariants": { - "description": "A list of available race variants where one has to be selected. If no\nvariants are to be selected, a single variant with no name has to be provided\nwhich will be used as the missing values for the base race.", + "description": "A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race.", "type": "array", "items": { "$ref": "#/$defs/RaceVariant" @@ -403,7 +403,7 @@ "minItems": 1 }, "hair_color": { - "description": "An array containing 20 (numeric) hair color identifiers. The array also\nrepresents the 20-sided die for a random hair color.", + "description": "An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/HairColorReference" @@ -412,7 +412,7 @@ "maxItems": 20 }, "eye_color": { - "description": "An array containing 20 (numeric) eye color identifiers. The array also\nrepresents the 20-sided die for a random eye color.", + "description": "An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/EyeColorReference" @@ -474,7 +474,7 @@ "type": "object", "properties": { "name": { - "description": "The race variant's name. If left empty, it defaults to the base race name.\nThis can be used if the race has no (visible) variants so that a single\nvariant has to be provided.", + "description": "The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "common_advantages": { @@ -517,7 +517,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "strongly_recommended_disadvantages": { - "description": "The respective strongly recommended disadvantages text from the source\nbook.", + "description": "The respective strongly recommended disadvantages text from the source book.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "errata": { diff --git a/schema/Ritual.schema.json b/schema/Ritual.schema.json index d8a20219..48c3bed8 100644 --- a/schema/Ritual.schema.json +++ b/schema/Ritual.schema.json @@ -33,7 +33,7 @@ "$ref": "./_SimpleReferences.schema.json#/$defs/PropertyReference" }, "traditions": { - "description": "The tradition(s) the ritual is available for. It may be *generally*\navailable to all traditions or it may be only familiar in specific\ntraditions.", + "description": "The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions.", "$ref": "./_Spellwork.schema.json#/$defs/Traditions" }, "improvement_cost": { @@ -83,7 +83,7 @@ "minLength": 1 }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "./_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/SexPractice.schema.json b/schema/SexPractice.schema.json index 495eff8a..c2f7559a 100644 --- a/schema/SexPractice.schema.json +++ b/schema/SexPractice.schema.json @@ -50,7 +50,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "prerequisites": { - "description": "Prerequisites of participants and environment. Do not specify if the\nsex practice has no prerequisites.", + "description": "Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "failed": { diff --git a/schema/Skill.schema.json b/schema/Skill.schema.json index 67b29db5..8b8aa4bd 100644 --- a/schema/Skill.schema.json +++ b/schema/Skill.schema.json @@ -17,7 +17,7 @@ "$ref": "./_SkillCheck.schema.json#/$defs/SkillCheck" }, "applications": { - "description": "Lists applications for the skill, if any. This does not necessarily include\nall possible applications. There may also be new applications that could be\npurchased via certain advantages or special abilities.", + "description": "Lists applications for the skill, if any. This does not necessarily include all possible applications. There may also be new applications that could be purchased via certain advantages or special abilities.", "$ref": "#/$defs/Applications" }, "encumbrance": { @@ -67,15 +67,15 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "applications_input_label": { - "description": "If there are options available that can not be put into a selection\nlist (like different cults), provide the label text for the input\nelement here. Otherwise leave empty.", + "description": "If there are options available that can not be put into a selection list (like different cults), provide the label text for the input element here. Otherwise leave empty.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "encumbrance_description": { - "description": "The text listing the certain circumstances in which the encumbrance may\ncount. This text must be used if `encumbrance` is set to `\"Maybe\"`,\notherwise it is ignored if defined.", + "description": "The text listing the certain circumstances in which the encumbrance may count. This text must be used if `encumbrance` is set to `\"Maybe\"`, otherwise it is ignored if defined.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "tools": { - "description": "Mentions any tools from the equipment list that are necessary to employ\nthe skill.", + "description": "Mentions any tools from the equipment list that are necessary to employ the skill.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "quality": { @@ -108,7 +108,7 @@ "additionalProperties": false }, "ApplicationCategory": { - "description": "A category. All available entries from the specified category will be\nincluded as separate applications.", + "description": "A category. All available entries from the specified category will be included as separate applications.", "oneOf": [ { "const": "BlessedTraditions" diff --git a/schema/SkillModificationLevel.schema.json b/schema/SkillModificationLevel.schema.json index d00c23c9..c8b08af3 100644 --- a/schema/SkillModificationLevel.schema.json +++ b/schema/SkillModificationLevel.schema.json @@ -124,11 +124,11 @@ "type": "object", "properties": { "fast": { - "description": "Configuration for this level for fast skills (spells, liturgical chants).\nValues set here override the default generated text.", + "description": "Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text.", "$ref": "#/$defs/LevelTypeConfigTranslation" }, "slow": { - "description": "Configuration for this level for slow skills (rituals, ceremonies). Values\nset here override the default generated text.", + "description": "Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text.", "$ref": "#/$defs/LevelTypeConfigTranslation" } }, @@ -137,7 +137,7 @@ "additionalProperties": false }, "LevelTypeConfigTranslation": { - "description": "Configuration translation of a type for a level. Values set here override the\ndefault generated text.", + "description": "Configuration translation of a type for a level. Values set here override the default generated text.", "type": "object", "properties": { "range": { diff --git a/schema/Spell.schema.json b/schema/Spell.schema.json index e55af0f7..331b7611 100644 --- a/schema/Spell.schema.json +++ b/schema/Spell.schema.json @@ -33,7 +33,7 @@ "$ref": "./_SimpleReferences.schema.json#/$defs/PropertyReference" }, "traditions": { - "description": "The tradition(s) the spell is available for. It may be *generally*\navailable to all traditions or it may be only familiar in specific\ntraditions.", + "description": "The tradition(s) the spell is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions.", "$ref": "./_Spellwork.schema.json#/$defs/Traditions" }, "improvement_cost": { @@ -82,7 +82,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "./_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/_Activatable.schema.json b/schema/_Activatable.schema.json index e00b86e1..3648b861 100644 --- a/schema/_Activatable.schema.json +++ b/schema/_Activatable.schema.json @@ -13,7 +13,7 @@ "minLength": 1 }, "NameInLibrary": { - "description": "The full name of the entry as stated in the sources. Only use when `name`\nneeds to be different from full name for text generation purposes.", + "description": "The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes.", "type": "string", "minLength": 1 }, @@ -23,20 +23,20 @@ "minimum": 2 }, "Maximum": { - "description": "The number stating how often you can buy the entry. The **default** depends on\nthe entry type:\n\n- **Advantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Disadvantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Special Abilities:** `1` if no options can be selected, otherwise the\n number of possible options\n\nThe maximum is only set if it differs from the defaults specified above.", + "description": "The number stating how often you can buy the entry. The **default** depends on the entry type:\n\n- **Advantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Disadvantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Special Abilities:** `1` if no options can be selected, otherwise the\n number of possible options\n\nThe maximum is only set if it differs from the defaults specified above.", "type": "integer", "minimum": 1 }, "SelectOptions": { - "description": "Definitions for possible options for the activatable entry. They can either\nbe derived from entry categories or be defined explicitly. Both can happen as\nwell, but if there is an explicitly defined select option and a derived\nselect option has the same identifier (which may only happen if skill or\ncombat technique identifiers are used for explicit select options), the\nexplicit definition overwrites the derived option.\n\nNote that this is only a full definition of options for simple logic that can\nbe made explicit using the more detailed configuration for both derived\ncategories and explicit options. There are quite a few entries whose option\nlogic cannot be fully represented here, so that it needs to be implemented\nmanually.", + "description": "Definitions for possible options for the activatable entry. They can either be derived from entry categories or be defined explicitly. Both can happen as well, but if there is an explicitly defined select option and a derived select option has the same identifier (which may only happen if skill or combat technique identifiers are used for explicit select options), the explicit definition overwrites the derived option.\n\nNote that this is only a full definition of options for simple logic that can be made explicit using the more detailed configuration for both derived categories and explicit options. There are quite a few entries whose option logic cannot be fully represented here, so that it needs to be implemented manually.", "type": "object", "properties": { "derived": { - "description": "An entry category with optional further configuration. All available\nentries from the specified categories will be included as separate select\noptions. You can also specify a set of groups that should only be\nincluded. Groups not mentioned will be excluded then.", + "description": "An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then.", "$ref": "./_ActivatableSelectOptionCategory.schema.json#/$defs/SelectOptionCategory" }, "explicit": { - "description": "A list of explicit select options. If the identifier has a specific type,\nits entry is the base of this select option, where values defined here\noverride values from the base. Define the `src` property if the options\nare not derived from the rules text of the advantage/disadvantage/special\nability but instead are listed in a separate block and/or on a separate\npage.", + "description": "A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the `src` property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page.", "type": "array", "items": { "$ref": "#/$defs/ExplicitSelectOption" @@ -109,22 +109,22 @@ "minimum": 1 }, "profession_only": { - "description": "Sometimes, professions use specific text selections that are not\ncontained in described lists. This ensures you can use them for\nprofessions only. They are not going to be displayed as options to the\nuser.", + "description": "Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user.", "const": true }, "skill_applications": { - "description": "Registers new applications, which get enabled once this entry is\nactivated with its respective select option. It specifies an entry-unique\nidentifier and the skill it belongs to. A translation can be left out if\nits name equals the name of the origin select option.", + "description": "Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.", "$ref": "#/$defs/SkillApplications" }, "skill_uses": { - "description": "Registers uses, which get enabled once this entry is activated with its\nrespective select option. It specifies an entry-unique identifier and the\nskill it belongs to. A translation can be left out if its name equals the\nname of the origin select option.", + "description": "Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.", "$ref": "#/$defs/SkillUses" }, "prerequisites": { "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites" }, "binding_cost": { - "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.", + "description": "Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.", "type": "integer", "minimum": 0 }, @@ -163,12 +163,12 @@ "minLength": 1 }, "name_in_profession": { - "description": "The name of the select option when displayed in a generated\nprofession text.", + "description": "The name of the select option when displayed in a generated profession text.", "type": "string", "minLength": 1 }, "description": { - "description": "The description of the select option. Useful for Bad Habits, Trade\nSecrets and other entries where a description is available.", + "description": "The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available.", "type": "string", "minLength": 1 }, @@ -189,7 +189,7 @@ "$ref": "./_Identifier.schema.json#/$defs/SkillIdentifier" }, "skill_applications": { - "description": "Registers new applications, which get enabled once this entry is\nactivated with its respective select option. It specifies an entry-unique\nidentifier and the skill it belongs to. A translation can be left out if\nits name equals the name of the origin select option.", + "description": "Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.", "type": "array", "items": { "$ref": "./_ActivatableSelectOptionCategory.schema.json#/$defs/SkillApplicationOrUse" @@ -197,7 +197,7 @@ "minItems": 1 }, "skill_uses": { - "description": "Registers uses, which get enabled once this entry is activated with its\nrespective select option. It specifies an entry-unique identifier and the\nskill it belongs to. A translation can be left out if its name equals the\nname of the origin select option.", + "description": "Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.", "type": "array", "items": { "$ref": "./_ActivatableSelectOptionCategory.schema.json#/$defs/SkillApplicationOrUse" @@ -208,7 +208,7 @@ "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites" }, "binding_cost": { - "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.", + "description": "Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.", "type": "integer", "minimum": 0 }, @@ -259,7 +259,7 @@ "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites" }, "binding_cost": { - "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.", + "description": "Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.", "type": "integer", "minimum": 0 }, @@ -322,7 +322,7 @@ ] }, "CombatSpecialAbilityType": { - "description": "The definition of if the combat special ability can be used when armed or\nwhen unarmed.", + "description": "The definition of if the combat special ability can be used when armed or when unarmed.", "oneOf": [ { "const": "Armed" @@ -333,7 +333,7 @@ ] }, "SkillApplications": { - "description": "Registers new skill applications, which get enabled once this entry is\nactivated. It specifies an entry-unique identifier and the skill it belongs\nto. A translation can be left out if its name equals the name of the origin\nactivatable entry.", + "description": "Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.", "type": "array", "items": { "$ref": "#/$defs/SkillApplication" @@ -418,7 +418,7 @@ "minItems": 2 }, "required_skill_rating": { - "description": "If an application applies to multiple skills, it may need to ensure the\nrespective skill is on a certain skill rating if the activatable entry\ncannot ensure this prerequisite.", + "description": "If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite.", "type": "integer", "minimum": 1 } @@ -442,7 +442,7 @@ "additionalProperties": false }, "SkillUses": { - "description": "Registers uses, which get enabled once this entry is activated. It specifies\nan entry-unique identifier and the skill it belongs to. A translation can be\nleft out if its name equals the name of the origin activatable entry.", + "description": "Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.", "type": "array", "items": { "$ref": "#/$defs/SkillUse" @@ -827,7 +827,7 @@ "type": "object", "properties": { "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.", + "description": "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.", "type": "array", "items": { "$ref": "#/$defs/PenaltyByLevelLevel" @@ -835,7 +835,7 @@ "minItems": 2 }, "external": { - "description": "The combat-related special ability of which the level defines the penalty\ninstead.", + "description": "The combat-related special ability of which the level defines the penalty instead.", "$ref": "#/$defs/PenaltyByExternalLevel" } }, @@ -858,11 +858,11 @@ "additionalProperties": false }, "PenaltyByExternalLevel": { - "description": "The combat-related special ability of which the level defines the penalty\ninstead.", + "description": "The combat-related special ability of which the level defines the penalty instead.", "type": "object", "properties": { "id": { - "description": "The identifier of the combat-related special ability of which the level\ndefines the penalty instead.", + "description": "The identifier of the combat-related special ability of which the level defines the penalty instead.", "$ref": "./_IdentifierGroup.schema.json#/$defs/CombatRelatedSpecialAbilityIdentifier" } }, @@ -875,7 +875,7 @@ "type": "object", "properties": { "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.", + "description": "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.", "type": "array", "items": { "$ref": "#/$defs/PenaltyByAttackOrderItem" @@ -1086,7 +1086,7 @@ "$ref": "./_ActivatableSkillDuration.schema.json#/$defs/DurationUnitValue" }, "per_level": { - "description": "The AE cost are per level of the enchantment. It may either be displayed\nin a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1\nAE for level I; 2 AE for level II`).", + "description": "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`).", "$ref": "#/$defs/FixedArcaneEnergyCostPerLevel" }, "translations": { @@ -1107,7 +1107,7 @@ "additionalProperties": false }, "FixedArcaneEnergyCostPerLevel": { - "description": "The AE cost are per level of the enchantment. It may either be displayed\nin a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1\nAE for level I; 2 AE for level II`).", + "description": "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`).", "oneOf": [ { "const": "Compressed" @@ -1138,7 +1138,7 @@ "minimum": 1 }, "base_value": { - "description": "If defined, in addition to the cost per entity you have to pay a flat\namount, regardless of the entity count.", + "description": "If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count.", "type": "integer", "minimum": 1 }, @@ -1164,7 +1164,7 @@ "type": "object", "properties": { "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 AE per\nperson`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 AE per person`.", "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveText" }, "note": { @@ -1200,7 +1200,7 @@ "type": "object", "properties": { "value": { - "description": "The AE cost value that has to be payed for activation. Half of this value\nhas to be payed each interval.", + "description": "The AE cost value that has to be payed for activation. Half of this value has to be payed each interval.", "type": "integer", "minimum": 2, "multipleOf": 2 @@ -1220,7 +1220,7 @@ "type": "object", "properties": { "modifier": { - "description": "Specified if the indefinite AP cost description needs to be modified by a\ncertain value.", + "description": "Specified if the indefinite AP cost description needs to be modified by a certain value.", "$ref": "#/$defs/IndefiniteArcaneEnergyCostModifier" }, "translations": { @@ -1279,7 +1279,7 @@ "type": "object", "properties": { "interval": { - "description": "Specified if the selected AE cost option has to be paid for each time\ninterval.", + "description": "Specified if the selected AE cost option has to be paid for each time interval.", "$ref": "#/$defs/ArcaneEnergyCostDisjunctionInterval" }, "options": { @@ -1308,7 +1308,7 @@ "minimum": 1 }, "after_activation": { - "description": "Set to `true` if the action where the enchantment is casted does\n**not** as a part of the first interval that has to be payed, so that\nthe first interval payment needs to be done after the activation.\n\nThis works different than other sustained spells, since for them the\nend of the cast usually already counts as part of the first interval.", + "description": "Set to `true` if the action where the enchantment is casted does\n**not** as a part of the first interval that has to be payed, so that\nthe first interval payment needs to be done after the activation.\n\nThis works different than other sustained spells, since for them the end of the cast usually already counts as part of the first interval.", "type": "boolean" } }, @@ -1503,7 +1503,7 @@ "type": "object", "properties": { "list": { - "description": "The volume points for each level. The first element is the volume points\nfor the first level, the second element is the volume points for the\nsecond level, and so on.", + "description": "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.", "type": "array", "items": { "$ref": "#/$defs/VolumeByLevelItem" @@ -1531,7 +1531,7 @@ "additionalProperties": false }, "VolumeMap": { - "description": "A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead /\nFairies, Ghosts / Demons, Elementals` may be respresented as the following\nmap:\n\n```yaml\noptions:\n - points: 3\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Chimera, Daimonid, Golems, Undead\"\n label_standalone: \"Chimera/Daimonid/Golems/Undead\"\n - points: 4\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Fairies, Ghosts\"\n label_standalone: \"Fairies/Ghosts\"\n - points: 5\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Demons, Elementals\"\n label_standalone: \"Demons/Elementals\"\n```\n\nThis will generate the exact same string as seen above. The associated\noptions are not present in the example, but they link to the options the\nvolume specification is meant for.", + "description": "A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead / Fairies, Ghosts / Demons, Elementals` may be respresented as the following map:\n\n```yaml\noptions:\n - points: 3\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Chimera, Daimonid, Golems, Undead\"\n label_standalone: \"Chimera/Daimonid/Golems/Undead\"\n - points: 4\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Fairies, Ghosts\"\n label_standalone: \"Fairies/Ghosts\"\n - points: 5\n associated_options:\n - id:\n tag: General\n value: # ...\n # ...\n translations:\n en-US:\n label: \"Demons, Elementals\"\n label_standalone: \"Demons/Elementals\"\n```\n\nThis 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.", "type": "object", "properties": { "options": { @@ -1571,7 +1571,7 @@ "type": "string" }, "replacement": { - "description": "If the string from the book cannot be generated using the default\ngeneration technique, use this string. All options still need to be\ninserted propertly, since it may be used by in-game tools to provide a\nselection to players.", + "description": "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.", "type": "string" } }, @@ -1633,7 +1633,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "label_standalone": { - "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.", + "description": "The description of the option if used standalone. Only used if different from `label`.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -1729,7 +1729,7 @@ "type": "object", "properties": { "permanent_value": { - "description": "The permanent AE cost.\n\nIf the enchantment has multiple levels, it is only applied for the first\nlevel.", + "description": "The permanent AE cost.\n\nIf the enchantment has multiple levels, it is only applied for the first level.", "type": "integer", "minimum": 1 } @@ -1754,7 +1754,7 @@ "additionalProperties": false }, "BindingCostMap": { - "description": "A content that is `2/4/8 permanent AE for spell-swords with the combat\ntechnique Daggers, Swords, or Two-Handed Swords` may be respresented as the\nfollowing map:\n\n```yaml\noptions:\n - permanent_value: 2\n translations:\n en-US:\n label: \"Daggers\"\n label_standalone: \"Dagger\"\n - permanent_value: 4\n translations:\n en-US:\n label: \"Swords\"\n label_standalone: \"Sword\"\n - permanent_value: 8\n translations:\n en-US:\n label: \"Two-Handed Swords\"\n label_standalone: \"Two-Handed Sword\"\nlist_prepend: \"spell-swords with the combat technique\"\n```\n\nThis will generate the exact same string as seen above.", + "description": "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:\n\n```yaml\noptions:\n - permanent_value: 2\n translations:\n en-US:\n label: \"Daggers\"\n label_standalone: \"Dagger\"\n - permanent_value: 4\n translations:\n en-US:\n label: \"Swords\"\n label_standalone: \"Sword\"\n - permanent_value: 8\n translations:\n en-US:\n label: \"Two-Handed Swords\"\n label_standalone: \"Two-Handed Sword\"\nlist_prepend: \"spell-swords with the combat technique\"\n```\n\nThis will generate the exact same string as seen above.", "type": "object", "properties": { "options": { @@ -1794,7 +1794,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "replacement": { - "description": "If the string from the book cannot be generated using the default\ngeneration technique, use this string. All options still need to be\ninserted propertly, since it may be used by in-game tools to provide a\nselection to players.", + "description": "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.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -1835,7 +1835,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "label_standalone": { - "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.", + "description": "The description of the option if used standalone. Only used if different from `label`.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -1859,7 +1859,7 @@ "additionalProperties": false }, "PropertyDeclaration": { - "description": "The magic property's identifier. `DependingOnProperty` can only be used if\nthe special ability has an option to select a property.", + "description": "The magic property's identifier. `DependingOnProperty` can only be used if the special ability has an option to select a property.", "oneOf": [ { "type": "object", @@ -1909,7 +1909,7 @@ "$ref": "./_Identifier.schema.json#/$defs/PatronIdentifier" }, "PrerequisitesReplacement": { - "description": "The prerequisites text. It is only used if the text cannot be generated from\nthe given information.", + "description": "The prerequisites text. It is only used if the text cannot be generated from the given information.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "ApplicableCombatTechniques": { @@ -2692,11 +2692,11 @@ ] }, "FixedAdventurePointsValue": { - "description": "A fixed adventure points value. If the entry has levels, this is the cost per\nlevel as well.", + "description": "A fixed adventure points value. If the entry has levels, this is the cost per level as well.", "$ref": "#/$defs/AdventurePointsSingleValue" }, "AdventurePointsValueByLevel": { - "description": "An entry with levels may have different costs for each level. The length of\nthe list must match the amount of levels the special ability has.", + "description": "An entry with levels may have different costs for each level. The length of the list must match the amount of levels the special ability has.", "type": "array", "items": { "$ref": "#/$defs/AdventurePointsSingleValue" @@ -2704,7 +2704,7 @@ "minItems": 2 }, "AdventurePointsDerivedFromSelection": { - "description": "The adventure points value is derived from the selection of the special\nability. Its display value may be able to be derived from the given\ninformation for the select options. If that is not the case or the generated\ntext would not match the original one, a replacement text can be provided.", + "description": "The adventure points value is derived from the selection of the special ability. Its display value may be able to be derived from the given information for the select options. If that is not the case or the generated text would not match the original one, a replacement text can be provided.", "type": "object", "properties": { "translations": { @@ -2726,7 +2726,7 @@ "type": "object", "properties": { "replacement": { - "description": "A replacement for the generated text if it would not match the original\none.", + "description": "A replacement for the generated text if it would not match the original one.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } }, @@ -2744,11 +2744,11 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "AdventurePointsValueReplacement": { - "description": "The AP value. It is only used if the text cannot be generated from the given\ninformation.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "AdventurePointsValueAppend": { - "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text is\nreplaced.", + "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } } diff --git a/schema/_ActivatableSelectOptionCategory.schema.json b/schema/_ActivatableSelectOptionCategory.schema.json index 343e9bb2..6add488b 100644 --- a/schema/_ActivatableSelectOptionCategory.schema.json +++ b/schema/_ActivatableSelectOptionCategory.schema.json @@ -379,7 +379,7 @@ "type": "object", "properties": { "require_principles": { - "description": "Should the principles (code) of the tradition be required to select the\nrespective tradition?", + "description": "Should the principles (code) of the tradition be required to select the respective tradition?", "const": true } }, @@ -410,7 +410,7 @@ "const": true }, "require_minimum_spellworks_on": { - "description": "Require a minimum number of spellworks of the respective property to be\non a minimum skill rating.", + "description": "Require a minimum number of spellworks of the respective property to be on a minimum skill rating.", "$ref": "#/$defs/RequiredMinimumSkillsToBeOnSkillRating" } }, @@ -425,11 +425,11 @@ "const": true }, "use_master_of_suffix_as_name": { - "description": "The generated name should be the *Master of (Aspect)* suffix for this\naspect instead of the aspect's name. If an aspect does not provide a\nsuffix (such as the General aspect), it is automatically excluded from\nthe list.", + "description": "The generated name should be the *Master of (Aspect)* suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list.", "const": true }, "require_minimum_liturgies_on": { - "description": "Require a minimum number of liturgies of the respective aspect to be on a\nminimum skill rating.", + "description": "Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating.", "$ref": "#/$defs/RequiredMinimumSkillsToBeOnSkillRating" } }, @@ -437,16 +437,16 @@ "additionalProperties": false }, "RequiredMinimumSkillsToBeOnSkillRating": { - "description": "Require a minimum number of spellworks/liturgies of the respective\nproperty/aspect to be on a minimum skill rating.", + "description": "Require a minimum number of spellworks/liturgies of the respective property/aspect to be on a minimum skill rating.", "type": "object", "properties": { "number": { - "description": "The minimum number of liturgies that need to be on the defined minimum\nskill rating.", + "description": "The minimum number of liturgies that need to be on the defined minimum skill rating.", "type": "integer", "minimum": 1 }, "rating": { - "description": "The minimum skill rating the defined minimum number of liturgies need\nto be on.", + "description": "The minimum skill rating the defined minimum number of liturgies need to be on.", "type": "integer", "minimum": 1 } @@ -561,7 +561,7 @@ } }, "default": { - "description": "The default value of an entry. Used as a fallback if no value is\nfound in `list`.", + "description": "The default value of an entry. Used as a fallback if no value is found in `list`.", "type": "integer", "minimum": 1 } @@ -841,7 +841,7 @@ "additionalProperties": false }, "skill_applications": { - "description": "Registers new applications, which get enabled once this entry is\nactivated with its respective select option. It specifies an\nentry-unique identifier, the skill it belongs to is derived from the\nselect option automatically. A translation can be left out if its\nname equals the name of the origin entry.", + "description": "Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry.", "type": "array", "items": { "$ref": "#/$defs/SkillApplicationOrUse" @@ -849,7 +849,7 @@ "minItems": 1 }, "skill_uses": { - "description": "Registers uses, which get enabled once this entry is activated with\nits respective select option. It specifies an entry-unique\nidentifier, the skill it belongs to is derived from the select option\nautomatically. A translation can be left out if its name equals the\nname of the origin entry.", + "description": "Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry.", "type": "array", "items": { "$ref": "#/$defs/SkillApplicationOrUse" @@ -915,7 +915,7 @@ } }, "default": { - "description": "The default value of an entry. Used as a fallback if no value is\nfound in `list`.", + "description": "The default value of an entry. Used as a fallback if no value is found in `list`.", "type": "integer", "minimum": 1 } @@ -1001,7 +1001,7 @@ } }, "default": { - "description": "The default value of an entry. Used as a fallback if no value is\nfound in `list`.", + "description": "The default value of an entry. Used as a fallback if no value is found in `list`.", "type": "integer", "minimum": 1 } @@ -1160,7 +1160,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the application or use if different from the activatable\nentry's name.", + "description": "The name of the application or use if different from the activatable entry's name.", "type": "string", "minLength": 1 } diff --git a/schema/_ActivatableSkillCastingTime.schema.json b/schema/_ActivatableSkillCastingTime.schema.json index 3fed55d6..b60102fa 100644 --- a/schema/_ActivatableSkillCastingTime.schema.json +++ b/schema/_ActivatableSkillCastingTime.schema.json @@ -18,7 +18,7 @@ "additionalProperties": false }, "CastingTimeDuringLovemaking": { - "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only use\nan activatable skill during lovemaking if it has a casting time used during\nlovemaking.", + "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking.", "type": "object", "properties": { "value": { @@ -80,7 +80,7 @@ "additionalProperties": false }, "FastCastingTime": { - "description": "The casting time may have two different values: One for use in “normal” time,\ni. e. actions, combat rounds and others, and one for use during lovemaking,\nwhich is a rule set from Aventurian Intimacy.\n\nThere must always be at least one casting time value.", + "description": "The casting time may have two different values: One for use in “normal” time, i. e. actions, combat rounds and others, and one for use during lovemaking, which is a rule set from Aventurian Intimacy.\n\nThere must always be at least one casting time value.", "type": "object", "properties": { "default": { @@ -120,7 +120,7 @@ ] }, "during_lovemaking": { - "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only\nuse an activatable skill during lovemaking if it has a casting time used\nduring lovemaking.", + "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking.", "$ref": "#/$defs/CastingTimeDuringLovemaking" } }, @@ -129,7 +129,7 @@ "additionalProperties": false }, "SlowCastingTime": { - "description": "The casting time may have two different values: One for use in “normal” time,\ni. e. actions, combat rounds and others, and one for use during lovemaking,\nwhich is a rule set from Aventurian Intimacy.\n\nThere must always be at least one casting time value.", + "description": "The casting time may have two different values: One for use in “normal” time, i. e. actions, combat rounds and others, and one for use during lovemaking, which is a rule set from Aventurian Intimacy.\n\nThere must always be at least one casting time value.", "type": "object", "properties": { "default": { @@ -169,7 +169,7 @@ ] }, "during_lovemaking": { - "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only\nuse an activatable skill during lovemaking if it has a casting time used\nduring lovemaking.", + "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking.", "$ref": "#/$defs/CastingTimeDuringLovemaking" } }, diff --git a/schema/_ActivatableSkillCost.schema.json b/schema/_ActivatableSkillCost.schema.json index c301114c..44a6f2be 100644 --- a/schema/_ActivatableSkillCost.schema.json +++ b/schema/_ActivatableSkillCost.schema.json @@ -191,7 +191,7 @@ "minimum": 1 }, "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 KP per\nperson`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 KP per person`.", "$ref": "#/$defs/NonModifiableOneTimeCostPerCountable" }, "translations": { @@ -215,7 +215,7 @@ "type": "object", "properties": { "minimum_total": { - "description": "If defined, the minimum total AE that have to be spent casting the\nskill.", + "description": "If defined, the minimum total AE that have to be spent casting the skill.", "type": "number" }, "translations": { @@ -295,7 +295,7 @@ "additionalProperties": false }, "CostMap": { - "description": "A content that is `2/4/8/16 AE for an item the size of a\ncup/chest/door/castle gate` may be respresented as the following map:\n\n```yaml\noptions:\n - value: 2\n label: \"cup\"\n - value: 4\n label: \"chest\"\n - value: 8\n label: \"door\"\n - value: 16\n label: \"castle gate\"\nfor_append: \"an item the size of a\"\n```\n\nThis will generate the exact same string as seen above – given it is set\nfor a spellwork and thus `AE` is used.", + "description": "A content that is `2/4/8/16 AE for an item the size of a cup/chest/door/castle gate` may be respresented as the following map:\n\n```yaml\noptions:\n - value: 2\n label: \"cup\"\n - value: 4\n label: \"chest\"\n - value: 8\n label: \"door\"\n - value: 16\n label: \"castle gate\"\nfor_append: \"an item the size of a\"\n```\n\nThis will generate the exact same string as seen above – given it is set for a spellwork and thus `AE` is used.", "type": "object", "properties": { "options": { @@ -361,7 +361,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "label_standalone": { - "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.", + "description": "The description of the option if used standalone. Only used if different from `label`.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -382,7 +382,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "replacement": { - "description": "If the string from the book cannot be generated using the default\ngeneration technique, use this string. All options still need to be\ninserted propertly, since it may be used by in-game tools to provide a\nselection to players.", + "description": "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.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -458,7 +458,7 @@ "minimum": 1 }, "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 KP per\nperson per 5 minutes`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`.", "$ref": "#/$defs/NonModifiableSustainedCostPerCountable" }, "interval": { @@ -476,7 +476,7 @@ "type": "object", "properties": { "minimum_total": { - "description": "If defined, the minimum total AE that have to be spent casting the\nskill.", + "description": "If defined, the minimum total AE that have to be spent casting the skill.", "type": "number" }, "translations": { diff --git a/schema/_ActivatableSkillEffect.schema.json b/schema/_ActivatableSkillEffect.schema.json index 11a2c652..27a3a889 100644 --- a/schema/_ActivatableSkillEffect.schema.json +++ b/schema/_ActivatableSkillEffect.schema.json @@ -3,7 +3,7 @@ "$id": "/_ActivatableSkillEffect.schema.json", "$defs": { "ActivatableSkillEffect": { - "description": "The effect description may be either a plain text or a text that is divided\nby a list of effects for each quality level. It may also be a list for each\ntwo quality levels.", + "description": "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.", "oneOf": [ { "type": "object", @@ -72,18 +72,18 @@ "type": "object", "properties": { "text_before": { - "description": "The effect description before the list of effects for each quality\nlevel.", + "description": "The effect description before the list of effects for each quality level.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "quality_levels": { - "description": "The list of effects for each quality level. The first element\nrepresents QL 1, the second element QL 2, and so on.", + "description": "The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on.", "type": "array", "items": { "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } }, "text_after": { - "description": "The effect description after the list of effects for each quality\nlevel.", + "description": "The effect description after the list of effects for each quality level.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } }, @@ -97,18 +97,18 @@ "type": "object", "properties": { "text_before": { - "description": "The effect description before the list of effects for each quality\nlevel.", + "description": "The effect description before the list of effects for each quality level.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "quality_levels": { - "description": "The list of effects for each two quality levels. The first element\nrepresents QL 1–2, the second element QL 3–4 and the third element QL\n5–6.", + "description": "The list of effects for each two quality levels. The first element represents QL 1–2, the second element QL 3–4 and the third element QL 5–6.", "type": "array", "items": { "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } }, "text_after": { - "description": "The effect description after the list of effects for each quality\nlevel.", + "description": "The effect description after the list of effects for each quality level.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" } }, diff --git a/schema/_ActivatableSkillRange.schema.json b/schema/_ActivatableSkillRange.schema.json index 461a749b..74313890 100644 --- a/schema/_ActivatableSkillRange.schema.json +++ b/schema/_ActivatableSkillRange.schema.json @@ -238,11 +238,11 @@ "type": "object", "properties": { "note": { - "description": "A note, appended to the generated string in parenthesis. If the\ngenerated is modified using `replacement`, the note is appended to\nthe modifier string.", + "description": "A note, appended to the generated string in parenthesis. If the generated is modified using `replacement`, the note is appended to the modifier string.", "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextOptional" }, "replacement": { - "description": "A replacement string. If `note` is provided, it is appended to the\nreplaced string.", + "description": "A replacement string. If `note` is provided, it is appended to the replaced string.", "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextReplace" } }, diff --git a/schema/_ActivatableSkillTargetCategory.schema.json b/schema/_ActivatableSkillTargetCategory.schema.json index 2de4796a..dcb8803a 100644 --- a/schema/_ActivatableSkillTargetCategory.schema.json +++ b/schema/_ActivatableSkillTargetCategory.schema.json @@ -3,7 +3,7 @@ "$id": "/_ActivatableSkillTargetCategory.schema.json", "$defs": { "AffectedTargetCategories": { - "description": "The target category – the kind of creature or object – the skill affects.\n\nIf no target categories are given, the skill applies to all target\ncategories.", + "description": "The target category – the kind of creature or object – the skill affects.\n\nIf no target categories are given, the skill applies to all target categories.", "type": "array", "items": { "$ref": "#/$defs/SpecificAffectedTargetCategory" diff --git a/schema/_Blessed.schema.json b/schema/_Blessed.schema.json index 47d238ee..e429055f 100644 --- a/schema/_Blessed.schema.json +++ b/schema/_Blessed.schema.json @@ -46,7 +46,7 @@ "$ref": "./_SimpleReferences.schema.json#/$defs/BlessedTraditionReference" }, "aspects": { - "description": "The aspect(s) from the tradition the ceremony belongs to. Note that not\nall traditions have aspects. Traditions with aspects must have at least one\naspect specified.", + "description": "The aspect(s) from the tradition the ceremony belongs to. Note that not all traditions have aspects. Traditions with aspects must have at least one aspect specified.", "type": "array", "items": { "$ref": "./_SimpleReferences.schema.json#/$defs/AspectReference" diff --git a/schema/_DiseasePoison.schema.json b/schema/_DiseasePoison.schema.json index c42ef527..703ed532 100644 --- a/schema/_DiseasePoison.schema.json +++ b/schema/_DiseasePoison.schema.json @@ -3,7 +3,7 @@ "$id": "/_DiseasePoison.schema.json", "$defs": { "Resistance": { - "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the\ndisease roll. It may also happen that the lower of both is applied as a\npenalty.", + "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty.", "oneOf": [ { "const": "Spirit" @@ -17,7 +17,7 @@ ] }, "Cause": { - "description": "What causes the disease? The GM rolls 1D20 to see if a character gets\ninfected. If the infection check succeeds, the GM makes a disease check to\ndetermine the severity of the infection.", + "description": "What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection.", "type": "object", "properties": { "chance": { @@ -53,7 +53,7 @@ "minLength": 1 }, "chance": { - "description": "The chance to get infected by this cause. If present for this\nlanguage, this overrides the universal `chance` field; they cannot be\nused at the same time.", + "description": "The chance to get infected by this cause. If present for this language, this overrides the universal `chance` field; they cannot be used at the same time.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "note": { @@ -90,7 +90,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "damage": { - "description": "An effect or other parameter that may be reduced by a failed disease check\nfor lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified\nwording for *lessened* (disease) and *degraded* (poison).", + "description": "An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison).", "type": "object", "properties": { "default": { @@ -106,7 +106,7 @@ "additionalProperties": false }, "duration": { - "description": "An effect or other parameter that may be reduced by a failed disease check\nfor lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified\nwording for *lessened* (disease) and *degraded* (poison).", + "description": "An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison).", "type": "object", "properties": { "default": { diff --git a/schema/_Enhancements.schema.json b/schema/_Enhancements.schema.json index 7aeb9cbb..785dccc2 100644 --- a/schema/_Enhancements.schema.json +++ b/schema/_Enhancements.schema.json @@ -27,7 +27,7 @@ "minimum": 8 }, "adventure_points_modifier": { - "description": "The value to multiply with the numeric representation of the associated\nskill's improvement cost to form the final AP cost of this enhancement.", + "description": "The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement.", "type": "integer", "minimum": 1 }, diff --git a/schema/_I18n.schema.json b/schema/_I18n.schema.json index 738fde06..6e5df403 100644 --- a/schema/_I18n.schema.json +++ b/schema/_I18n.schema.json @@ -3,7 +3,7 @@ "$id": "/_I18n.schema.json", "$defs": { "PluralizationCategories": { - "description": "The item can be present in multiple pluralization categories; this object\nunifies handling of them. Not all of the options must be present, however,\nevery possible category for that language should be defined. This means, that\ndifferent languages may have a different amount of properties defined here.\nMore information on pluralization and the Intl.PluralRules API on\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules,\nhttps://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and\nhttp://cldr.unicode.org/index/cldr-spec/plural-rules.\n\nFrom the third link:\n\n> The minimal pairs are those that are required for correct grammar. So\n> because 0 and 1 don't have to form a minimal pair (it is ok—even though\n> often not optimal—to say '0 people') , 0 doesn't establish a separate\n> category. However, implementations are encouraged to provide the ability to\n> have special plural messages for 0 in particular, so that more natural\n> language can be used:\n>\n> — None of your friends are online.\n>\n> rather than\n>\n> — You have 0 friends online.", + "description": "The item can be present in multiple pluralization categories; this object unifies handling of them. Not all of the options must be present, however, every possible category for that language should be defined. This means, that different languages may have a different amount of properties defined here. More information on pluralization and the Intl.PluralRules API on https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and http://cldr.unicode.org/index/cldr-spec/plural-rules.\n\nFrom the third link:\n\n> The minimal pairs are those that are required for correct grammar. So\n> because 0 and 1 don't have to form a minimal pair (it is ok—even though\n> often not optimal—to say '0 people') , 0 doesn't establish a separate\n> category. However, implementations are encouraged to provide the ability to\n> have special plural messages for 0 in particular, so that more natural\n> language can be used:\n>\n> — None of your friends are online.\n>\n> rather than\n>\n> — You have 0 friends online.", "type": "object", "properties": { "zero": { diff --git a/schema/_Influence.schema.json b/schema/_Influence.schema.json index 90a0bb53..cf2d0b56 100644 --- a/schema/_Influence.schema.json +++ b/schema/_Influence.schema.json @@ -46,7 +46,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effects": { - "description": "The effects of the influence. They should be sorted like they are in\nthe book.", + "description": "The effects of the influence. They should be sorted like they are in the book.", "type": "array", "items": { "$ref": "#/$defs/InfluenceEffect" @@ -67,7 +67,7 @@ "type": "object", "properties": { "label": { - "description": "An optional label that is displayed and placed before the actual\ntext.", + "description": "An optional label that is displayed and placed before the actual text.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "text": { diff --git a/schema/_Prerequisite.schema.json b/schema/_Prerequisite.schema.json index 835979ab..dc11cf2a 100644 --- a/schema/_Prerequisite.schema.json +++ b/schema/_Prerequisite.schema.json @@ -61,7 +61,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -159,7 +159,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -257,7 +257,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -362,7 +362,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -467,7 +467,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -572,7 +572,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -677,7 +677,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -775,7 +775,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -873,7 +873,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -971,7 +971,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -1069,7 +1069,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -1174,7 +1174,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -1279,7 +1279,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -1377,7 +1377,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { @@ -1475,7 +1475,7 @@ "const": "Group" }, "group": { - "description": "A prerequisite group has no influence on validation logic. It serves as a\nsingle unit for displaying purposes, where the source uses a prerequisites\nitem that cannot be represented as a single prerequisite.", + "description": "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.", "type": "object", "properties": { "list": { diff --git a/schema/_ResponsiveText.schema.json b/schema/_ResponsiveText.schema.json index 3d4cb60c..aad8e0f5 100644 --- a/schema/_ResponsiveText.schema.json +++ b/schema/_ResponsiveText.schema.json @@ -3,7 +3,7 @@ "$id": "/_ResponsiveText.schema.json", "$defs": { "ResponsiveText": { - "description": "A text from the source that can be also displayed in small areas using a\ncompressed version.", + "description": "A text from the source that can be also displayed in small areas using a compressed version.", "type": "object", "properties": { "full": { @@ -22,17 +22,17 @@ "additionalProperties": false }, "ResponsiveTextReplace": { - "description": "A text from the source that can be also displayed in small areas using a\ncompressed version. It is used as a replacement for a generated text while\nthe generated text is still provided and should be used.", + "description": "A text from the source that can be also displayed in small areas using a compressed version. It is used as a replacement for a generated text while the generated text is still provided and should be used.", "type": "object", "properties": { "full": { - "description": "The full replacement string. It must contain `$1`, which is going to be\nreplaced with the generated string, so additional information can be\nprovided without duplicating concrete numeric values.", + "description": "The full replacement string. It must contain `$1`, which is going to be replaced with the generated string, so additional information can be provided without duplicating concrete numeric values.", "type": "string", "minLength": 1, "pattern": "\\$1" }, "compressed": { - "description": "A compressed replacement string for use in small areas (e.g. on character\nsheet). It must contain `$1`, which is going to be replaced with the\ngenerated string, so additional information can be provided without\nduplicating concrete numeric values.", + "description": "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 string, so additional information can be provided without duplicating concrete numeric values.", "type": "string", "minLength": 1, "pattern": "\\$1" @@ -45,7 +45,7 @@ "additionalProperties": false }, "ResponsiveTextOptional": { - "description": "A text from the source that can be also displayed in small areas using a\ncompressed version, if available.", + "description": "A text from the source that can be also displayed in small areas using a compressed version, if available.", "type": "object", "properties": { "full": { @@ -53,7 +53,7 @@ "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "compressed": { - "description": "A compressed text for use in small areas (e.g. on character sheet). If this\nis not present, it should not appear in those areas.", + "description": "A compressed text for use in small areas (e.g. on character sheet). If this is not present, it should not appear in those areas.", "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, diff --git a/schema/_Spellwork.schema.json b/schema/_Spellwork.schema.json index dfde69b5..2efe2e6c 100644 --- a/schema/_Spellwork.schema.json +++ b/schema/_Spellwork.schema.json @@ -3,7 +3,7 @@ "$id": "/_Spellwork.schema.json", "$defs": { "Traditions": { - "description": "The tradition(s) the ritual is available for. It may be *generally*\navailable to all traditions or it may be only familiar in specific\ntraditions.", + "description": "The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions.", "oneOf": [ { "type": "object", diff --git a/schema/equipment/EquipmentPackage.schema.json b/schema/equipment/EquipmentPackage.schema.json index 37eef8af..a768742c 100644 --- a/schema/equipment/EquipmentPackage.schema.json +++ b/schema/equipment/EquipmentPackage.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "items": { - "description": "All items in the package. You have to provide the item (template)\nidentifier and you can optionally provide the number of how often an item\nis included in the package.", + "description": "All items in the package. You have to provide the item (template) identifier and you can optionally provide the number of how often an item is included in the package.", "type": "array", "items": { "$ref": "#/$defs/EquipmentPackageItem" diff --git a/schema/equipment/item/Armor.schema.json b/schema/equipment/item/Armor.schema.json index d3d7d804..046c4611 100644 --- a/schema/equipment/item/Armor.schema.json +++ b/schema/equipment/item/Armor.schema.json @@ -276,7 +276,7 @@ "type": "object", "properties": { "combination_possibilities": { - "description": "In some cases, multiple armors for the same hit zone can be combined.\nThey're listed at the item that can be combined with others.", + "description": "In some cases, multiple armors for the same hit zone can be combined. They're listed at the item that can be combined with others.", "$ref": "#/$defs/HeadHitZoneCombinationPossibilities" } }, @@ -295,7 +295,7 @@ "minItems": 1 }, "protection": { - "description": "The PRO value that is added to the PRO value of the other armor instead\nof adding the normale PRO value.", + "description": "The PRO value that is added to the PRO value of the other armor instead of adding the normale PRO value.", "type": "integer", "minimum": 0 } diff --git a/schema/equipment/item/BandageOrRemedy.schema.json b/schema/equipment/item/BandageOrRemedy.schema.json index de898746..e786a011 100644 --- a/schema/equipment/item/BandageOrRemedy.schema.json +++ b/schema/equipment/item/BandageOrRemedy.schema.json @@ -19,11 +19,11 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "./_Item.schema.json#/$defs/CombatUse" }, "src": { diff --git a/schema/equipment/item/Book.schema.json b/schema/equipment/item/Book.schema.json index 41d82bea..7ad1d356 100644 --- a/schema/equipment/item/Book.schema.json +++ b/schema/equipment/item/Book.schema.json @@ -19,7 +19,7 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "src": { diff --git a/schema/equipment/item/CeremonialItem.schema.json b/schema/equipment/item/CeremonialItem.schema.json index abec1c97..b2e3615f 100644 --- a/schema/equipment/item/CeremonialItem.schema.json +++ b/schema/equipment/item/CeremonialItem.schema.json @@ -19,7 +19,7 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "associated_tradition": { @@ -27,7 +27,7 @@ "$ref": "../../_SimpleReferences.schema.json#/$defs/BlessedTraditionReference" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "./_Item.schema.json#/$defs/CombatUse" }, "src": { diff --git a/schema/equipment/item/Elixir.schema.json b/schema/equipment/item/Elixir.schema.json index da690258..73d6ea95 100644 --- a/schema/equipment/item/Elixir.schema.json +++ b/schema/equipment/item/Elixir.schema.json @@ -20,7 +20,7 @@ "$ref": "./_Herbary.schema.json#/$defs/LaboratoryLevel" }, "brewing_difficulty": { - "description": "The brewing difficulty, which represents the challenge of creating an\nelixir.", + "description": "The brewing difficulty, which represents the challenge of creating an elixir.", "type": "integer" }, "trade_secret": { @@ -82,7 +82,7 @@ "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "quality_levels": { - "description": "The list of effects for each quality level. The first element\nrepresents QL 1, the second element QL 2, and so on.", + "description": "The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on.", "type": "array", "items": { "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" diff --git a/schema/equipment/item/EquipmentOfBlessedOnes.schema.json b/schema/equipment/item/EquipmentOfBlessedOnes.schema.json index 84ca29f6..5ee45e61 100644 --- a/schema/equipment/item/EquipmentOfBlessedOnes.schema.json +++ b/schema/equipment/item/EquipmentOfBlessedOnes.schema.json @@ -11,7 +11,7 @@ "$ref": "./_Item.schema.json#/$defs/Cost" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "associated_tradition": { diff --git a/schema/equipment/item/IlluminationLightSource.schema.json b/schema/equipment/item/IlluminationLightSource.schema.json index d071ce13..e0f4d55f 100644 --- a/schema/equipment/item/IlluminationLightSource.schema.json +++ b/schema/equipment/item/IlluminationLightSource.schema.json @@ -19,15 +19,15 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "burning_time": { - "description": "The burning time is the time how long the light source can be lit. After\nthat time you have to use a new light source.", + "description": "The burning time is the time how long the light source can be lit. After that time you have to use a new light source.", "$ref": "#/$defs/BurningTime" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "./_Item.schema.json#/$defs/CombatUse" }, "src": { @@ -114,11 +114,7 @@ "additionalProperties": false }, "LimitedBurningTimeUnit": { - "oneOf": [ - { - "const": "Hours" - } - ] + "const": "Hours" } } } diff --git a/schema/equipment/item/Jewelry.schema.json b/schema/equipment/item/Jewelry.schema.json index 221f5781..f09fde64 100644 --- a/schema/equipment/item/Jewelry.schema.json +++ b/schema/equipment/item/Jewelry.schema.json @@ -53,7 +53,7 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "src": { diff --git a/schema/equipment/item/LuxuryGood.schema.json b/schema/equipment/item/LuxuryGood.schema.json index 035bebb9..74753636 100644 --- a/schema/equipment/item/LuxuryGood.schema.json +++ b/schema/equipment/item/LuxuryGood.schema.json @@ -19,11 +19,11 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "./_Item.schema.json#/$defs/CombatUse" }, "src": { diff --git a/schema/equipment/item/MusicalInstrument.schema.json b/schema/equipment/item/MusicalInstrument.schema.json index 3252df9f..37efef33 100644 --- a/schema/equipment/item/MusicalInstrument.schema.json +++ b/schema/equipment/item/MusicalInstrument.schema.json @@ -19,7 +19,7 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "./_Item.schema.json#/$defs/CombatUse" }, "src": { diff --git a/schema/equipment/item/Poison.schema.json b/schema/equipment/item/Poison.schema.json index c679da10..03a24546 100644 --- a/schema/equipment/item/Poison.schema.json +++ b/schema/equipment/item/Poison.schema.json @@ -34,7 +34,7 @@ "$ref": "#/$defs/PoisonStart" }, "duration": { - "description": "An effect or other parameter that may be reduced by a failed disease check\nfor lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified\nwording for *lessened* (disease) and *degraded* (poison).", + "description": "An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison).", "type": "object", "properties": { "default": { @@ -435,7 +435,7 @@ "$ref": "./_Herbary.schema.json#/$defs/LaboratoryLevel" }, "brewing_difficulty": { - "description": "The brewing difficulty, which represents the challenge of creating an\nelixir.", + "description": "The brewing difficulty, which represents the challenge of creating an elixir.", "type": "integer" }, "trade_secret": { @@ -607,11 +607,7 @@ "additionalProperties": false }, "QualityLevelDemonicPoisonLevelSource": { - "oneOf": [ - { - "const": "Spellwork" - } - ] + "const": "Spellwork" }, "ConstantDemonicPoisonLevel": { "type": "object", @@ -644,11 +640,11 @@ "type": "object", "properties": { "legality": { - "description": "Whether the use of the intoxicant is legal or not, usually from the\nperspective of most middle-Aventurian an northern-Aventurian nations.", + "description": "Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations.", "$ref": "#/$defs/IntoxicantLegality" }, "addiction": { - "description": "The chance of getting addicted after an ingestion in addition to the\nmaximum interval at which it, while addicted, must be ingested to not\nsuffer from withdrawal symptoms.", + "description": "The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms.", "$ref": "#/$defs/IntoxicantAddiction" }, "translations": { @@ -670,7 +666,7 @@ "additionalProperties": false }, "IntoxicantLegality": { - "description": "Whether the use of the intoxicant is legal or not, usually from the\nperspective of most middle-Aventurian an northern-Aventurian nations.", + "description": "Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations.", "type": "object", "properties": { "is_legal": { @@ -683,7 +679,7 @@ "additionalProperties": false }, "IntoxicantAddiction": { - "description": "The chance of getting addicted after an ingestion in addition to the maximum\ninterval at which it, while addicted, must be ingested to not suffer from\nwithdrawal symptoms.", + "description": "The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms.", "type": "object", "properties": { "chance": { @@ -691,7 +687,7 @@ "type": "number" }, "interval": { - "description": "The maximum interval at which it, while addicted, must be ingested to not\nsuffer from withdrawal symptoms.", + "description": "The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms.", "$ref": "#/$defs/IntoxicantAddictionInterval" } }, @@ -702,7 +698,7 @@ "additionalProperties": false }, "IntoxicantAddictionInterval": { - "description": "The maximum interval at which it, while addicted, must be ingested to not\nsuffer from withdrawal symptoms.", + "description": "The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms.", "oneOf": [ { "type": "object", @@ -772,11 +768,11 @@ "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "side_effect": { - "description": "The intoxicants side effects that always happen, no matter whether the\nintoxicant has the default or the reduced effect.", + "description": "The intoxicants side effects that always happen, no matter whether the intoxicant has the default or the reduced effect.", "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "overdose": { - "description": "What happens if the intoxicant has been overdosed, that is, it has been\ningested another time within the duration.", + "description": "What happens if the intoxicant has been overdosed, that is, it has been ingested another time within the duration.", "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown" }, "special": { @@ -806,7 +802,7 @@ "minItems": 1 }, "effect": { - "description": "An effect or other parameter that may be reduced by a failed disease check\nfor lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified\nwording for *lessened* (disease) and *degraded* (poison).", + "description": "An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison.\n\nThis streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison).", "type": "object", "properties": { "default": { diff --git a/schema/equipment/item/ToolOfTheTrade.schema.json b/schema/equipment/item/ToolOfTheTrade.schema.json index aef762c1..cd083f30 100644 --- a/schema/equipment/item/ToolOfTheTrade.schema.json +++ b/schema/equipment/item/ToolOfTheTrade.schema.json @@ -19,7 +19,7 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "laboratory": { diff --git a/schema/equipment/item/Weapon.schema.json b/schema/equipment/item/Weapon.schema.json index fbb77d7f..bd6759d8 100644 --- a/schema/equipment/item/Weapon.schema.json +++ b/schema/equipment/item/Weapon.schema.json @@ -19,11 +19,11 @@ "$ref": "./_Item.schema.json#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "./_Item.schema.json#/$defs/StructurePoints" }, "uses": { - "description": "A list of stat blocks for each combat technique this weapon can be used\nwith.", + "description": "A list of stat blocks for each combat technique this weapon can be used with.", "type": "array", "items": { "$ref": "#/$defs/WeaponUse" @@ -31,15 +31,15 @@ "minItems": 1 }, "sanctified_by": { - "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.", + "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed Ones.", "$ref": "#/$defs/SanctifiedBy" }, "restricted_to_cultures": { - "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.", + "description": "Define if during character creation this weapon can only be bought by characters of a specific race or culture.", "$ref": "#/$defs/RestrictedToCultures" }, "restricted_to_traditions": { - "description": "Define if during character creation this weapon can only be bought by\ncharacters of specific magical or blessed traditions.", + "description": "Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions.", "type": "array", "items": { "$ref": "../../_SimpleReferences.schema.json#/$defs/MagicalTraditionReference" @@ -111,7 +111,7 @@ "type": "object", "properties": { "uses": { - "description": "A list of stat blocks for each combat technique this weapon can be used\nwith.", + "description": "A list of stat blocks for each combat technique this weapon can be used with.", "type": "array", "items": { "$ref": "#/$defs/WeaponUse" @@ -119,15 +119,15 @@ "minItems": 1 }, "sanctified_by": { - "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.", + "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed Ones.", "$ref": "#/$defs/SanctifiedBy" }, "restricted_to_cultures": { - "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.", + "description": "Define if during character creation this weapon can only be bought by characters of a specific race or culture.", "$ref": "#/$defs/RestrictedToCultures" }, "restricted_to_traditions": { - "description": "Define if during character creation this weapon can only be bought by\ncharacters of specific magical or blessed traditions.", + "description": "Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions.", "type": "array", "items": { "$ref": "../../_SimpleReferences.schema.json#/$defs/MagicalTraditionReference" @@ -222,7 +222,7 @@ ] }, "SanctifiedBy": { - "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.", + "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed Ones.", "type": "array", "items": { "$ref": "../../_SimpleReferences.schema.json#/$defs/BlessedTraditionReference" @@ -230,7 +230,7 @@ "minItems": 1 }, "RestrictedToCultures": { - "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.", + "description": "Define if during character creation this weapon can only be bought by characters of a specific race or culture.", "oneOf": [ { "type": "object", diff --git a/schema/equipment/item/_Item.schema.json b/schema/equipment/item/_Item.schema.json index 09d7f5c8..5284fc68 100644 --- a/schema/equipment/item/_Item.schema.json +++ b/schema/equipment/item/_Item.schema.json @@ -18,11 +18,11 @@ "$ref": "#/$defs/Complexity" }, "structure_points": { - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "$ref": "#/$defs/StructurePoints" }, "combat_use": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "$ref": "#/$defs/CombatUse" }, "src": { @@ -50,7 +50,7 @@ "additionalProperties": false }, "CombatUse": { - "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.", + "description": "The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item.", "oneOf": [ { "type": "object", @@ -116,7 +116,7 @@ }, "StructurePoints": { "title": "Structure Points", - "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.", + "description": "The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.", "type": "array", "items": { "$ref": "#/$defs/StructurePointsComponent" diff --git a/schema/equipment/item/_MeleeWeapon.schema.json b/schema/equipment/item/_MeleeWeapon.schema.json index 96f04ee9..80ddaf60 100644 --- a/schema/equipment/item/_MeleeWeapon.schema.json +++ b/schema/equipment/item/_MeleeWeapon.schema.json @@ -11,7 +11,7 @@ "type": "integer" }, "MeleeDamage": { - "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.", + "description": "The damage of a weapon consists of a random part using dice and an optional flat part.", "type": "object", "properties": { "dice": { @@ -110,7 +110,7 @@ "$ref": "../../_SimpleReferences.schema.json#/$defs/CloseCombatTechniqueReference" }, "damage": { - "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.", + "description": "The damage of a weapon consists of a random part using dice and an optional flat part.", "$ref": "#/$defs/MeleeDamage" }, "damage_threshold": { diff --git a/schema/equipment/item/_RangedWeapon.schema.json b/schema/equipment/item/_RangedWeapon.schema.json index 84ae7d91..ed5374e8 100644 --- a/schema/equipment/item/_RangedWeapon.schema.json +++ b/schema/equipment/item/_RangedWeapon.schema.json @@ -3,7 +3,7 @@ "$id": "/equipment/item/_RangedWeapon.schema.json", "$defs": { "RangedDamage": { - "description": "The damage of a ranged weapon. It consists of a random part using dice and an\noptional flat part ny default. Some ranged weapons may work different so that\ndamage is either not applicable at all or it is outlined as *Special* and\nfurther defined in a description.", + "description": "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.", "oneOf": [ { "type": "object", @@ -62,7 +62,7 @@ ] }, "DefaultRangedDamage": { - "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.", + "description": "The damage of a weapon consists of a random part using dice and an optional flat part.", "type": "object", "properties": { "dice": { @@ -89,7 +89,7 @@ "$ref": "../../_SimpleReferences.schema.json#/$defs/RangedCombatTechniqueReference" }, "damage": { - "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.", + "description": "The damage of a weapon consists of a random part using dice and an optional flat part.", "$ref": "#/$defs/RangedDamage" }, "reload_time": { diff --git a/schema/equipment/item/_Weapon.schema.json b/schema/equipment/item/_Weapon.schema.json index 921daabe..38784e96 100644 --- a/schema/equipment/item/_Weapon.schema.json +++ b/schema/equipment/item/_Weapon.schema.json @@ -3,7 +3,7 @@ "$id": "/equipment/item/_Weapon.schema.json", "$defs": { "PrimaryAttributeDamageThreshold": { - "description": "The primary attribute damage and threshold value. You can either use an\ninteger, an object or a pair. Use an integer if you just have to define a\nsingle threshold value for the default primary attribute of the combat\ntechnique. Use an object if you need to define the value only or if you need\nto define the value as well as a single different primary attribute than\nwhich the combat technique uses. Use the pair if you need to set the primary\nattributes to AGI and STR (the combat technique has AGI but this item has\nAGI/STR) and/or if you need to set different thresholds for AGI and STR (e.g.\nAGI 14/STR 15). If the same values are in the pair, they will be merged (AGI\n14/STR 14 will be AGI/STR 14).", + "description": "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).", "oneOf": [ { "type": "object", @@ -43,7 +43,7 @@ "type": "object", "properties": { "threshold": { - "description": "The attribute value representing the damage threshold for the primary\nattribute of the item's combat technique.", + "description": "The attribute value representing the damage threshold for the primary attribute of the item's combat technique.", "type": "integer", "minimum": 1 } diff --git a/schema/equipment/item/sub/ArmorType.schema.json b/schema/equipment/item/sub/ArmorType.schema.json index 76c7368c..0f5d3ac2 100644 --- a/schema/equipment/item/sub/ArmorType.schema.json +++ b/schema/equipment/item/sub/ArmorType.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "sturdiness_rating": { - "description": "An armor type can have a *sturdiness rating*. The higher the rating, the\nmore durable the armor. Rolling higher than this rating during a sturdiness\ncheck means the armor receives one level of the new condition *Wear*.", + "description": "An armor type can have a *sturdiness rating*. The higher the rating, the more durable the armor. Rolling higher than this rating during a sturdiness check means the armor receives one level of the new condition *Wear*.", "type": "integer", "minimum": 1 }, diff --git a/schema/magicalActions/AnimistPower.schema.json b/schema/magicalActions/AnimistPower.schema.json index 1737cb99..561f30c0 100644 --- a/schema/magicalActions/AnimistPower.schema.json +++ b/schema/magicalActions/AnimistPower.schema.json @@ -25,7 +25,7 @@ "$ref": "../_SimpleReferences.schema.json#/$defs/PropertyReference" }, "tribe_tradition": { - "description": "The tribe traditions the animist power is available to. It may be available\nto all or only specific tribes.\n\nIf no tribe tradition is given, the animist power is generally available to\nall tribe traditions.", + "description": "The tribe traditions the animist power is available to. It may be available to all or only specific tribes.\n\nIf no tribe tradition is given, the animist power is generally available to all tribe traditions.", "type": "array", "items": { "$ref": "../_SimpleReferences.schema.json#/$defs/AnimistTribeReference" @@ -33,14 +33,14 @@ "uniqueItems": true }, "improvement_cost": { - "description": "States which column is used to improve the skill. It is a fixed value or\ndepends on the primary patron.", + "description": "States which column is used to improve the skill. It is a fixed value or depends on the primary patron.", "$ref": "#/$defs/AnimistPowerImprovementCost" }, "prerequisites": { "$ref": "../_Prerequisite.schema.json#/$defs/AnimistPowerPrerequisites" }, "levels": { - "description": "The animist power can have multiple levels. Each level is skilled\nseparately. A previous level must be on at least 10 so that the next higher\nlevel can be activated and skilled. A higher level cannot be skilled higher\nthan a lower level. Each level also adds an effect text to the text of the\nfirst level.", + "description": "The animist power can have multiple levels. Each level is skilled separately. A previous level must be on at least 10 so that the next higher level can be activated and skilled. A higher level cannot be skilled higher than a lower level. Each level also adds an effect text to the text of the first level.", "type": "array", "items": { "$ref": "#/$defs/AnimistPowerLevel" @@ -86,7 +86,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "cost": { @@ -195,7 +195,7 @@ "type": "object", "properties": { "cost": { - "description": "The AE cost value, either a flat value or defined dynamically by the\nprimary patron.", + "description": "The AE cost value, either a flat value or defined dynamically by the primary patron.", "$ref": "#/$defs/OneTimeAnimistPowerCost" }, "duration": { @@ -344,7 +344,7 @@ "type": "object", "properties": { "cost": { - "description": "The AE cost value, either a flat value or defined dynamically by the\nprimary patron.", + "description": "The AE cost value, either a flat value or defined dynamically by the primary patron.", "$ref": "#/$defs/SustainedAnimistPowerCost" } }, diff --git a/schema/magicalActions/Curse.schema.json b/schema/magicalActions/Curse.schema.json index 28846cce..7f034cc5 100644 --- a/schema/magicalActions/Curse.schema.json +++ b/schema/magicalActions/Curse.schema.json @@ -61,7 +61,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "cost": { @@ -166,7 +166,7 @@ "type": "object", "properties": { "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 KP\nper person`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 KP per person`.", "$ref": "../_ResponsiveText.schema.json#/$defs/ResponsiveText" }, "note": { diff --git a/schema/magicalActions/DominationRitual.schema.json b/schema/magicalActions/DominationRitual.schema.json index a06044ac..04c9eb4f 100644 --- a/schema/magicalActions/DominationRitual.schema.json +++ b/schema/magicalActions/DominationRitual.schema.json @@ -61,7 +61,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "cost": { diff --git a/schema/magicalActions/ElvenMagicalSong.schema.json b/schema/magicalActions/ElvenMagicalSong.schema.json index 7bb28b67..1f4bef84 100644 --- a/schema/magicalActions/ElvenMagicalSong.schema.json +++ b/schema/magicalActions/ElvenMagicalSong.schema.json @@ -77,7 +77,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "cost": { @@ -183,7 +183,7 @@ "type": "object", "properties": { "per": { - "description": "The cost have to be per a specific countable entity, e.g. `8 AE\nper person`.", + "description": "The cost have to be per a specific countable entity, e.g. `8 AE per person`.", "$ref": "../_ResponsiveText.schema.json#/$defs/ResponsiveText" } }, diff --git a/schema/magicalActions/GeodeRitual.schema.json b/schema/magicalActions/GeodeRitual.schema.json index 7a34ec47..7df83555 100644 --- a/schema/magicalActions/GeodeRitual.schema.json +++ b/schema/magicalActions/GeodeRitual.schema.json @@ -65,7 +65,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/magicalActions/JesterTrick.schema.json b/schema/magicalActions/JesterTrick.schema.json index 84f4ec3b..16d09763 100644 --- a/schema/magicalActions/JesterTrick.schema.json +++ b/schema/magicalActions/JesterTrick.schema.json @@ -71,7 +71,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/magicalActions/MagicalDance.schema.json b/schema/magicalActions/MagicalDance.schema.json index 6c1e1486..56162a0c 100644 --- a/schema/magicalActions/MagicalDance.schema.json +++ b/schema/magicalActions/MagicalDance.schema.json @@ -25,7 +25,7 @@ "$ref": "../_SimpleReferences.schema.json#/$defs/PropertyReference" }, "music_tradition": { - "description": "The music tradition(s) the magical dance is available for. This also\ndefines the different names in each music tradition.", + "description": "The music tradition(s) the magical dance is available for. This also defines the different names in each music tradition.", "type": "array", "items": { "$ref": "./_MusicTradition.schema.json#/$defs/MusicTraditionReference" @@ -71,7 +71,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "duration": { @@ -174,7 +174,7 @@ "type": "object", "properties": { "modifier": { - "description": "Specified if the indefinite description's result value is to be\nmodified by a certain number.", + "description": "Specified if the indefinite description's result value is to be modified by a certain number.", "$ref": "../_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBasedModifier" }, "translations": { diff --git a/schema/magicalActions/MagicalMelody.schema.json b/schema/magicalActions/MagicalMelody.schema.json index a6556b73..626f4b2e 100644 --- a/schema/magicalActions/MagicalMelody.schema.json +++ b/schema/magicalActions/MagicalMelody.schema.json @@ -21,7 +21,7 @@ "$ref": "../_SkillCheck.schema.json#/$defs/SkillCheckPenalty" }, "skill": { - "description": "Arcane bards must make a *Singing (area of application)* or *Music (area of\napplication)* check for each magical melody.", + "description": "Arcane bards must make a *Singing (area of application)* or *Music (area of application)* check for each magical melody.", "type": "array", "items": { "$ref": "./_SkillReference.schema.json#/$defs/MusicalSkillReference" @@ -39,7 +39,7 @@ "$ref": "../_SimpleReferences.schema.json#/$defs/PropertyReference" }, "music_tradition": { - "description": "The music tradition(s) the magical melody is available for. This also\ndefines the different names in each music tradition.", + "description": "The music tradition(s) the magical melody is available for. This also defines the different names in each music tradition.", "type": "array", "items": { "$ref": "./_MusicTradition.schema.json#/$defs/MusicTraditionReference" @@ -86,7 +86,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "duration": { @@ -178,7 +178,7 @@ "type": "object", "properties": { "value": { - "description": "The (temporary) AE cost value for the first targeted person. The AE\ncost for each additional person is half this value.", + "description": "The (temporary) AE cost value for the first targeted person. The AE cost for each additional person is half this value.", "type": "integer", "minimum": 1, "multipleOf": 2 diff --git a/schema/magicalActions/MagicalRune.schema.json b/schema/magicalActions/MagicalRune.schema.json index c076c59b..92a94573 100644 --- a/schema/magicalActions/MagicalRune.schema.json +++ b/schema/magicalActions/MagicalRune.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "options": { - "description": "The options the magical rune has, if any.\n\nIf there are multiple options, the magical rune may be activated for each\noption, that is, multiple times.", + "description": "The options the magical rune has, if any.\n\nIf there are multiple options, the magical rune may be activated for each option, that is, multiple times.", "type": "array", "items": { "$ref": "#/$defs/MagicalRuneOption" @@ -69,11 +69,11 @@ "type": "object", "properties": { "name": { - "description": "The name of the magical rune.\n\nIf the rune has an option, the option’s name will/should not be included in\nthe name as well as its surrounding parenthesis. It will/should be combined\non demand.", + "description": "The name of the magical rune.\n\nIf the rune has an option, the option’s name will/should not be included in the name as well as its surrounding parenthesis. It will/should be combined on demand.", "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "name_in_library": { - "description": "The full name of the entry as stated in the sources. Only use when `name`\nneeds to be different from full name for text generation purposes.", + "description": "The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes.", "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "native_name": { @@ -81,7 +81,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "cost": { @@ -388,7 +388,7 @@ "type": "object", "properties": { "per": { - "description": "The crafting time has to be per a specific countable entity, e.g. `8\naction per person`.", + "description": "The crafting time has to be per a specific countable entity, e.g. `8 action per person`.", "$ref": "../_ResponsiveText.schema.json#/$defs/ResponsiveText" } }, @@ -560,7 +560,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the option.\n\nThe surrounding parenthesis will/should not be included, they will/should\nbe generated.", + "description": "The name of the option.\n\nThe surrounding parenthesis will/should not be included, they will/should be generated.", "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "native_name": { diff --git a/schema/magicalActions/ZibiljaRitual.schema.json b/schema/magicalActions/ZibiljaRitual.schema.json index 2e5451c5..e23e3a62 100644 --- a/schema/magicalActions/ZibiljaRitual.schema.json +++ b/schema/magicalActions/ZibiljaRitual.schema.json @@ -71,7 +71,7 @@ "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "effect": { - "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.", + "description": "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.", "$ref": "../_ActivatableSkillEffect.schema.json#/$defs/ActivatableSkillEffect" }, "casting_time": { diff --git a/schema/magicalActions/_MusicTradition.schema.json b/schema/magicalActions/_MusicTradition.schema.json index 1a335980..96a7f99f 100644 --- a/schema/magicalActions/_MusicTradition.schema.json +++ b/schema/magicalActions/_MusicTradition.schema.json @@ -3,7 +3,7 @@ "$id": "/magicalActions/_MusicTradition.schema.json", "$defs": { "MusicTraditionReference": { - "description": "A reference to a music tradition with the music-tradition-specific name of\nthe entry", + "description": "A reference to a music tradition with the music-tradition-specific name of the entry", "type": "object", "properties": { "id": { diff --git a/schema/prerequisites/ConditionalPrerequisites.schema.json b/schema/prerequisites/ConditionalPrerequisites.schema.json index 454992d2..5c811208 100644 --- a/schema/prerequisites/ConditionalPrerequisites.schema.json +++ b/schema/prerequisites/ConditionalPrerequisites.schema.json @@ -4,7 +4,7 @@ "$defs": { "Preconditions": { "title": "Preconditions (`when`)", - "description": "A list of preconditions for the prerequisite it is defined on, so that it\nonly takes effect if the prerequisites in this list are matched.\n\nUsually appears at the `when` property of the parent prerequisite.", + "description": "A list of preconditions for the prerequisite it is defined on, so that it only takes effect if the prerequisites in this list are matched.\n\nUsually appears at the `when` property of the parent prerequisite.", "type": "array", "items": { "$ref": "./PrerequisiteGroups.schema.json#/$defs/PreconditionGroup" diff --git a/schema/prerequisites/DisplayOption.schema.json b/schema/prerequisites/DisplayOption.schema.json index 8dcdf636..78237f50 100644 --- a/schema/prerequisites/DisplayOption.schema.json +++ b/schema/prerequisites/DisplayOption.schema.json @@ -46,7 +46,7 @@ "type": "object", "properties": { "sentence_type": { - "description": "If the replacement text is a sentence or sentence-like fragment, this\nproperty ensures it is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with\na period and a period is also added at the end of the sentence\nautomatically, if it is not present. A connected sentence is connected to\nthe previous prerequisite string with a semicolon and a period is not added\nto the end of the sentence. In this case, if there are prerequisites after\nthis one, they will be connected using a semicolon again, unless a\ndifferent punctuation mark is present at the end of the given text.", + "description": "If the replacement text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text.", "$ref": "./single/TextPrerequisite.schema.json#/$defs/SentenceType" }, "translations": { diff --git a/schema/prerequisites/single/ActivatablePrerequisite.schema.json b/schema/prerequisites/single/ActivatablePrerequisite.schema.json index 62504a82..72408594 100644 --- a/schema/prerequisites/single/ActivatablePrerequisite.schema.json +++ b/schema/prerequisites/single/ActivatablePrerequisite.schema.json @@ -21,7 +21,7 @@ "minimum": 1 }, "options": { - "description": "Required select options. Order is important. Typically, you only need the\nfirst array index, though.", + "description": "Required select options. Order is important. Typically, you only need the first array index, though.", "type": "array", "items": { "$ref": "../../_IdentifierGroup.schema.json#/$defs/RequirableSelectOptionIdentifier" diff --git a/schema/prerequisites/single/EnhancementPrerequisite.schema.json b/schema/prerequisites/single/EnhancementPrerequisite.schema.json index 1004767f..2941f97f 100644 --- a/schema/prerequisites/single/EnhancementPrerequisite.schema.json +++ b/schema/prerequisites/single/EnhancementPrerequisite.schema.json @@ -4,7 +4,7 @@ "$defs": { "ExternalEnhancementPrerequisite": { "title": "External Enhancement Prerequisite", - "description": "Requires a specific enhancement from a skill. This should **not** be used\nfor enhancements themselves; they can only require enhancements from the same\nskill they enhance.", + "description": "Requires a specific enhancement from a skill. This should **not** be used for enhancements themselves; they can only require enhancements from the same skill they enhance.", "type": "object", "properties": { "skill": { @@ -54,7 +54,7 @@ }, "InternalEnhancementPrerequisite": { "title": "Internal Enhancement Prerequisite", - "description": "Requires a specific enhancement from a skill. This can only be used by an\nenhancement to require another enhancement from the same skill.", + "description": "Requires a specific enhancement from a skill. This can only be used by an enhancement to require another enhancement from the same skill.", "$ref": "#/$defs/EnhancementsReference" } } diff --git a/schema/prerequisites/single/RacePrerequisite.schema.json b/schema/prerequisites/single/RacePrerequisite.schema.json index 209e0c04..77cee044 100644 --- a/schema/prerequisites/single/RacePrerequisite.schema.json +++ b/schema/prerequisites/single/RacePrerequisite.schema.json @@ -4,7 +4,7 @@ "$defs": { "RacePrerequisite": { "title": "Race Prerequisite", - "description": "Requires a specific race or one of a specific set of races. You can also\nprovide an object to say whether the hero must meet one of the races or\nif the entry does not allow one of the races.", + "description": "Requires a specific race or one of a specific set of races. You can also provide an object to say whether the hero must meet one of the races or if the entry does not allow one of the races.", "type": "object", "properties": { "id": { diff --git a/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json b/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json index 6869c81c..e0c4debf 100644 --- a/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json +++ b/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json @@ -7,12 +7,12 @@ "type": "object", "properties": { "number": { - "description": "The minimum number of skills that need to be on the defined minimum skill\nrating.", + "description": "The minimum number of skills that need to be on the defined minimum skill rating.", "type": "integer", "minimum": 1 }, "value": { - "description": "The minimum skill rating the defined minimum number of skills need to be\non.", + "description": "The minimum skill rating the defined minimum number of skills need to be on.", "type": "integer", "minimum": 1 }, diff --git a/schema/prerequisites/single/TextPrerequisite.schema.json b/schema/prerequisites/single/TextPrerequisite.schema.json index 4ccc471a..57d93d7b 100644 --- a/schema/prerequisites/single/TextPrerequisite.schema.json +++ b/schema/prerequisites/single/TextPrerequisite.schema.json @@ -4,19 +4,19 @@ "$defs": { "TextPrerequisite": { "title": "Text Prerequisite", - "description": "A prerequisite that is either not verifyable in general – e.g. roleplay or\nbackground information – or the referenced entities were not made available\nfor use yet – e.g. races –, but which should be displayed, because it is part\nof the prerequisite string from the sources.", + "description": "A prerequisite that is either not verifyable in general – e.g. roleplay or background information – or the referenced entities were not made available for use yet – e.g. races –, but which should be displayed, because it is part of the prerequisite string from the sources.", "type": "object", "properties": { "verification": { - "description": "The method how the prerequisite should be verified. Either is passes all\nverification text or it denies all verification tests. The latter results\nin the associated entry to never be available for purchase.", + "description": "The method how the prerequisite should be verified. Either is passes all verification text or it denies all verification tests. The latter results in the associated entry to never be available for purchase.", "$ref": "#/$defs/TextVerificationRule" }, "sentence_type": { - "description": "If the text is a sentence or sentence-like fragment, this property ensures\nit is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with\na period and a period is also added at the end of the sentence\nautomatically, if it is not present. A connected sentence is connected to\nthe previous prerequisite string with a semicolon and a period is not added\nto the end of the sentence. In this case, if there are prerequisites after\nthis one, they will be connected using a semicolon again, unless a\ndifferent punctuation mark is present at the end of the given text.", + "description": "If the text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text.", "$ref": "#/$defs/SentenceType" }, "is_meta": { - "description": "If the text does not represent an actual prerequisite but a prerequisite\nfor the use of certain aspects or the entry the prerequisite is associated\nwith, or something like that, this property is set to `true`.\n\nIf all prerequisites of an entry are marked as meta, the entry is\nconsidered to have no prerequisites and thus the string `none` must be\nrendered before the list of meta prerequisites.\n\nThis is the only use case for this property.", + "description": "If the text does not represent an actual prerequisite but a prerequisite for the use of certain aspects or the entry the prerequisite is associated with, or something like that, this property is set to `true`.\n\nIf all prerequisites of an entry are marked as meta, the entry is considered to have no prerequisites and thus the string `none` must be rendered before the list of meta prerequisites.\n\nThis is the only use case for this property.", "const": true }, "translations": { diff --git a/schema/prerequisites/single/TraditionPrerequisite.schema.json b/schema/prerequisites/single/TraditionPrerequisite.schema.json index b5b50efc..a8991048 100644 --- a/schema/prerequisites/single/TraditionPrerequisite.schema.json +++ b/schema/prerequisites/single/TraditionPrerequisite.schema.json @@ -7,7 +7,7 @@ "type": "object", "properties": { "restriction": { - "description": "The blessed tradition prerequisite may only be satified if the blessed\ntradition is either church or shamanistic.", + "description": "The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic.", "$ref": "#/$defs/BlessedTraditionPrerequisiteRestriction" }, "display_option": { @@ -18,7 +18,7 @@ "additionalProperties": false }, "BlessedTraditionPrerequisiteRestriction": { - "description": "The blessed tradition prerequisite may only be satified if the blessed\ntradition is either church or shamanistic.", + "description": "The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic.", "oneOf": [ { "const": "Church" @@ -33,7 +33,7 @@ "type": "object", "properties": { "restriction": { - "description": "The magical tradition prerequisite may only be satified if the magical\ntradition can learn rituals or can bind familiars.", + "description": "The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars.", "$ref": "#/$defs/MagicalTraditionPrerequisiteRestriction" }, "display_option": { @@ -44,7 +44,7 @@ "additionalProperties": false }, "MagicalTraditionPrerequisiteRestriction": { - "description": "The magical tradition prerequisite may only be satified if the magical\ntradition can learn rituals or can bind familiars.", + "description": "The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars.", "oneOf": [ { "const": "CanLearnRituals" diff --git a/schema/rule/CoreRule.schema.json b/schema/rule/CoreRule.schema.json index a39a1ee9..defc831b 100644 --- a/schema/rule/CoreRule.schema.json +++ b/schema/rule/CoreRule.schema.json @@ -126,7 +126,7 @@ ] }, "ChildNode": { - "description": "A core rule nested inside this core rule. It may be displayed as a separate\npage or its content may be included in this rule's text, which will\nautomatically generate a proper heading. No content node of a type other than\n`Child` should follow a child node, since then it may look like the the text\nmay be part of the child node.", + "description": "A core rule nested inside this core rule. It may be displayed as a separate page or its content may be included in this rule's text, which will automatically generate a proper heading. No content node of a type other than\n`Child` should follow a child node, since then it may look like the the text\nmay be part of the child node.", "type": "object", "properties": { "id": { @@ -134,7 +134,7 @@ "$ref": "../_Identifier.schema.json#/$defs/CoreRuleIdentifier" }, "include": { - "description": "If the nested core rule's content should be integrated into this core rule\nand a proper heading should be added. Otherwise create a link to a separate\nview of that core rule.", + "description": "If the nested core rule's content should be integrated into this core rule and a proper heading should be added. Otherwise create a link to a separate view of that core rule.", "type": "boolean" } }, @@ -145,7 +145,7 @@ "additionalProperties": false }, "TextNode": { - "description": "A simple text block, containing one or multiple paragraphs. Headings are not\nallowed, they should be handled as nested core rules instead.", + "description": "A simple text block, containing one or multiple paragraphs. Headings are not allowed, they should be handled as nested core rules instead.", "type": "object", "properties": { "translations": { @@ -1348,11 +1348,11 @@ "type": "object", "properties": { "target": { - "description": "Define if the cost for attributes or skills should be defined. The\ncost for attributes start with value 9, while the cost for skills\nstart with 1 in addition to possible activation cost.", + "description": "Define if the cost for attributes or skills should be defined. The cost for attributes start with value 9, while the cost for skills start with 1 in addition to possible activation cost.", "$ref": "#/$defs/ReferenceListNodeImprovementCostSourceTarget" }, "maximum_rating": { - "description": "The highest value the improvement cost are displayed for.\n\nThe minimum maximum value should depend on what is the upper bound of\nthe range of adventure point cost that are equal across multiple\nvalues (value increases for attributes are always 15 up to (and\nincluding) value 14, while value increases for skills are always 1 to\n4, depending on the improvement cost, up to (and including) value\n12), since those ranges should be combined into a single table row.", + "description": "The highest value the improvement cost are displayed for.\n\nThe minimum maximum value should depend on what is the upper bound of the range of adventure point cost that are equal across multiple values (value increases for attributes are always 15 up to (and including) value 14, while value increases for skills are always 1 to 4, depending on the improvement cost, up to (and including) value 12), since those ranges should be combined into a single table row.", "type": "integer", "minimum": 12 } diff --git a/schema/rule/FocusRule.schema.json b/schema/rule/FocusRule.schema.json index cb5eee74..8254c795 100644 --- a/schema/rule/FocusRule.schema.json +++ b/schema/rule/FocusRule.schema.json @@ -23,7 +23,7 @@ "minimum": 1 }, "is_missing_implementation": { - "description": "Has the focus rule not been implemented in Optolith yet? This is also true\nif the focus rule does not (currently) apply to any Optolith feature.", + "description": "Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature.", "type": "boolean" }, "src": { diff --git a/schema/rule/OptionalRule.schema.json b/schema/rule/OptionalRule.schema.json index fd0b9595..64e5061b 100644 --- a/schema/rule/OptionalRule.schema.json +++ b/schema/rule/OptionalRule.schema.json @@ -13,7 +13,7 @@ "minimum": 1 }, "is_missing_implementation": { - "description": "Has the focus rule not been implemented in Optolith yet? This is also true\nif the focus rule does not (currently) apply to any Optolith feature.", + "description": "Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature.", "type": "boolean" }, "src": { diff --git a/schema/source/Publication.schema.json b/schema/source/Publication.schema.json index 150baaf0..443b4998 100644 --- a/schema/source/Publication.schema.json +++ b/schema/source/Publication.schema.json @@ -21,7 +21,7 @@ "type": "boolean" }, "is_missing_implementation": { - "description": "If the publication is not (fully) implemented and thus needs to be excluded\nfrom * stable releases.", + "description": "If the publication is not (fully) implemented and thus needs to be excluded from * stable releases.", "type": "boolean" }, "prerequisites": { @@ -71,7 +71,7 @@ "format": "date" }, "is_missing_implementation": { - "description": "If this publication translation is not (fully) implemented and thus needs\nto be excluded from stable releases.", + "description": "If this publication translation is not (fully) implemented and thus needs to be excluded from stable releases.", "type": "boolean" } }, diff --git a/schema/source/_PublicationRef.schema.json b/schema/source/_PublicationRef.schema.json index a65740c8..e0e4605b 100644 --- a/schema/source/_PublicationRef.schema.json +++ b/schema/source/_PublicationRef.schema.json @@ -14,7 +14,7 @@ }, "PublicationRef": { "title": "Publication Reference", - "description": "A source reference. It contains the book's publisher identifier and the page\nwhere it occurs. If an entry spans multiple pages, provide the last page as\nwell.", + "description": "A source reference. It contains the book's publisher identifier and the page where it occurs. If an entry spans multiple pages, provide the last page as well.", "type": "object", "properties": { "id": { @@ -65,12 +65,12 @@ "type": "object", "properties": { "first_page": { - "description": "The page where it occurs. If the entry spans multiple pages, use this as\nthe first page and `last_page` as the last page.", + "description": "The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page.", "type": "integer", "minimum": 1 }, "last_page": { - "description": "The last page where it occurs. If there is only one page, set this to the\nsame as `first_page` oder remove it.", + "description": "The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it.", "type": "integer", "minimum": 2 } @@ -89,7 +89,7 @@ "$ref": "#/$defs/InitialOccurrence" }, "revisions": { - "description": "Revisions of the entry, resulting in either changed page references or\nre-addition or removal of an entry.", + "description": "Revisions of the entry, resulting in either changed page references or re-addition or removal of an entry.", "type": "array", "items": { "$ref": "#/$defs/Revision" @@ -107,7 +107,7 @@ "type": "object", "properties": { "printing": { - "description": "The publication's printing since which the entry is present. Leave\nempty if present since the beginning.", + "description": "The publication's printing since which the entry is present. Leave empty if present since the beginning.", "type": "integer", "minimum": 2 }, @@ -127,7 +127,7 @@ }, "Revision": { "title": "Revision", - "description": "A revision of the entry, resulting in either changed page references or\nre-addition or removal of an entry.", + "description": "A revision of the entry, resulting in either changed page references or re-addition or removal of an entry.", "oneOf": [ { "type": "object", @@ -167,7 +167,7 @@ "type": "object", "properties": { "printing": { - "description": "The publication's printing since which the entry is present again or has\nchanged page references.", + "description": "The publication's printing since which the entry is present again or has changed page references.", "type": "integer", "minimum": 2 }, @@ -205,11 +205,11 @@ "type": "object", "properties": { "first_page": { - "description": "The page where it occurs. If the entry spans multiple pages, use this as\nthe first page and `last_page` as the last page.", + "description": "The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page.", "$ref": "#/$defs/Page" }, "last_page": { - "description": "The last page where it occurs. If there is only one page, set this to the\nsame as `first_page` oder remove it.", + "description": "The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it.", "$ref": "#/$defs/Page" } }, diff --git a/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json b/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json index 19bae6c8..f4fa4115 100644 --- a/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json +++ b/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json @@ -81,11 +81,11 @@ "type": "string" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "ap_value_append": { - "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.", + "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueAppend" }, "errata": { diff --git a/schema/specialAbility/BlessedTradition.schema.json b/schema/specialAbility/BlessedTradition.schema.json index d75fd367..f89bd0cc 100644 --- a/schema/specialAbility/BlessedTradition.schema.json +++ b/schema/specialAbility/BlessedTradition.schema.json @@ -20,7 +20,7 @@ "$ref": "../_Activatable.schema.json#/$defs/SkillUses" }, "primary": { - "description": "The tradition's primary attribute. Leave empty if the tradition does not\nhave one.", + "description": "The tradition's primary attribute. Leave empty if the tradition does not have one.", "$ref": "../_SimpleReferences.schema.json#/$defs/AttributeReference" }, "aspects": { @@ -49,7 +49,7 @@ "minItems": 1 }, "favored_skills_selection": { - "description": "On activation of the tradition, a specific number of skills from a list of\nskills must be selected as being favored.", + "description": "On activation of the tradition, a specific number of skills from a list of skills must be selected as being favored.", "$ref": "#/$defs/FavoredSkillsSelection" }, "type": { @@ -57,7 +57,7 @@ "$ref": "#/$defs/BlessedTraditionType" }, "associated_principles_id": { - "description": "The select option's identifier of the disadvantage *Principles* that\nrepresent this tradition's code, if any.", + "description": "The select option's identifier of the disadvantage *Principles* that represent this tradition's code, if any.", "type": "number" }, "prerequisites": { @@ -325,7 +325,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Name" }, "name_compressed": { - "description": "A shorter name of the tradition's name, used in liturgical chant\ndescriptions.", + "description": "A shorter name of the tradition's name, used in liturgical chant descriptions.", "type": "string", "minLength": 1 }, @@ -333,7 +333,7 @@ "$ref": "../_Activatable.schema.json#/$defs/NameInLibrary" }, "special_rules": { - "description": "The special rules of the tradition. They should be sorted like they are\nin the book.", + "description": "The special rules of the tradition. They should be sorted like they are in the book.", "type": "array", "items": { "$ref": "./_Tradition.schema.json#/$defs/SpecialRule" diff --git a/schema/specialAbility/CeremonialItemSpecialAbility.schema.json b/schema/specialAbility/CeremonialItemSpecialAbility.schema.json index 7cf1e84f..b0f8370c 100644 --- a/schema/specialAbility/CeremonialItemSpecialAbility.schema.json +++ b/schema/specialAbility/CeremonialItemSpecialAbility.schema.json @@ -70,7 +70,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Effect" }, "prerequisites": { - "description": "The prerequisites text. It is only used if the text cannot be generated\nfrom the given information.", + "description": "The prerequisites text. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/PrerequisitesReplacement" }, "errata": { diff --git a/schema/specialAbility/CombatStyleSpecialAbility.schema.json b/schema/specialAbility/CombatStyleSpecialAbility.schema.json index 19bc85a0..194923ba 100644 --- a/schema/specialAbility/CombatStyleSpecialAbility.schema.json +++ b/schema/specialAbility/CombatStyleSpecialAbility.schema.json @@ -33,7 +33,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Maximum" }, "advanced": { - "description": "The Advanced Special Abilities for the respective Style Special Ability.\nSometimes, only a specific select option or a set of select options of an\nentry is allowed, which can be modelled by the option property. It can also\nbe that you can choose from a set of special abilities, but then you can't\nspecify an option.", + "description": "The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option.", "type": "array", "items": { "description": "A reference to an advanced special ability.", @@ -76,7 +76,7 @@ "$ref": "../_Identifier.schema.json#/$defs/AdvancedCombatSpecialAbilityIdentifier" }, "option": { - "description": "Specify the select option(s) that only are allowed for the referenced\nadvanced special ability; others are disallowed.", + "description": "Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed.", "type": "array", "items": { "$ref": "../_IdentifierGroup.schema.json#/$defs/AdvancedSpecialAbilityRestrictedOptionIdentifier" @@ -124,7 +124,7 @@ "minItems": 2 }, "is_selection_required_on_purchase": { - "description": "Do have to choose the advanced special ability when buying the style\nspecial ability? Otherwise the decision can be made later.", + "description": "Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later.", "type": "boolean" }, "display_option": { @@ -161,7 +161,7 @@ "description": "Map options from the external entry to allowed advanced special abilities.", "type": "array", "items": { - "description": "Mapping from an option of the external entry to an allowed advanced special\nability.", + "description": "Mapping from an option of the external entry to an allowed advanced special ability.", "type": "object", "properties": { "from_option": { diff --git a/schema/specialAbility/FatePointSpecialAbility.schema.json b/schema/specialAbility/FatePointSpecialAbility.schema.json index 29b11715..94f6e049 100644 --- a/schema/specialAbility/FatePointSpecialAbility.schema.json +++ b/schema/specialAbility/FatePointSpecialAbility.schema.json @@ -67,7 +67,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/specialAbility/GeneralSpecialAbility.schema.json b/schema/specialAbility/GeneralSpecialAbility.schema.json index e10b29fb..a1db6afa 100644 --- a/schema/specialAbility/GeneralSpecialAbility.schema.json +++ b/schema/specialAbility/GeneralSpecialAbility.schema.json @@ -71,7 +71,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value_append": { - "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.", + "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueAppend" }, "errata": { diff --git a/schema/specialAbility/KarmaSpecialAbility.schema.json b/schema/specialAbility/KarmaSpecialAbility.schema.json index 0b8780dc..639b9ec7 100644 --- a/schema/specialAbility/KarmaSpecialAbility.schema.json +++ b/schema/specialAbility/KarmaSpecialAbility.schema.json @@ -61,7 +61,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/specialAbility/LiturgicalStyleSpecialAbility.schema.json b/schema/specialAbility/LiturgicalStyleSpecialAbility.schema.json index 7cecf78b..632fce03 100644 --- a/schema/specialAbility/LiturgicalStyleSpecialAbility.schema.json +++ b/schema/specialAbility/LiturgicalStyleSpecialAbility.schema.json @@ -26,7 +26,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Maximum" }, "advanced": { - "description": "The Advanced Special Abilities for the respective Style Special Ability.\nSometimes, only a specific select option or a set of select options of an\nentry is allowed, which can be modelled by the option property. It can also\nbe that you can choose from a set of special abilities, but then you can't\nspecify an option.", + "description": "The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option.", "type": "array", "items": { "description": "A reference to an advanced special ability.", @@ -69,7 +69,7 @@ "$ref": "../_Identifier.schema.json#/$defs/AdvancedKarmaSpecialAbilityIdentifier" }, "option": { - "description": "Specify the select option(s) that only are allowed for the referenced\nadvanced special ability; others are disallowed.", + "description": "Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed.", "type": "array", "items": { "$ref": "../_IdentifierGroup.schema.json#/$defs/AdvancedSpecialAbilityRestrictedOptionIdentifier" @@ -117,7 +117,7 @@ "minItems": 2 }, "is_selection_required_on_purchase": { - "description": "Do have to choose the advanced special ability when buying the style\nspecial ability? Otherwise the decision can be made later.", + "description": "Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later.", "type": "boolean" }, "display_option": { @@ -154,7 +154,7 @@ "description": "Map options from the external entry to allowed advanced special abilities.", "type": "array", "items": { - "description": "Mapping from an option of the external entry to an allowed advanced special\nability.", + "description": "Mapping from an option of the external entry to an allowed advanced special ability.", "type": "object", "properties": { "from_option": { diff --git a/schema/specialAbility/MagicStyleSpecialAbility.schema.json b/schema/specialAbility/MagicStyleSpecialAbility.schema.json index 402995ca..4cd953ca 100644 --- a/schema/specialAbility/MagicStyleSpecialAbility.schema.json +++ b/schema/specialAbility/MagicStyleSpecialAbility.schema.json @@ -26,7 +26,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Maximum" }, "advanced": { - "description": "The Advanced Special Abilities for the respective Style Special Ability.\nSometimes, only a specific select option or a set of select options of an\nentry is allowed, which can be modelled by the option property. It can also\nbe that you can choose from a set of special abilities, but then you can't\nspecify an option.", + "description": "The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option.", "type": "array", "items": { "description": "A reference to an advanced special ability.", @@ -69,7 +69,7 @@ "$ref": "../_Identifier.schema.json#/$defs/AdvancedMagicalSpecialAbilityIdentifier" }, "option": { - "description": "Specify the select option(s) that only are allowed for the referenced\nadvanced special ability; others are disallowed.", + "description": "Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed.", "type": "array", "items": { "$ref": "../_IdentifierGroup.schema.json#/$defs/AdvancedSpecialAbilityRestrictedOptionIdentifier" @@ -117,7 +117,7 @@ "minItems": 2 }, "is_selection_required_on_purchase": { - "description": "Do have to choose the advanced special ability when buying the style\nspecial ability? Otherwise the decision can be made later.", + "description": "Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later.", "type": "boolean" }, "display_option": { @@ -154,7 +154,7 @@ "description": "Map options from the external entry to allowed advanced special abilities.", "type": "array", "items": { - "description": "Mapping from an option of the external entry to an allowed advanced special\nability.", + "description": "Mapping from an option of the external entry to an allowed advanced special ability.", "type": "object", "properties": { "from_option": { diff --git a/schema/specialAbility/MagicalSpecialAbility.schema.json b/schema/specialAbility/MagicalSpecialAbility.schema.json index 166f5f0e..a72a0bb1 100644 --- a/schema/specialAbility/MagicalSpecialAbility.schema.json +++ b/schema/specialAbility/MagicalSpecialAbility.schema.json @@ -71,7 +71,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/specialAbility/MagicalTradition.schema.json b/schema/specialAbility/MagicalTradition.schema.json index 45e24d54..f0ad2b77 100644 --- a/schema/specialAbility/MagicalTradition.schema.json +++ b/schema/specialAbility/MagicalTradition.schema.json @@ -23,7 +23,7 @@ "$ref": "../_Activatable.schema.json#/$defs/SkillUses" }, "primary": { - "description": "The tradition's primary attribute. Leave empty if the tradition does not\nhave one.", + "description": "The tradition's primary attribute. Leave empty if the tradition does not have one.", "$ref": "#/$defs/PrimaryAttribute" }, "can_learn_cantrips": { @@ -43,18 +43,18 @@ "type": "boolean" }, "allows_multiple_traditions": { - "description": "Does the tradition allow learning more traditions or having learned a\ndifferent tradition before learning this tradition?", + "description": "Does the tradition allow learning more traditions or having learned a different tradition before learning this tradition?", "type": "boolean" }, "alternative_magical_adventure_points_maximum": { - "description": "Is the maximum AP you're able to spent on magical advantages and able to\nget by magical disadvantages different than the default of 50 AP?", + "description": "Is the maximum AP you're able to spent on magical advantages and able to get by magical disadvantages different than the default of 50 AP?", "type": "integer", "maximum": 30, "minimum": 25, "multipleOf": 5 }, "require_non_spellwork_exclusive_effects": { - "description": "Are advantages/disadvantages required to not exclusively apply to arcane\nspellworks, but also to the tradition's magical actions or applications?", + "description": "Are advantages/disadvantages required to not exclusively apply to arcane spellworks, but also to the tradition's magical actions or applications?", "type": "boolean" }, "is_magical_dilettante": { @@ -62,7 +62,7 @@ "type": "boolean" }, "use_arcane_spellworks_from_tradition": { - "description": "If arcane spellworks from a different tradition count as arcane spellworks\nof this tradition, this is the different tradition's reference.", + "description": "If arcane spellworks from a different tradition count as arcane spellworks of this tradition, this is the different tradition's reference.", "$ref": "../_SimpleReferences.schema.json#/$defs/MagicalTraditionReference" }, "influences": { @@ -117,7 +117,7 @@ "$ref": "../_Identifier.schema.json#/$defs/AttributeIdentifier" }, "use_half_for_arcane_energy": { - "description": "Typically, the value of the primary attribute (if one exists) is added\nonto the base of 20 AE to get the actual AE. But sometimes, only half the\nvalue is added.", + "description": "Typically, the value of the primary attribute (if one exists) is added onto the base of 20 AE to get the actual AE. But sometimes, only half the value is added.", "type": "boolean" } }, @@ -134,7 +134,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Name" }, "name_for_arcane_spellworks": { - "description": "The name used for the traditions list of arcane spellworks if it is\ndifferent than the `name` of the special ability.", + "description": "The name used for the traditions list of arcane spellworks if it is different than the `name` of the special ability.", "type": "string", "minLength": 1 }, @@ -142,7 +142,7 @@ "$ref": "../_Activatable.schema.json#/$defs/NameInLibrary" }, "special_rules": { - "description": "The special rules of the tradition. They should be sorted like they are\nin the book.", + "description": "The special rules of the tradition. They should be sorted like they are in the book.", "type": "array", "items": { "$ref": "./_Tradition.schema.json#/$defs/SpecialRule" diff --git a/schema/specialAbility/PactGift.schema.json b/schema/specialAbility/PactGift.schema.json index ca2149c1..62891998 100644 --- a/schema/specialAbility/PactGift.schema.json +++ b/schema/specialAbility/PactGift.schema.json @@ -23,7 +23,7 @@ "$ref": "#/$defs/PactGiftPermanentDemonicConsumption" }, "automatic_entries": { - "description": "This pact gift has direct influence on the existence of other entries. It\nmay add or remove entries.", + "description": "This pact gift has direct influence on the existence of other entries. It may add or remove entries.", "type": "array", "items": { "$ref": "#/$defs/AutomaticEntry" @@ -114,7 +114,7 @@ "type": "object", "properties": { "levels": { - "description": "The levels of *Demonic Consumption* the pact gift causes per activated\nlevel of the pact gift.", + "description": "The levels of *Demonic Consumption* the pact gift causes per activated level of the pact gift.", "type": "integer", "maximum": 4, "minimum": 1 @@ -133,11 +133,11 @@ "$ref": "#/$defs/AutomaticEntryAction" }, "apply_ap_value": { - "description": "If an entry is added or removed, does is cost or grant adventure points\nor is it free of charge?", + "description": "If an entry is added or removed, does is cost or grant adventure points or is it free of charge?", "type": "boolean" }, "target": { - "description": "The entry that is to be added or removed. It can be a fixed entry or a\nselection where the player must choose one entry.", + "description": "The entry that is to be added or removed. It can be a fixed entry or a selection where the player must choose one entry.", "$ref": "#/$defs/AutomaticEntryTarget" } }, diff --git a/schema/specialAbility/SikaryanDrainSpecialAbility.schema.json b/schema/specialAbility/SikaryanDrainSpecialAbility.schema.json index be7fe112..73dcbe0f 100644 --- a/schema/specialAbility/SikaryanDrainSpecialAbility.schema.json +++ b/schema/specialAbility/SikaryanDrainSpecialAbility.schema.json @@ -61,7 +61,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/specialAbility/SkillStyleSpecialAbility.schema.json b/schema/specialAbility/SkillStyleSpecialAbility.schema.json index ab4589bc..a5d6f3d0 100644 --- a/schema/specialAbility/SkillStyleSpecialAbility.schema.json +++ b/schema/specialAbility/SkillStyleSpecialAbility.schema.json @@ -20,7 +20,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Maximum" }, "advanced": { - "description": "The Advanced Special Abilities for the respective Style Special Ability.\nSometimes, only a specific select option or a set of select options of an\nentry is allowed, which can be modelled by the option property. It can also\nbe that you can choose from a set of special abilities, but then you can't\nspecify an option.", + "description": "The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option.", "type": "array", "items": { "description": "A reference to an advanced special ability.", @@ -63,7 +63,7 @@ "$ref": "../_Identifier.schema.json#/$defs/AdvancedSkillSpecialAbilityIdentifier" }, "option": { - "description": "Specify the select option(s) that only are allowed for the referenced\nadvanced special ability; others are disallowed.", + "description": "Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed.", "type": "array", "items": { "$ref": "../_IdentifierGroup.schema.json#/$defs/AdvancedSpecialAbilityRestrictedOptionIdentifier" @@ -111,7 +111,7 @@ "minItems": 2 }, "is_selection_required_on_purchase": { - "description": "Do have to choose the advanced special ability when buying the style\nspecial ability? Otherwise the decision can be made later.", + "description": "Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later.", "type": "boolean" }, "display_option": { @@ -148,7 +148,7 @@ "description": "Map options from the external entry to allowed advanced special abilities.", "type": "array", "items": { - "description": "Mapping from an option of the external entry to an allowed advanced special\nability.", + "description": "Mapping from an option of the external entry to an allowed advanced special ability.", "type": "object", "properties": { "from_option": { diff --git a/schema/specialAbility/VampiricGift.schema.json b/schema/specialAbility/VampiricGift.schema.json index 150029c2..48871a86 100644 --- a/schema/specialAbility/VampiricGift.schema.json +++ b/schema/specialAbility/VampiricGift.schema.json @@ -61,7 +61,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Rules" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/specialAbility/_Tradition.schema.json b/schema/specialAbility/_Tradition.schema.json index 68d0dddf..7d9ed481 100644 --- a/schema/specialAbility/_Tradition.schema.json +++ b/schema/specialAbility/_Tradition.schema.json @@ -6,7 +6,7 @@ "type": "object", "properties": { "label": { - "description": "An optional label that is displayed and placed before the actual\ntext.", + "description": "An optional label that is displayed and placed before the actual text.", "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "text": { diff --git a/schema/specialAbility/sub/Language.schema.json b/schema/specialAbility/sub/Language.schema.json index d6af7293..a8616b3a 100644 --- a/schema/specialAbility/sub/Language.schema.json +++ b/schema/specialAbility/sub/Language.schema.json @@ -21,14 +21,14 @@ "minItems": 1 }, "specializations": { - "description": "Language-specific specializations. Either a list of possible options or a\nindefinite description of what may be a specialization.", + "description": "Language-specific specializations. Either a list of possible options or a indefinite description of what may be a specialization.", "$ref": "#/$defs/Specializations" }, "prerequisites": { "$ref": "../../_Prerequisite.schema.json#/$defs/LanguagePrerequisites" }, "max_level": { - "description": "The maximum possible level of the language. Only specified if lower than\ndefault of 3.", + "description": "The maximum possible level of the language. Only specified if lower than default of 3.", "type": "number", "default": 3, "maximum": 2, @@ -144,7 +144,7 @@ "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "description": { - "description": "The specialization description. It will be appended to the name in\nparenthesis.", + "description": "The specialization description. It will be appended to the name in parenthesis.", "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, @@ -181,7 +181,7 @@ "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString" }, "label": { - "description": "An input label or placeholder text for an UI element if it differs\nfrom the `description`.", + "description": "An input label or placeholder text for an UI element if it differs from the `description`.", "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString" } }, diff --git a/schema/traditionArtifacts/CauldronEnchantment.schema.json b/schema/traditionArtifacts/CauldronEnchantment.schema.json index f4d68223..ed63fc6b 100644 --- a/schema/traditionArtifacts/CauldronEnchantment.schema.json +++ b/schema/traditionArtifacts/CauldronEnchantment.schema.json @@ -26,7 +26,7 @@ "$ref": "../_Activatable.schema.json#/$defs/Volume" }, "brew": { - "description": "Witches can learn to brew special things in their Witch's Cauldron. These\nbrews can be categorized in different types.", + "description": "Witches can learn to brew special things in their Witch's Cauldron. These brews can be categorized in different types.", "$ref": "#/$defs/BrewReference" }, "cost": { diff --git a/schema/traditionArtifacts/SpellSwordEnchantment.schema.json b/schema/traditionArtifacts/SpellSwordEnchantment.schema.json index a760466a..54102be8 100644 --- a/schema/traditionArtifacts/SpellSwordEnchantment.schema.json +++ b/schema/traditionArtifacts/SpellSwordEnchantment.schema.json @@ -81,7 +81,7 @@ "type": "string" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/schema/traditionArtifacts/StaffEnchantment.schema.json b/schema/traditionArtifacts/StaffEnchantment.schema.json index 1fe31e09..dd14fec4 100644 --- a/schema/traditionArtifacts/StaffEnchantment.schema.json +++ b/schema/traditionArtifacts/StaffEnchantment.schema.json @@ -85,7 +85,7 @@ "type": "string" }, "ap_value": { - "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.", + "description": "The AP value. It is only used if the text cannot be generated from the given information.", "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement" }, "errata": { diff --git a/src/types/Advantage.ts b/src/types/Advantage.ts index 78633d41..4eea0e84 100644 --- a/src/types/Advantage.ts +++ b/src/types/Advantage.ts @@ -34,15 +34,13 @@ export type Advantage = { ap_value: Activatable.AdventurePointsValue /** - * Does this advantage count towards the maximum of AP to be spent on - * advantages? + * Does this advantage count towards the maximum of AP to be spent on advantages? * @default true */ has_maximum_spent_influence: boolean /** - * Does this advantage exclusively applies to arcane spellworks and not - * to magical actions and magical applications? + * Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications? * @default false */ is_exclusive_to_arcane_spellworks: boolean @@ -83,9 +81,7 @@ export type AdvantageTranslation = { ap_value?: Activatable.AdventurePointsValueReplacement /** - * A string that gets appended to the default AP Value text with a preceding - * space. This always happens if present, even if the generated AP Value text - * is replaced. + * A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. */ ap_value_append?: Activatable.AdventurePointsValueAppend diff --git a/src/types/AnimalDisease.ts b/src/types/AnimalDisease.ts index 69effd5f..b57be4b8 100644 --- a/src/types/AnimalDisease.ts +++ b/src/types/AnimalDisease.ts @@ -31,16 +31,12 @@ export type AnimalDisease = { level: number /** - * Depending on the disease, apply Spirit or Toughness as a penalty to the - * disease roll. It may also happen that the lower of both is applied as a - * penalty. + * Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. */ resistance: Resistance /** - * What causes the disease? The GM rolls 1D20 to see if a character gets - * infected. If the infection check succeeds, the GM makes a disease check to - * determine the severity of the infection. + * What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. * @minItems 1 */ cause: Cause[] @@ -48,17 +44,14 @@ export type AnimalDisease = { /** * The animal types this disease applies to. * - * If no animal types are given, the animal disease applies to all animal - * types. + * If no animal types are given, the animal disease applies to all animal types. */ animal_types: AnimalTypeReference[] /** - * If and at which chance the disease can be communicated to intelligent - * creatures. + * If and at which chance the disease can be communicated to intelligent creatures. * - * If no causes are given, the disease is not communicable to intelligent - * creatures. + * If no causes are given, the disease is not communicable to intelligent creatures. */ communicability_to_intelligent_creatures: Cause[] diff --git a/src/types/Aspect.ts b/src/types/Aspect.ts index 9cabf1ea..0a667c90 100644 --- a/src/types/Aspect.ts +++ b/src/types/Aspect.ts @@ -34,8 +34,7 @@ export type AspectTranslation = { name: NonEmptyString /** - * The aspect's name appended to the simple name (not `name_in_library`) - * of the special ability *Master of (Aspect)*. + * The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*. */ master_of_aspect_suffix?: NonEmptyString } diff --git a/src/types/Cantrip.ts b/src/types/Cantrip.ts index 7ffd5997..86ce03cd 100644 --- a/src/types/Cantrip.ts +++ b/src/types/Cantrip.ts @@ -50,10 +50,7 @@ export type Cantrip = { property: PropertyReference /** - * A note specifying the dissemination of the cantrip in different traditions. - * Sometimes a cantrip is exclusively available to one or more specific - * traditions, but usually one the academies and traditions are listed the - * cantrip is most commonly teached in. + * A note specifying the dissemination of the cantrip in different traditions. Sometimes a cantrip is exclusively available to one or more specific traditions, but usually one the academies and traditions are listed the cantrip is most commonly teached in. */ note?: CantripNote diff --git a/src/types/Ceremony.ts b/src/types/Ceremony.ts index 4ebd772b..bdcb2bc3 100644 --- a/src/types/Ceremony.ts +++ b/src/types/Ceremony.ts @@ -52,9 +52,7 @@ export type Ceremony = { target: AffectedTargetCategories /** - * The tradition(s) the ceremony is available for. Note that general aspects - * do not have an associated tradition and thus need to be defined in a - * special way. + * The tradition(s) the ceremony is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. * @minItems 1 */ traditions: SkillTradition[] @@ -83,16 +81,12 @@ export type CeremonyTranslation = { name: NonEmptyString /** - * A compressed name of the ceremony for use in small areas (e.g. on - * character sheet). Should only be defined if the `name` does not fit on - * character sheet. + * A compressed name of the ceremony for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. */ name_compressed?: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/CombatTechnique_Close.ts b/src/types/CombatTechnique_Close.ts index b06bdf9f..a7d8e00d 100644 --- a/src/types/CombatTechnique_Close.ts +++ b/src/types/CombatTechnique_Close.ts @@ -25,8 +25,7 @@ export type CloseCombatTechnique = { id: number /** - * Special rules for the combat technique that apply to all weapons in this - * category. + * Special rules for the combat technique that apply to all weapons in this category. */ special: CloseCombatTechniqueSpecialRules @@ -56,8 +55,7 @@ export type CloseCombatTechnique = { } /** - * Special rules for the combat technique that apply to all weapons in this - * category. + * Special rules for the combat technique that apply to all weapons in this category. */ export type CloseCombatTechniqueSpecialRules = { /** @@ -91,7 +89,11 @@ export type CloseCombatTechniqueTranslation = { errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + CloseCombatTechnique, + CloseCombatTechnique["id"], + "CloseCombatTechnique" +> = { name: "CloseCombatTechnique", id: getFilenamePrefixAsNumericId, integrityValidator: todo("CloseCombatTechnique"), diff --git a/src/types/CombatTechnique_Ranged.ts b/src/types/CombatTechnique_Ranged.ts index ba91ee3f..800acb82 100644 --- a/src/types/CombatTechnique_Ranged.ts +++ b/src/types/CombatTechnique_Ranged.ts @@ -25,8 +25,7 @@ export type RangedCombatTechnique = { id: number /** - * Special rules for the combat technique that apply to all weapons in this - * category. + * Special rules for the combat technique that apply to all weapons in this category. */ special: RangedCombatTechniqueSpecialRules @@ -56,8 +55,7 @@ export type RangedCombatTechnique = { } /** - * Special rules for the combat technique that apply to all weapons in this - * category. + * Special rules for the combat technique that apply to all weapons in this category. */ export type RangedCombatTechniqueSpecialRules = { has_ammunition: boolean @@ -80,7 +78,11 @@ export type RangedCombatTechniqueTranslation = { errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + RangedCombatTechnique, + RangedCombatTechnique["id"], + "RangedCombatTechnique" +> = { name: "RangedCombatTechnique", id: getFilenamePrefixAsNumericId, integrityValidator: todo("RangedCombatTechnique"), diff --git a/src/types/Continent.ts b/src/types/Continent.ts index ec0fe215..ecbd719b 100644 --- a/src/types/Continent.ts +++ b/src/types/Continent.ts @@ -10,8 +10,7 @@ import { getFilenamePrefixAsNumericId } from "../validation/filename.js" import { LocaleMap } from "./_LocaleMap.js" /** - * Continents are mostly referenced to in languages and scripts that occur on a - * specific continent. + * Continents are mostly referenced to in languages and scripts that occur on a specific continent. * @title Continent */ export type Continent = { diff --git a/src/types/Culture.ts b/src/types/Culture.ts index e5e0c520..1d9054e5 100644 --- a/src/types/Culture.ts +++ b/src/types/Culture.ts @@ -8,11 +8,25 @@ import { validateEntityFileName } from "../validation/builders/naming.js" import { createSchemaValidator } from "../validation/builders/schema.js" import { getFilenamePrefixAsNumericId } from "../validation/filename.js" import { CommonnessRatedAdvantageDisadvantage } from "./_CommonnessRatedAdvantageDisadvantage.js" -import { AdvantageIdentifier, BlessedTraditionIdentifier, DisadvantageIdentifier, MagicalTraditionIdentifier, ProfessionIdentifier, SkillIdentifier } from "./_Identifier.js" +import { + AdvantageIdentifier, + BlessedTraditionIdentifier, + DisadvantageIdentifier, + MagicalTraditionIdentifier, + ProfessionIdentifier, + SkillIdentifier, +} from "./_Identifier.js" import { LocaleMap } from "./_LocaleMap.js" import { NonEmptyString } from "./_NonEmptyString.js" import { BinarySex } from "./_Sex.js" -import { LanguageReference, ProfessionReference, ProfessionVariantReference, ScriptReference, SkillReference, SocialStatusReference } from "./_SimpleReferences.js" +import { + LanguageReference, + ProfessionReference, + ProfessionVariantReference, + ScriptReference, + SkillReference, + SocialStatusReference, +} from "./_SimpleReferences.js" import { Errata } from "./source/_Erratum.js" import { PublicationRefs } from "./source/_PublicationRef.js" @@ -34,8 +48,7 @@ export type Culture = { language: LanguageReference[] /** - * A list of native scripts (usually it is only one). If the culture does not - * use any script, leave this field empty. + * A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty. * @minItems 1 */ script?: ScriptReference[] @@ -52,10 +65,7 @@ export type Culture = { social_status: SocialStatusReference[] /** - * A list of professions that are typical for the culture, as well as - * professions that are rarely practiced or encountered in the culture. The - * list is either defined by group (as multiple lists) or plain (as a single - * list). + * A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). */ common_professions: CommonProfessions @@ -121,18 +131,12 @@ export type AreaKnowledge = { } /** - * The "weight" difference compared to other professions or profession variants. - * Some professions or profession variants are simply more common (Mostly), but - * sometimes only specific elements are used (Only). + * The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only). */ -export type CommonnessWeight = - | "Mostly" - | "Only" +export type CommonnessWeight = "Mostly" | "Only" /** - * Some professions or profession variants are more common than others. There - * may be cultures where some professions or profession variants are not - * represented at all. + * Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all. */ export type Weighted = { /** @@ -142,26 +146,19 @@ export type Weighted = { elements: ProfessionOrVariant[] /** - * The "weight" difference compared to other professions or profession - * variants. Some professions or profession variants are simply more common + * The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common * (Mostly), but sometimes only specific elements are used (Only). */ weight: CommonnessWeight } /** - * This defines how the list of constraints should be offset against the - * list of all mundane professions: Either only the professions are kept - * that intersect with the constraints (include) or only the professions - * are kept that are different from the constraints (exclude). + * This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). */ -export type CommonProfessionConstraintsOperation = - | "Intersection" - | "Difference" +export type CommonProfessionConstraintsOperation = "Intersection" | "Difference" /** - * A list of professions. The filter specifies how the list is applied to - * all mundane professions. + * A list of professions. The filter specifies how the list is applied to all mundane professions. */ export type CommonProfessionConstraints = { /** @@ -171,10 +168,7 @@ export type CommonProfessionConstraints = { constraints: Constraint[] /** - * This defines how the list of constraints should be offset against the - * list of all mundane professions: Either only the professions are kept - * that intersect with the constraints (include) or only the professions - * are kept that are different from the constraints (exclude). + * This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude). */ operation: CommonProfessionConstraintsOperation } @@ -182,9 +176,7 @@ export type CommonProfessionConstraints = { /** * Some professions may be found in a culture, but are not that common. */ -export type Rarity = - | "Rare" - | "VeryRare" +export type Rarity = "Rare" | "VeryRare" export type ProfessionConstraint = { /** @@ -193,14 +185,12 @@ export type ProfessionConstraint = { id: ProfessionIdentifier /** - * Some profession variants are more common than others. There may be - * cultures where some variants are not represented at all. + * Some profession variants are more common than others. There may be cultures where some variants are not represented at all. */ weighted_variants?: Weighted /** - * Some professions may be found in a culture, but are not that - * common. + * Some professions may be found in a culture, but are not that common. */ rarity?: Rarity } @@ -208,10 +198,7 @@ export type ProfessionConstraint = { /** * Some professions may be found in a culture, but are not that common. */ -export type MundaneProfessionSubgroupConstraint = - | "Profane" - | "Fighter" - | "Religious" +export type MundaneProfessionSubgroupConstraint = "Profane" | "Fighter" | "Religious" export type MagicalTraditionConstraint = { /** @@ -220,8 +207,7 @@ export type MagicalTraditionConstraint = { id: MagicalTraditionIdentifier /** - * Some professions are more common than others. There may be cultures - * where some professions are not represented at all. + * Some professions are more common than others. There may be cultures where some professions are not represented at all. */ weighted_professions?: Weighted @@ -238,8 +224,7 @@ export type BlessedTraditionConstraint = { id: BlessedTraditionIdentifier /** - * Some professions are more common than others. There may be cultures - * where some professions are not represented at all. + * Some professions are more common than others. There may be cultures where some professions are not represented at all. */ weighted_professions?: Weighted @@ -258,8 +243,10 @@ export type MagicCommonProfessionConstraint = | { tag: "MagicDilettante"; magic_dilettante: {} } | { tag: "Profession"; profession: ProfessionConstraint } -export type BlessedCommonProfessionConstraint = - | { tag: "Tradition"; tradition: BlessedTraditionConstraint } +export type BlessedCommonProfessionConstraint = { + tag: "Tradition" + tradition: BlessedTraditionConstraint +} export type PlainCommonProfessions = CommonProfessionConstraints @@ -274,10 +261,7 @@ export type GroupedCommonProfessions = { } /** - * A list of professions that are typical for the culture, as well as - * professions that are rarely practiced or encountered in the culture. The - * list is either defined by group (as multiple lists) or plain (as a single - * list). + * A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list). */ export type CommonProfessions = | { tag: "Plain"; plain: PlainCommonProfessions } @@ -294,8 +278,7 @@ export type CulturalPackageItem = { id: SkillIdentifier /** - * The skill points for the respective skill you get for buying the cultural - * package. + * The skill points for the respective skill you get for buying the cultural package. * @integer * @minimum 1 * @maximum 2 @@ -354,8 +337,7 @@ type AreaKnowledgeTranslation = { description: string /** - * A shorter version of the description, used in input fields and other UI - * elements where the space might be to small to use the full description. + * A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description. * @minLength 1 */ abbreviated: string @@ -380,15 +362,13 @@ export type AreaKnowledgeExample = { */ export type CommonNames = { /** - * First names can be gender-neutral, but they can also be for a specific - * binary sex. They are sorted into groups. + * First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups. * @minItems 1 */ first_name_groups?: CommonNameGroup[] /** - * Last names can be gender-neutral, like family names, but they can also be - * for a specific binary sex. They are sorted into groups. + * Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups. * @minItems 1 */ last_name_groups?: CommonNameGroup[] diff --git a/src/types/Disadvantage.ts b/src/types/Disadvantage.ts index a430801e..27a3be29 100644 --- a/src/types/Disadvantage.ts +++ b/src/types/Disadvantage.ts @@ -30,14 +30,12 @@ export type Disadvantage = { ap_value: Activatable.AdventurePointsValue /** - * Does this disadvantage count towards the maximum of AP to be spent on - * disadvantages? + * Does this disadvantage count towards the maximum of AP to be spent on disadvantages? */ has_maximum_spent_influence: boolean /** - * Does this disadvantage exclusively applies to arcane spellworks and not - * to magical actions and magical applications? + * Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications? */ is_exclusive_to_arcane_spellworks: boolean @@ -77,9 +75,7 @@ export type DisadvantageTranslation = { // ap_value?: Activatable.AdventurePointsValueReplacement /** - * A string that gets appended to the default AP Value text with a preceding - * space. This always happens if present, even if the generated AP Value text - * is replaced. + * A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. */ ap_value_append?: Activatable.AdventurePointsValueAppend diff --git a/src/types/Disease.ts b/src/types/Disease.ts index 62b26a6b..ddc2fbcf 100644 --- a/src/types/Disease.ts +++ b/src/types/Disease.ts @@ -30,16 +30,12 @@ export type Disease = { level: number /** - * Depending on the disease, apply Spirit or Toughness as a penalty to the - * disease roll. It may also happen that the lower of both is applied as a - * penalty. + * Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. */ resistance: Resistance /** - * What causes the disease? The GM rolls 1D20 to see if a character gets - * infected. If the infection check succeeds, the GM makes a disease check to - * determine the severity of the infection. + * What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. * @minItems 1 */ cause: Cause[] diff --git a/src/types/FamiliarsTrick.ts b/src/types/FamiliarsTrick.ts index 5c2ae1bd..fc216ef9 100644 --- a/src/types/FamiliarsTrick.ts +++ b/src/types/FamiliarsTrick.ts @@ -27,11 +27,9 @@ export type FamiliarsTrick = { id: number /** - * The animal types this trick is available to. Either it is available to all - * or only a list of specific animal types. + * The animal types this trick is available to. Either it is available to all or only a list of specific animal types. * - * If no animal types are given, the animal disease applies to all animal - * types. + * If no animal types are given, the animal disease applies to all animal types. */ animal_types: AnimalTypeReference[] @@ -46,8 +44,7 @@ export type FamiliarsTrick = { property: FamiliarsTrickProperty /** - * The AP value the familiar has to pay for. It may also be that a specific is - * known by all familiar by default. In the latter case the field is not set. + * The AP value the familiar has to pay for. It may also be that a specific is known by all familiar by default. In the latter case the field is not set. * @integer * @minimum 1 */ @@ -156,8 +153,7 @@ export type FamiliarsTrickFixedOneTimeCost = { export type FamiliarsTrickFixedOneTimeCostTranslation = { /** - * The cost have to be per a specific countable entity, e.g. `8 KP - * per person`. + * The cost have to be per a specific countable entity, e.g. `8 KP per person`. */ per?: ResponsiveTextOptional } diff --git a/src/types/Lessons_Curriculum.ts b/src/types/Lessons_Curriculum.ts index f30a7687..7d0a6ec1 100644 --- a/src/types/Lessons_Curriculum.ts +++ b/src/types/Lessons_Curriculum.ts @@ -21,9 +21,7 @@ import { Errata } from "./source/_Erratum.js" import { PublicationRefs } from "./source/_PublicationRef.js" /** - * This is a curriculum of a specified academy, containing the guideline, - * elective and restricted spellworks as well as the lesson packages of that - * academy. + * This is a curriculum of a specified academy, containing the guideline, elective and restricted spellworks as well as the lesson packages of that academy. * @title Curriculum */ export type Curriculum = { @@ -89,19 +87,13 @@ export type ElectiveSpellwork = { id: SpellworkIdentifier /** - * The elective spellwork may only take effect if a certain condition is met. - * The condition may be related to professions or profession variants, but it - * is designed so that it can work without a specific profession, as multiple - * may belong to an institute, but with referencing other entities instead. + * The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. */ restriction?: ElectiveSpellworkRestriction } /** - * The elective spellwork may only take effect if a certain condition is met. - * The condition may be related to professions or profession variants, but it is - * designed so that it can work without a specific profession, as multiple may - * belong to an institute, but with referencing other entities instead. + * The elective spellwork may only take effect if a certain condition is met. The condition may be related to professions or profession variants, but it is designed so that it can work without a specific profession, as multiple may belong to an institute, but with referencing other entities instead. */ export type ElectiveSpellworkRestriction = { tag: "Element" @@ -143,9 +135,7 @@ export type RestrictedProperty = { exclude?: SpellworkIdentifier[] /** - * Spellworks from this property up to a certain number are allowed. - * Spellworks excluded from this restriction definition using `exclude` do - * not contribute to the maximum. + * Spellworks from this property up to a certain number are allowed. Spellworks excluded from this restriction definition using `exclude` do not contribute to the maximum. */ maximum?: number } @@ -170,10 +160,7 @@ export type LessonPackage = { id: number /** - * The spell values difference of the lesson package. This field reflects the - * changes (difference) to the field of the same name in the profession - * package. If a spell gets to SR 0 because of this, it will be removed - * completely. + * The spell values difference of the lesson package. This field reflects the changes (difference) to the field of the same name in the profession package. If a spell gets to SR 0 because of this, it will be removed completely. * @minItems 1 */ spellwork_changes?: SpellworkChange[] @@ -198,8 +185,7 @@ export type LessonPackageTranslation = { name: NonEmptyString /** - * The spell values difference of the lesson package. Use this field to - * specify a text that is displayed instead of the generated + * The spell values difference of the lesson package. Use this field to specify a text that is displayed instead of the generated * `spellwork_changes` list. The field is displayed even if no list is * present. */ @@ -215,8 +201,7 @@ export type CombatTechniqueAdjustment = { id: CombatTechniqueIdentifier /** - * The combat technique points that will be added to the current combat - * technique rating. + * The combat technique points that will be added to the current combat technique rating. * @integer * @minimum -6 * @maximum 6 @@ -245,9 +230,7 @@ export type SpellworkAdjustment = { id: SpellworkIdentifier /** - * The skill points that will be added to the current skill rating. If a - * spell gets to a skill rating of 0 because of this, it will be removed - * completely. + * The skill points that will be added to the current skill rating. If a spell gets to a skill rating of 0 because of this, it will be removed completely. * @integer * @minimum -10 * @maximum 10 @@ -255,8 +238,7 @@ export type SpellworkAdjustment = { points: number /** - * The target tradition. If the target spell is not from the Guild Mage - * tradition, specify the tradition identifier here. + * The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here. */ tradition?: MagicalTraditionIdentifier } diff --git a/src/types/LiturgicalChant.ts b/src/types/LiturgicalChant.ts index 98b26ad6..beea4735 100644 --- a/src/types/LiturgicalChant.ts +++ b/src/types/LiturgicalChant.ts @@ -52,9 +52,7 @@ export type LiturgicalChant = { target: AffectedTargetCategories /** - * The tradition(s) the liturgical chant is available for. Note that general - * aspects do not have an associated tradition and thus need to be defined in - * a special way. + * The tradition(s) the liturgical chant is available for. Note that general aspects do not have an associated tradition and thus need to be defined in a special way. * @minItems 1 */ traditions: SkillTradition[] @@ -83,16 +81,12 @@ export type LiturgicalChantTranslation = { name: NonEmptyString /** - * A compressed name of the liturgical chant for use in small areas (e.g. - * on character sheet). Should only be defined if the `name` does not fit - * on character sheet. + * A compressed name of the liturgical chant for use in small areas (e.g. on character sheet). Should only be defined if the `name` does not fit on character sheet. */ name_compressed?: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/Locale.ts b/src/types/Locale.ts index 78bd4ef6..1294f9f6 100644 --- a/src/types/Locale.ts +++ b/src/types/Locale.ts @@ -37,8 +37,7 @@ export type Locale = { region: string /** - * The language is not (fully) implemented and thus needs to be excluded from - * stable releases. + * The language is not (fully) implemented and thus needs to be excluded from stable releases. */ is_missing_implementation?: true } diff --git a/src/types/MetaCondition.ts b/src/types/MetaCondition.ts index be0819a3..8c04e1ca 100644 --- a/src/types/MetaCondition.ts +++ b/src/types/MetaCondition.ts @@ -13,9 +13,7 @@ import { Errata } from "./source/_Erratum.js" import { PublicationRefs } from "./source/_PublicationRef.js" /** - * Meta Conditions are rule elements that work like conditions in the sense that - * they have four levels with different effects, but which are not explicitly - * listed as conditions. + * Meta Conditions are rule elements that work like conditions in the sense that they have four levels with different effects, but which are not explicitly listed as conditions. * @title Meta Condition */ export type MetaCondition = { diff --git a/src/types/Patron.ts b/src/types/Patron.ts index 274b0d29..4c69e6ee 100644 --- a/src/types/Patron.ts +++ b/src/types/Patron.ts @@ -44,29 +44,24 @@ export type Patron = { skills: SkillReference[] /** - * The patron is only available to a certain set of cultures. It may be - * available to all, it may be available to only specific ones (intersection) - * and it may be available to all except specific ones to the listed cultures + * The patron is only available to a certain set of cultures. It may be available to all, it may be available to only specific ones (intersection) and it may be available to all except specific ones to the listed cultures * (difference). */ culture: PatronCulture /** - * The list of cultures where patrons from this category can be the primary - * patron of. + * The list of cultures where patrons from this category can be the primary patron of. * @uniqueItems */ primary_patron_cultures?: CultureReference[] /** - * The patron-specific powers. Used by animist power Animal Powers I–III and - * should only be present on animal patrons. + * The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons. */ powers?: AnimalPowers /** - * The patron-specific AE cost. Used by several animist forces for animal - * patrons. + * The patron-specific AE cost. Used by several animist forces for animal patrons. * @integer * @minimum 2 * @multipleOf 2 @@ -74,14 +69,12 @@ export type Patron = { ae_cost?: number /** - * The patron-specific improvement cost. Used by several animist forces for - * animal patrons. + * The patron-specific improvement cost. Used by several animist forces for animal patrons. */ improvement_cost?: ImprovementCost /** - * The patron may grant common advantages that are taken into account during - * character creation. + * The patron may grant common advantages that are taken into account during character creation. * * *Source:* Geisterwald & Knochenklippen, p. 6-7 * @minLength 1 @@ -89,8 +82,7 @@ export type Patron = { common_advantages?: AdvantageReference[] /** - * The patron may grant common disadvantages that are taken into account - * during character creation. + * The patron may grant common disadvantages that are taken into account during character creation. * * *Source:* Geisterwald & Knochenklippen, p. 6-7 * @minLength 1 @@ -119,9 +111,7 @@ export type PatronTranslation = { } /** - * The patron cultures the patron is or is not part of. If the patron is part of - * all patron cultures, the set should be empty and the operation should be - * difference. + * The patron cultures the patron is or is not part of. If the patron is part of all patron cultures, the set should be empty and the operation should be difference. */ export type PatronCulture = { set: CultureReference[] @@ -129,10 +119,7 @@ export type PatronCulture = { } /** - * The set operation to combine the set of all patron cultures with the - * specified set of patron cultures: If they should intersect, the patron is - * only part of the given cultures. If they should differ, the patron is only - * part of the cultures that are not given. + * The set operation to combine the set of all patron cultures with the specified set of patron cultures: If they should intersect, the patron is only part of the given cultures. If they should differ, the patron is only part of the cultures that are not given. */ export type PatronCultureOperation = "Intersection" | "Difference" diff --git a/src/types/PatronCategory.ts b/src/types/PatronCategory.ts index e28d95e5..96c3cae2 100644 --- a/src/types/PatronCategory.ts +++ b/src/types/PatronCategory.ts @@ -23,8 +23,7 @@ export type PatronCategory = { id: number /** - * The list of cultures where patrons from this category can be the primary - * patron of. + * The list of cultures where patrons from this category can be the primary patron of. * @minItems 1 * @uniqueItems */ diff --git a/src/types/PersonalityTrait.ts b/src/types/PersonalityTrait.ts index 9eded1ce..b46206ae 100644 --- a/src/types/PersonalityTrait.ts +++ b/src/types/PersonalityTrait.ts @@ -15,9 +15,7 @@ import { Errata } from "./source/_Erratum.js" import { PublicationRefs } from "./source/_PublicationRef.js" /** - * A personality trait describes character aspects of a person from a certain - * region. Higher trait levels only cover a part of the region covered by - * lower-level traits. + * A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits. * @title Personality Trait */ export type PersonalityTrait = { @@ -60,8 +58,7 @@ export type PersonalityTraitTranslation = { name: NonEmptyString /** - * The effects of the personality trait. They should be sorted like they - * are in the book. + * The effects of the personality trait. They should be sorted like they are in the book. * @minItems 1 */ effects: PersonalityTraitEffect[] diff --git a/src/types/Profession.ts b/src/types/Profession.ts index acb118ef..d292fa3c 100644 --- a/src/types/Profession.ts +++ b/src/types/Profession.ts @@ -48,17 +48,9 @@ export type Profession = { group: ProfessionGroup /** - * A list of professions representing the same profession but with (slightly) - * different stats. For example, there may be a profession in a regional - * sourcebook or in the core rules and a profession in an extension rulebook - * like Magic of Aventuria, where the profession is basically called the same - * and almost has the same values, but the version from Magic of Aventuria - * features a spell style special ability that does not exist in the core - * rules or regional sourcebook. + * A list of professions representing the same profession but with (slightly) different stats. For example, there may be a profession in a regional sourcebook or in the core rules and a profession in an extension rulebook like Magic of Aventuria, where the profession is basically called the same and almost has the same values, but the version from Magic of Aventuria features a spell style special ability that does not exist in the core rules or regional sourcebook. * - * The profession representation may feature different values for different - * explicitly mentioned experience levels. In most cases, there is only one - * stats package, which targets the experience level *Experienced*. + * The profession representation may feature different values for different explicitly mentioned experience levels. In most cases, there is only one stats package, which targets the experience level *Experienced*. * @minItems 1 */ versions: ProfessionVersion[] @@ -87,8 +79,7 @@ export type ProfessionVersion = export type ExperiencedProfessionPackage = { /** - * The profession representation variant's identifier. An unique, increasing - * integer. + * The profession representation variant's identifier. An unique, increasing integer. * @integer * @minimum 1 */ @@ -106,8 +97,7 @@ export type ExperiencedProfessionPackage = { export type ProfessionPackagesForDifferentExperienceLevels = { /** - * The profession representation variant's identifier. An unique, increasing - * integer. + * The profession representation variant's identifier. An unique, increasing integer. * @integer * @minimum 1 */ @@ -125,8 +115,7 @@ export type ProfessionPackagesForDifferentExperienceLevels = { export type ExperienceLevelDynamicProfessionPackage = { /** - * The experience level this profession targets. The experience level - * must be unique for this representation. + * The experience level this profession targets. The experience level must be unique for this representation. * @integer * @minimum 1 * @maximum 7 @@ -149,15 +138,12 @@ export type ProfessionPackage = { ap_value: number /** - * Which prerequisites must be met to buy the stat block? For example, a - * character might need the advantage Spellcaster or Blessed. Note: the AP - * cost for a profession package does not include these prerequisites. + * Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. */ prerequisites?: ProfessionPrerequisites /** - * In some areas, the profession package grants a loose set of stats where the - * player must choose between different options for the profession package. + * In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. */ options?: ProfessionPackageOptions @@ -167,8 +153,7 @@ export type ProfessionPackage = { special_abilities?: ProfessionSpecialAbility[] /** - * Provides ratings for the combat techniques that the hero receives from the - * package. + * Provides ratings for the combat techniques that the hero receives from the package. */ combat_techniques?: CombatTechniqueRating[] @@ -178,15 +163,12 @@ export type ProfessionPackage = { skills?: SkillRating[] /** - * The skill ratings a magical profession receives for spells; these spells - * are considered activated. Spells from an unfamiliar Tradition, if any, are - * identified as such. + * The skill ratings a magical profession receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. */ spells?: SpellRating[] /** - * Clerical professions receive these liturgical chants at the listed skill - * ratings. These liturgical chants are considered activated. + * Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. */ liturgical_chants?: LiturgicalChantRating[] @@ -203,25 +185,19 @@ export type ProfessionPackage = { suggested_disadvantages?: CommonnessRatedAdvantageDisadvantage[] /** - * These advantages do not fit well with this profession; to be checked with - * the GM before taking any of them. + * These advantages do not fit well with this profession; to be checked with the GM before taking any of them. * @minItems 1 */ unsuitable_advantages?: CommonnessRatedAdvantageDisadvantage[] /** - * These disadvantages do not fit well with this profession; to be checked - * with the GM before taking any of them. + * These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. * @minItems 1 */ unsuitable_disadvantages?: CommonnessRatedAdvantageDisadvantage[] /** - * Provides examples of variants for the profession, which may include changes - * to AP values and additional or modified skill ratings, special abilities, - * or combat techniques, as compared to the basic profession. Usually picking - * a variant is optional, but there are some rare exceptions where picking a - * variant is required. + * Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. */ variants?: ProfessionVariants } @@ -233,9 +209,7 @@ export type ProfessionTranslation = { name: ProfessionName /** - * A name addition of the profession. This will contain texts like name of - * the academy or the witch circle. It is enclosed in parenthesis, but the - * database entry must not contain parenthesis. + * A name addition of the profession. This will contain texts like name of the academy or the witch circle. It is enclosed in parenthesis, but the database entry must not contain parenthesis. */ specification?: ProfessionName @@ -250,14 +224,12 @@ export type ProfessionTranslation = { suggested_disadvantages?: NonEmptyString /** - * These advantages do not fit well with this profession; to be checked with - * the GM before taking any of them. + * These advantages do not fit well with this profession; to be checked with the GM before taking any of them. */ unsuitable_advantages?: NonEmptyString /** - * These disadvantages do not fit well with this profession; to be checked - * with the GM before taking any of them. + * These disadvantages do not fit well with this profession; to be checked with the GM before taking any of them. */ unsuitable_disadvantages?: NonEmptyString @@ -265,11 +237,7 @@ export type ProfessionTranslation = { } /** - * Provides examples of variants for the profession, which may include changes - * to AP values and additional or modified skill ratings, special abilities, or - * combat techniques, as compared to the basic profession. Usually picking a - * variant is optional, but there are some rare exceptions where picking a - * variant is required. + * Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required. */ export type ProfessionVariants = { /** @@ -302,9 +270,7 @@ export type ProfessionVariant = { ap_value: number /** - * Which prerequisites must be met to buy the stat block? For example, a - * character might need the advantage Spellcaster or Blessed. Note: the AP - * cost for a profession package does not include these prerequisites. + * Which prerequisites must be met to buy the stat block? For example, a character might need the advantage Spellcaster or Blessed. Note: the AP cost for a profession package does not include these prerequisites. */ prerequisites?: ProfessionPrerequisites @@ -319,8 +285,7 @@ export type ProfessionVariant = { special_abilities?: VariantSpecialAbility[] /** - * Provides ratings for the combat techniques that the hero receives from the - * package variant. + * Provides ratings for the combat techniques that the hero receives from the package variant. */ combat_techniques?: CombatTechniqueRating[] @@ -330,15 +295,12 @@ export type ProfessionVariant = { skills?: SkillRating[] /** - * The skill ratings a magical profession variant receives for spells; these - * spells are considered activated. Spells from an unfamiliar Tradition, if - * any, are identified as such. + * The skill ratings a magical profession variant receives for spells; these spells are considered activated. Spells from an unfamiliar Tradition, if any, are identified as such. */ spells?: SpellRating[] /** - * Clerical professions receive these liturgical chants at the listed skill - * ratings. These liturgical chants are considered activated. + * Clerical professions receive these liturgical chants at the listed skill ratings. These liturgical chants are considered activated. */ liturgical_chants?: LiturgicalChantRating[] @@ -394,8 +356,7 @@ export type SpecialAbilityDefinition = { level?: number /** - * Received select options. Order is important. Typically, you only need the - * first array index, though. + * Received select options. Order is important. Typically, you only need the first array index, though. * @minItems 1 */ options?: RequirableSelectOptionIdentifier[] @@ -412,8 +373,7 @@ export type FixedVariantSpecialAbility = { id: SpecialAbilityIdentifier /** - * if set to `false`, if the selection is granted by the basic package, it - * is removed. + * if set to `false`, if the selection is granted by the basic package, it is removed. */ active?: false @@ -425,8 +385,7 @@ export type FixedVariantSpecialAbility = { level?: number /** - * Received select options. Order is important. Typically, you only need the - * first array index, though. + * Received select options. Order is important. Typically, you only need the first array index, though. * @minItems 1 */ options?: RequirableSelectOptionIdentifier[] @@ -434,8 +393,7 @@ export type FixedVariantSpecialAbility = { export type VariantSpecialAbilitySelection = { /** - * if set to `false`, if the selection is granted by the basic package, it - * is removed. + * if set to `false`, if the selection is granted by the basic package, it is removed. */ active?: false @@ -452,8 +410,7 @@ export type CombatTechniqueRating = { id: CombatTechniqueIdentifier /** - * The rating bonus provided for the combat technique. If used in a profession - * variant, it can also be used to lower the bonus of the base profession. + * The rating bonus provided for the combat technique. If used in a profession variant, it can also be used to lower the bonus of the base profession. * * **Note:** This is a rating *bonus*, so it will be *added* to the default * value of 6. @@ -474,8 +431,7 @@ export type SkillRating = { id: SkillIdentifier /** - * The rating bonus provided for the skill. If used in a profession variant, - * it can also be used to lower the bonus of the base profession + * The rating bonus provided for the skill. If used in a profession variant, it can also be used to lower the bonus of the base profession * @integer * @minimum -8 * @maximum 8 @@ -485,16 +441,13 @@ export type SkillRating = { export type SpellRating = { /** - * The identifier(s) of the spell(s) to choose from to provide the rating for. - * If multiple spells are provided, they must all have the same improvement - * cost. + * The identifier(s) of the spell(s) to choose from to provide the rating for. If multiple spells are provided, they must all have the same improvement cost. * @minItems 1 */ id: ProfessionSpellIdentifier[] /** - * The rating bonus provided for the (selected) spell. If used in a profession - * variant, it can also be used to lower the bonus of the base profession. + * The rating bonus provided for the (selected) spell. If used in a profession variant, it can also be used to lower the bonus of the base profession. * @integer * @minimum -10 * @maximum 10 @@ -513,11 +466,7 @@ export type ProfessionSpellworkIdentifier = { id: SpellworkIdentifier /** - * If the spell is not part of the magical tradition required by the - * package, this references the magical tradition it is part of. It can also - * be used to define the target magical tradition of a spell if multiple - * magical traditions are required and the spell is available to multiple - * of them. + * If the spell is not part of the magical tradition required by the package, this references the magical tradition it is part of. It can also be used to define the target magical tradition of a spell if multiple magical traditions are required and the spell is available to multiple of them. */ tradition?: MagicalTraditionReference } @@ -531,17 +480,13 @@ export type ProfessionMagicalActionIdentifier = { export type LiturgicalChantRating = { /** - * The identifier(s) of the liturgical chant(s) to choose from to provide - * the rating for. If multiple liturgical chants are provided, they must all - * have the same improvement cost. + * The identifier(s) of the liturgical chant(s) to choose from to provide the rating for. If multiple liturgical chants are provided, they must all have the same improvement cost. * @minItems 1 */ id: LiturgyIdentifier[] /** - * The rating bonus provided for the selected liturgical chant. If used in a - * profession variant, it can also be used to lower the bonus of the base - * profession. + * The rating bonus provided for the selected liturgical chant. If used in a profession variant, it can also be used to lower the bonus of the base profession. * @integer * @minimum -10 * @maximum 10 @@ -550,8 +495,7 @@ export type LiturgicalChantRating = { } /** - * In some areas, the profession package grants a loose set of stats where the - * player must choose between different options for the profession package. + * In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. * @minProperties 1 */ export type ProfessionPackageOptions = { @@ -565,9 +509,7 @@ export type ProfessionPackageOptions = { } /** - * In some areas, the profession package grants a loose set of stats where the - * player must choose between different options for the profession package. The - * variant may override or remove those options. + * In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package. The variant may override or remove those options. * @minProperties 1 */ export type ProfessionVariantPackageOptions = { @@ -585,9 +527,7 @@ export type VariantOptionAction = | { tag: "Override"; override: T } /** - * Select an application from a skill or from one of a list of skills where you - * get a skill specialization for. You can also specify a skill groups from - * which you can choose a skill. + * Select an application from a skill or from one of a list of skills where you get a skill specialization for. You can also specify a skill groups from which you can choose a skill. */ export type SkillSpecializationOptions = | { tag: "Single"; single: SingleSkillSpecializationOption } @@ -622,16 +562,13 @@ export type LanguagesScriptsOptions = { */ export type CombatTechniquesOptions = { /** - * Specify the number of combat techniques that can be selected so that they - * get increased to a specific CtR. There can be multiple selections with - * different CtRs. + * Specify the number of combat techniques that can be selected so that they get increased to a specific CtR. There can be multiple selections with different CtRs. * @minItems 1 */ fixed: RatingForCombatTechniquesNumber[] /** - * Define if after the fixed selections the remaining unselected combat - * techniques will receive a certain rating bonus as well. + * Define if after the fixed selections the remaining unselected combat techniques will receive a certain rating bonus as well. * @integer * @minimum 1 * @maximum 6 diff --git a/src/types/Property.ts b/src/types/Property.ts index ae809d13..28dba1e3 100644 --- a/src/types/Property.ts +++ b/src/types/Property.ts @@ -23,8 +23,7 @@ export type Property = { id: number /** - * The property check's attributes. Only the properties from the Core Rules - * have defined property checks. + * The property check's attributes. Only the properties from the Core Rules have defined property checks. */ check?: SkillCheck diff --git a/src/types/Race.ts b/src/types/Race.ts index 809da7d7..55f0321f 100644 --- a/src/types/Race.ts +++ b/src/types/Race.ts @@ -52,15 +52,12 @@ export type Race = { base_values: BaseValues /** - * Describes how to raise or lower maximum attribute values during character - * creation. + * Describes how to raise or lower maximum attribute values during character creation. */ attribute_adjustments: AttributeAdjustments /** - * A list of automatically applied advantages. This does only work for - * advantages with no further configuration such as level or special - * selection. + * A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection. * @minItems 1 */ automatic_advantages?: AdvantageReference[] @@ -83,17 +80,14 @@ export type Race = { weight: RandomWeightGeneration /** - * Defines the starting ages for the race. It depends on the selected - * experience level. + * Defines the starting ages for the race. It depends on the selected experience level. * @minItems 7 * @maxItems 7 */ starting_age: StartingAgeConfigForExperienceLevel[] /** - * A list of available race variants where one has to be selected. If no - * variants are to be selected, a single variant with no name has to be provided - * which will be used as the missing values for the base race. + * A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. */ variants: RaceVariants @@ -136,8 +130,7 @@ export type BaseValues = { } /** - * Describes how to raise or lower maximum attribute values during character - * creation. + * Describes how to raise or lower maximum attribute values during character creation. * @minProperties 1 */ export type AttributeAdjustments = { @@ -148,12 +141,9 @@ export type AttributeAdjustments = { fixed?: FixedAttributeAdjustment[] /** - * An array of attribute maximum modifiers, where the attribute they apply to - * is selected from a list of options. + * An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options. * - * The array only permits a single entry because no race specified more than - * one selectable attribute adjustment so far. But the schema allows for - * multiple entries to be future-proof. + * The array only permits a single entry because no race specified more than one selectable attribute adjustment so far. But the schema allows for multiple entries to be future-proof. * @minItems 1 * @maxItems 1 */ @@ -178,9 +168,7 @@ export type FixedAttributeAdjustment = { } /** - * A value that will be added to the current maximum of the selected attribute - * that has been chosen from the listed attributes (negative values will lower - * the maximum). + * A value that will be added to the current maximum of the selected attribute that has been chosen from the listed attributes (negative values will lower the maximum). * @minItems 1 */ export type SelectableAttributeAdjustment = { @@ -231,17 +219,13 @@ export type WeightDice = { sides: DieType /** - * The strategy how to offset the randomly generated values against the - * base value. Either they are all added or subtracted or even results are - * added and odd results are subtracted. + * The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. */ offset_strategy: WeightDiceOffsetStrategy } /** - * The strategy how to offset the randomly generated values against the - * base value. Either they are all added or subtracted or even results are - * added and odd results are subtracted. + * The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. */ export type WeightDiceOffsetStrategy = "Add" | "Subtract" | "AddEvenSubtractOdd" @@ -259,16 +243,13 @@ export type StartingAgeConfigForExperienceLevel = { base: number /** - * The random value for the selected experience level. It is going to be - * added to the base value. + * The random value for the selected experience level. It is going to be added to the base value. */ random: Dice } /** - * A list of available race variants where one has to be selected. If no - * variants are to be selected, a single variant with no name has to be provided - * which will be used as the missing values for the base race. + * A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. * @minItems 1 */ export type RaceVariants = RaceVariant[] @@ -315,16 +296,14 @@ export type RaceVariant = { uncommon_disadvantages?: CommonnessRatedAdvantageDisadvantage[] /** - * An array containing 20 (numeric) hair color identifiers. The array also - * represents the 20-sided die for a random hair color. + * An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color. * @minItems 20 * @maxItems 20 */ hair_color: HairColorReference[] /** - * An array containing 20 (numeric) eye color identifiers. The array also - * represents the 20-sided die for a random eye color. + * An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color. * @minItems 20 * @maxItems 20 */ @@ -361,9 +340,7 @@ export type Height = { export type RaceVariantTranslation = { /** - * The race variant's name. If left empty, it defaults to the base race name. - * This can be used if the race has no (visible) variants so that a single - * variant has to be provided. + * The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided. */ name?: NonEmptyString @@ -410,8 +387,7 @@ export type RaceTranslation = { strongly_recommended_advantages?: NonEmptyString /** - * The respective strongly recommended disadvantages text from the source - * book. + * The respective strongly recommended disadvantages text from the source book. */ strongly_recommended_disadvantages?: NonEmptyString diff --git a/src/types/Ritual.ts b/src/types/Ritual.ts index a3988600..15994769 100644 --- a/src/types/Ritual.ts +++ b/src/types/Ritual.ts @@ -57,9 +57,7 @@ export type Ritual = { property: PropertyReference /** - * The tradition(s) the ritual is available for. It may be *generally* - * available to all traditions or it may be only familiar in specific - * traditions. + * The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. */ traditions: Traditions @@ -88,9 +86,7 @@ export type RitualTranslation = { 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. + * 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: ActivatableSkillEffect diff --git a/src/types/SexPractice.ts b/src/types/SexPractice.ts index 8beb6ec8..0d71a0f9 100644 --- a/src/types/SexPractice.ts +++ b/src/types/SexPractice.ts @@ -47,8 +47,7 @@ export type SexPracticeTranslation = { duration: NonEmptyString /** - * Prerequisites of participants and environment. Do not specify if the - * sex practice has no prerequisites. + * Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites. */ prerequisites?: NonEmptyString diff --git a/src/types/Skill.ts b/src/types/Skill.ts index 463919e0..e407dd40 100644 --- a/src/types/Skill.ts +++ b/src/types/Skill.ts @@ -32,9 +32,7 @@ export type Skill = { check: SkillCheck /** - * Lists applications for the skill, if any. This does not necessarily include - * all possible applications. There may also be new applications that could be - * purchased via certain advantages or special abilities. + * Lists applications for the skill, if any. This does not necessarily include all possible applications. There may also be new applications that could be purchased via certain advantages or special abilities. */ applications: Applications @@ -68,22 +66,17 @@ export type SkillTranslation = { name: NonEmptyString /** - * If there are options available that can not be put into a selection - * list (like different cults), provide the label text for the input - * element here. Otherwise leave empty. + * If there are options available that can not be put into a selection list (like different cults), provide the label text for the input element here. Otherwise leave empty. */ applications_input_label?: NonEmptyString /** - * The text listing the certain circumstances in which the encumbrance may - * count. This text must be used if `encumbrance` is set to `"Maybe"`, - * otherwise it is ignored if defined. + * The text listing the certain circumstances in which the encumbrance may count. This text must be used if `encumbrance` is set to `"Maybe"`, otherwise it is ignored if defined. */ encumbrance_description?: NonEmptyString /** - * Mentions any tools from the equipment list that are necessary to employ - * the skill. + * Mentions any tools from the equipment list that are necessary to employ the skill. */ tools?: NonEmptyMarkdown @@ -111,13 +104,9 @@ export type SkillTranslation = { } /** - * A category. All available entries from the specified category will be - * included as separate applications. + * A category. All available entries from the specified category will be included as separate applications. */ -export type ApplicationCategory = - | "BlessedTraditions" - | "Diseases" - | "Regions" +export type ApplicationCategory = "BlessedTraditions" | "Diseases" | "Regions" /** * The skill's applications. @@ -158,10 +147,7 @@ export type ApplicationTranslation = { /** * Indicates whether encumbrance gives a penalty for checks with the skill. */ -export type EncumbranceInfluence = - | "True" - | "False" - | "Maybe" +export type EncumbranceInfluence = "True" | "False" | "Maybe" export const config: TypeConfig = { name: "Skill", diff --git a/src/types/SkillModificationLevel.ts b/src/types/SkillModificationLevel.ts index aa707c1f..a7a6d187 100644 --- a/src/types/SkillModificationLevel.ts +++ b/src/types/SkillModificationLevel.ts @@ -96,36 +96,35 @@ export type SlowSkillCastingTime = { unit: SlowSkillCastingTimeUnit } -export type SlowSkillCastingTimeUnit = - | "Minutes" - | "Hours" +export type SlowSkillCastingTimeUnit = "Minutes" | "Hours" /** * @minProperties 1 */ export type SkillModificationLevelTranslation = { /** - * Configuration for this level for fast skills (spells, liturgical chants). - * Values set here override the default generated text. + * Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text. */ fast?: LevelTypeConfigTranslation /** - * Configuration for this level for slow skills (rituals, ceremonies). Values - * set here override the default generated text. + * Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text. */ slow?: LevelTypeConfigTranslation } /** - * Configuration translation of a type for a level. Values set here override the - * default generated text. + * Configuration translation of a type for a level. Values set here override the default generated text. */ export type LevelTypeConfigTranslation = { range: NonEmptyString } -export const config: TypeConfig = { +export const config: TypeConfig< + SkillModificationLevel, + SkillModificationLevel["id"], + "SkillModificationLevel" +> = { name: "SkillModificationLevel", id: getFilenamePrefixAsNumericId, integrityValidator: todo("SkillModificationLevel"), diff --git a/src/types/Spell.ts b/src/types/Spell.ts index 2d747053..efcaecbd 100644 --- a/src/types/Spell.ts +++ b/src/types/Spell.ts @@ -58,9 +58,7 @@ export type Spell = { property: PropertyReference /** - * The tradition(s) the spell is available for. It may be *generally* - * available to all traditions or it may be only familiar in specific - * traditions. + * The tradition(s) the spell is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. */ traditions: Traditions @@ -88,9 +86,7 @@ export type SpellTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/_Activatable.ts b/src/types/_Activatable.ts index 2a626854..bd47dda5 100644 --- a/src/types/_Activatable.ts +++ b/src/types/_Activatable.ts @@ -45,8 +45,7 @@ export type Id = number export type Name = string /** - * The full name of the entry as stated in the sources. Only use when `name` - * needs to be different from full name for text generation purposes. + * The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. * @minLength 1 */ export type NameInLibrary = string @@ -59,8 +58,7 @@ export type NameInLibrary = string export type Levels = number /** - * The number stating how often you can buy the entry. The **default** depends on - * the entry type: + * 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**) @@ -74,36 +72,19 @@ export type Levels = number export type Maximum = number /** - * Definitions for possible options for the activatable entry. They can either - * be derived from entry categories or be defined explicitly. Both can happen as - * well, but if there is an explicitly defined select option and a derived - * select option has the same identifier (which may only happen if skill or - * combat technique identifiers are used for explicit select options), the - * explicit definition overwrites the derived option. + * Definitions for possible options for the activatable entry. They can either be derived from entry categories or be defined explicitly. Both can happen as well, but if there is an explicitly defined select option and a derived select option has the same identifier (which may only happen if skill or combat technique identifiers are used for explicit select options), the explicit definition overwrites the derived option. * - * Note that this is only a full definition of options for simple logic that can - * be made explicit using the more detailed configuration for both derived - * categories and explicit options. There are quite a few entries whose option - * logic cannot be fully represented here, so that it needs to be implemented - * manually. + * Note that this is only a full definition of options for simple logic that can be made explicit using the more detailed configuration for both derived categories and explicit options. There are quite a few entries whose option logic cannot be fully represented here, so that it needs to be implemented manually. * @minProperties 1 */ export type SelectOptions = { /** - * An entry category with optional further configuration. All available - * entries from the specified categories will be included as separate select - * options. You can also specify a set of groups that should only be - * included. Groups not mentioned will be excluded then. + * An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then. */ derived?: SelectOptionCategory /** - * A list of explicit select options. If the identifier has a specific type, - * its entry is the base of this select option, where values defined here - * override values from the base. Define the `src` property if the options - * are not derived from the rules text of the advantage/disadvantage/special - * ability but instead are listed in a separate block and/or on a separate - * page. + * A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the `src` property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page. * @minItems 1 */ explicit?: ExplicitSelectOption[] @@ -123,34 +104,24 @@ export type ExplicitGeneralSelectOption = { id: number /** - * Sometimes, professions use specific text selections that are not - * contained in described lists. This ensures you can use them for - * professions only. They are not going to be displayed as options to the - * user. + * Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user. */ profession_only?: true /** - * Registers new applications, which get enabled once this entry is - * activated with its respective select option. It specifies an entry-unique - * identifier and the skill it belongs to. A translation can be left out if - * its name equals the name of the origin select option. + * Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. */ skill_applications?: SkillApplications /** - * Registers uses, which get enabled once this entry is activated with its - * respective select option. It specifies an entry-unique identifier and the - * skill it belongs to. A translation can be left out if its name equals the - * name of the origin select option. + * Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. */ skill_uses?: SkillUses prerequisites?: GeneralPrerequisites /** - * Specific binding cost for the select option. Only has an effect if the - * associated entry supports binding costs. + * Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. * @integer * @minimum 0 */ @@ -179,15 +150,13 @@ export type ExplicitGeneralSelectOptionTranslation = { name: string /** - * The name of the select option when displayed in a generated - * profession text. + * The name of the select option when displayed in a generated profession text. * @minLength 1 */ name_in_profession?: string /** - * The description of the select option. Useful for Bad Habits, Trade - * Secrets and other entries where a description is available. + * The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available. * @markdown * @minLength 1 */ @@ -205,19 +174,13 @@ export type ExplicitSkillSelectOption = { id: SkillIdentifier /** - * Registers new applications, which get enabled once this entry is - * activated with its respective select option. It specifies an entry-unique - * identifier and the skill it belongs to. A translation can be left out if - * its name equals the name of the origin select option. + * Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. * @minItems 1 */ skill_applications?: SkillApplicationOrUse[] /** - * Registers uses, which get enabled once this entry is activated with its - * respective select option. It specifies an entry-unique identifier and the - * skill it belongs to. A translation can be left out if its name equals the - * name of the origin select option. + * Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. * @minItems 1 */ skill_uses?: SkillApplicationOrUse[] @@ -225,8 +188,7 @@ export type ExplicitSkillSelectOption = { prerequisites?: GeneralPrerequisites /** - * Specific binding cost for the select option. Only has an effect if the - * associated entry supports binding costs. + * Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. * @integer * @minimum 0 */ @@ -263,8 +225,7 @@ export type ExplicitCombatTechniqueSelectOption = { prerequisites?: GeneralPrerequisites /** - * Specific binding cost for the select option. Only has an effect if the - * associated entry supports binding costs. + * Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. * @integer * @minimum 0 */ @@ -426,16 +387,12 @@ export type Effect = NonEmptyMarkdown export type CombatSpecialAbilityUsageType = "Passive" | "BasicManeuver" | "SpecialManeuver" /** - * The definition of if the combat special ability can be used when armed or - * when unarmed. + * The definition of if the combat special ability can be used when armed or when unarmed. */ export type CombatSpecialAbilityType = "Armed" | "Unarmed" /** - * Registers new skill applications, which get enabled once this entry is - * activated. It specifies an entry-unique identifier and the skill it belongs - * to. A translation can be left out if its name equals the name of the origin - * activatable entry. + * Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. * @minItems 1 */ export type SkillApplications = SkillApplication[] @@ -471,9 +428,7 @@ export type SkillApplicationAssociatedSkills = { list: SkillReference[] /** - * If an application applies to multiple skills, it may need to ensure the - * respective skill is on a certain skill rating if the activatable entry - * cannot ensure this prerequisite. + * If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite. * @integer * @minimum 1 */ @@ -488,9 +443,7 @@ export type SkillApplicationTranslation = { } /** - * Registers uses, which get enabled once this entry is activated. It specifies - * an entry-unique identifier and the skill it belongs to. A translation can be - * left out if its name equals the name of the origin activatable entry. + * Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry. * @minItems 1 */ export type SkillUses = SkillUse[] @@ -637,16 +590,13 @@ export type PenaltySelectionOptionsRange = { export type PenaltyByLevel = { /** - * 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. + * 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: PenaltyByLevelLevel[] /** - * The combat-related special ability of which the level defines the penalty - * instead. + * The combat-related special ability of which the level defines the penalty instead. */ external?: PenaltyByExternalLevel } @@ -660,25 +610,18 @@ export type PenaltyByLevelLevel = { } /** - * The combat-related special ability of which the level defines the penalty - * instead. + * The combat-related special ability of which the level defines the penalty instead. */ export type PenaltyByExternalLevel = { /** - * The identifier of the combat-related special ability of which the level - * defines the penalty instead. + * The identifier of the combat-related special ability of which the level defines the penalty instead. */ id: CombatRelatedSpecialAbilityIdentifier } export type PenaltyByAttack = { /** - * 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. + * 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: PenaltyByAttackOrderItem[] @@ -749,9 +692,7 @@ export type FixedArcaneEnergyCost = { interval?: DurationUnitValue /** - * 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`). + * 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?: FixedArcaneEnergyCostPerLevel @@ -762,9 +703,7 @@ export type FixedArcaneEnergyCost = { } /** - * 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`). + * 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`). */ export type FixedArcaneEnergyCostPerLevel = "Compressed" | "Verbose" @@ -787,8 +726,7 @@ export type ArcaneEnergyCostPerCountable = { value: number /** - * If defined, in addition to the cost per entity you have to pay a flat - * amount, regardless of the entity count. + * If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count. * @integer * @minimum 1 */ @@ -802,8 +740,7 @@ export type ArcaneEnergyCostPerCountable = { export type ArcaneEnergyCostPerCountableTranslation = { /** - * The cost have to be per a specific countable entity, e.g. `8 AE per - * person`. + * The cost have to be per a specific countable entity, e.g. `8 AE per person`. */ per: ResponsiveText @@ -829,8 +766,7 @@ export type IntervalArcaneEnergyCost = { export type ActivationAndHalfIntervalArcaneEnergyCost = { /** - * The AE cost value that has to be payed for activation. Half of this value - * has to be payed each interval. + * 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 @@ -845,8 +781,7 @@ export type ActivationAndHalfIntervalArcaneEnergyCost = { export type IndefiniteArcaneEnergyCost = { /** - * Specified if the indefinite AP cost description needs to be modified by a - * certain value. + * Specified if the indefinite AP cost description needs to be modified by a certain value. */ modifier?: IndefiniteArcaneEnergyCostModifier @@ -881,8 +816,7 @@ export type IndefiniteArcaneEnergyCostTranslation = { export type ArcaneEnergyCostDisjunction = { /** - * Specified if the selected AE cost option has to be paid for each time - * interval. + * Specified if the selected AE cost option has to be paid for each time interval. */ interval?: ArcaneEnergyCostDisjunctionInterval @@ -910,8 +844,7 @@ export type ArcaneEnergyCostDisjunctionInterval = { * **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. + * 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 } @@ -988,9 +921,7 @@ export type VolumePerLevel = { export type VolumeByLevel = { /** - * 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. + * 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: VolumeByLevelItem[] @@ -1006,9 +937,7 @@ export type VolumeByLevelItem = { } /** - * A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead / - * Fairies, Ghosts / Demons, Elementals` may be respresented as the following - * map: + * 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: @@ -1044,9 +973,7 @@ export type VolumeByLevelItem = { * 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. + * 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 type VolumeMap = { /** @@ -1076,10 +1003,7 @@ export type VolumeMapTranslation = { 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. + * 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 } @@ -1117,8 +1041,7 @@ export type VolumeMapOptionTranslation = { label: NonEmptyString /** - * The description of the option if used standalone. Only used if - * different from `label`. + * The description of the option if used standalone. Only used if different from `label`. */ label_standalone?: NonEmptyString } @@ -1145,8 +1068,7 @@ export type FixedBindingCost = { /** * The permanent AE cost. * - * If the enchantment has multiple levels, it is only applied for the first - * level. + * If the enchantment has multiple levels, it is only applied for the first level. * @integer * @minimum 1 */ @@ -1163,9 +1085,7 @@ export type BindingCostPerLevel = { } /** - * 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: + * 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: @@ -1217,10 +1137,7 @@ export type BindingCostMapTranslation = { list_append?: NonEmptyString /** - * 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. + * 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?: NonEmptyString } @@ -1246,8 +1163,7 @@ export type BindingCostMapOptionTranslation = { label: NonEmptyString /** - * The description of the option if used standalone. Only used if - * different from `label`. + * The description of the option if used standalone. Only used if different from `label`. */ label_standalone?: NonEmptyString } @@ -1262,8 +1178,7 @@ export type BindingCostDerivedFromSelection = { } /** - * The magic property's identifier. `DependingOnProperty` can only be used if - * the special ability has an option to select a property. + * The magic property's identifier. `DependingOnProperty` can only be used if the special ability has an option to select a property. */ export type PropertyDeclaration = | { tag: "DependingOnSelection"; depending_on_selection: {} } @@ -1293,8 +1208,7 @@ export type RestrictAdvancedSpecialAbilityOptions = { id: Identifier /** - * Specify the select option(s) that only are allowed for the referenced - * advanced special ability; others are disallowed. + * Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed. * @minItems 1 */ option: AdvancedSpecialAbilityRestrictedOptionIdentifier[] @@ -1308,8 +1222,7 @@ export type OneOfAdvancedSpecialAbilityOptions = { options: AdvancedSpecialAbilityReference[] /** - * Do have to choose the advanced special ability when buying the style - * special ability? Otherwise the decision can be made later. + * Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later. */ is_selection_required_on_purchase: boolean @@ -1332,8 +1245,7 @@ export type AdvancedSpecialAbilityDerivedFromExternalOption = { } /** - * Mapping from an option of the external entry to an allowed advanced special - * ability. + * Mapping from an option of the external entry to an allowed advanced special ability. * @minItems 1 */ export type AdvancedSpecialAbilityDerivedFromExternalOptionMapping = { @@ -1353,19 +1265,14 @@ export type AdvancedSpecialAbilityDerivedExternalEntryId = MagicalTraditionIdent export type AdvancedSpecialAbilityDerivedExternalEntryOptionId = PatronIdentifier /** - * The Advanced Special Abilities for the respective Style Special Ability. - * Sometimes, only a specific select option or a set of select options of an - * entry is allowed, which can be modelled by the option property. It can also - * be that you can choose from a set of special abilities, but then you can't - * specify an option. + * The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option. * @minItems 3 * @maxItems 3 */ export type AdvancedSpecialAbilities = AdvancedSpecialAbility[] /** - * The prerequisites text. It is only used if the text cannot be generated from - * the given information. + * The prerequisites text. It is only used if the text cannot be generated from the given information. */ export type PrerequisitesReplacement = NonEmptyMarkdown @@ -1491,23 +1398,18 @@ export type AdventurePointsValue = | { tag: "Indefinite"; indefinite: {} } /** - * A fixed adventure points value. If the entry has levels, this is the cost per - * level as well. + * A fixed adventure points value. If the entry has levels, this is the cost per level as well. */ export type FixedAdventurePointsValue = AdventurePointsSingleValue /** - * An entry with levels may have different costs for each level. The length of - * the list must match the amount of levels the special ability has. + * An entry with levels may have different costs for each level. The length of the list must match the amount of levels the special ability has. * @minItems 2 */ export type AdventurePointsValueByLevel = AdventurePointsSingleValue[] /** - * The adventure points value is derived from the selection of the special - * ability. Its display value may be able to be derived from the given - * information for the select options. If that is not the case or the generated - * text would not match the original one, a replacement text can be provided. + * The adventure points value is derived from the selection of the special ability. Its display value may be able to be derived from the given information for the select options. If that is not the case or the generated text would not match the original one, a replacement text can be provided. */ export type AdventurePointsDerivedFromSelection = { /** @@ -1521,8 +1423,7 @@ export type AdventurePointsDerivedFromSelection = { */ export type AdventurePointsDerivedFromSelectionTranslation = { /** - * A replacement for the generated text if it would not match the original - * one. + * A replacement for the generated text if it would not match the original one. */ replacement?: NonEmptyMarkdown } @@ -1546,14 +1447,11 @@ export type Input = NonEmptyString // }, /** - * The AP value. It is only used if the text cannot be generated from the given - * information. + * The AP value. It is only used if the text cannot be generated from the given information. */ export type AdventurePointsValueReplacement = NonEmptyMarkdown /** - * A string that gets appended to the default AP Value text with a preceding - * space. This always happens if present, even if the generated AP Value text is - * replaced. + * A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. */ export type AdventurePointsValueAppend = NonEmptyMarkdown diff --git a/src/types/_ActivatableSelectOptionCategory.ts b/src/types/_ActivatableSelectOptionCategory.ts index 12a4a1fa..f756b099 100644 --- a/src/types/_ActivatableSelectOptionCategory.ts +++ b/src/types/_ActivatableSelectOptionCategory.ts @@ -42,8 +42,7 @@ export type SelectOptionCategory = export type BlessedTraditionsSelectOptionCategory = { /** - * Should the principles (code) of the tradition be required to select the - * respective tradition? + * Should the principles (code) of the tradition be required to select the respective tradition? */ require_principles?: true } @@ -64,8 +63,7 @@ export type PropertiesSelectOptionCategory = { require_knowledge?: true /** - * Require a minimum number of spellworks of the respective property to be - * on a minimum skill rating. + * Require a minimum number of spellworks of the respective property to be on a minimum skill rating. */ require_minimum_spellworks_on?: RequiredMinimumSkillsToBeOnSkillRating } @@ -77,36 +75,29 @@ export type AspectSelectOptionCategory = { require_knowledge?: true /** - * The generated name should be the *Master of (Aspect)* suffix for this - * aspect instead of the aspect's name. If an aspect does not provide a - * suffix (such as the General aspect), it is automatically excluded from - * the list. + * The generated name should be the *Master of (Aspect)* suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list. */ use_master_of_suffix_as_name?: true /** - * Require a minimum number of liturgies of the respective aspect to be on a - * minimum skill rating. + * Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating. */ require_minimum_liturgies_on?: RequiredMinimumSkillsToBeOnSkillRating } /** - * Require a minimum number of spellworks/liturgies of the respective - * property/aspect to be on a minimum skill rating. + * Require a minimum number of spellworks/liturgies of the respective property/aspect to be on a minimum skill rating. */ export type RequiredMinimumSkillsToBeOnSkillRating = { /** - * The minimum number of liturgies that need to be on the defined minimum - * skill rating. + * The minimum number of liturgies that need to be on the defined minimum skill rating. * @integer * @minimum 1 */ number: number /** - * The minimum skill rating the defined minimum number of liturgies need - * to be on. + * The minimum skill rating the defined minimum number of liturgies need to be on. * @integer * @minimum 1 */ @@ -164,27 +155,18 @@ export type SkillSelectOptionCategoryCategory = { groups?: SkillGroupReference[] /** - * Only include (`Intersection`) or exclude (`Difference`) specific - * skills. + * Only include (`Intersection`) or exclude (`Difference`) specific skills. */ specific?: SpecificFromSkillSelectOptionCategoryCategory /** - * Registers new applications, which get enabled once this entry is - * activated with its respective select option. It specifies an - * entry-unique identifier, the skill it belongs to is derived from the - * select option automatically. A translation can be left out if its - * name equals the name of the origin entry. + * Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. * @minItems 1 */ skill_applications?: SkillApplicationOrUse[] /** - * Registers uses, which get enabled once this entry is activated with - * its respective select option. It specifies an entry-unique - * identifier, the skill it belongs to is derived from the select option - * automatically. A translation can be left out if its name equals the - * name of the origin entry. + * Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. * @minItems 1 */ skill_uses?: SkillApplicationOrUse[] @@ -240,8 +222,7 @@ export type SkillApplicationOrUse = { export type SkillApplicationOrUseTranslation = { /** - * The name of the application or use if different from the activatable - * entry's name. + * The name of the application or use if different from the activatable entry's name. * @minLength 1 */ name: string @@ -351,8 +332,7 @@ export type SelectOptionsFixedAdventurePointsValue = { map: SelectOptionsFixedAdventurePointsValueMapping[] /** - * The default value of an entry. Used as a fallback if no value is - * found in `list`. + * The default value of an entry. Used as a fallback if no value is found in `list`. * @integer * @minimum 1 */ diff --git a/src/types/_ActivatableSkillCastingTime.ts b/src/types/_ActivatableSkillCastingTime.ts index 71c45492..7a795f15 100644 --- a/src/types/_ActivatableSkillCastingTime.ts +++ b/src/types/_ActivatableSkillCastingTime.ts @@ -2,13 +2,13 @@ import { SlowSkillCastingTimeUnit } from "./SkillModificationLevel.js" export type CastingTime = | { - tag: "Modifiable" - modifiable: ModifiableCastingTime - } + tag: "Modifiable" + modifiable: ModifiableCastingTime + } | { - tag: "NonModifiable" - non_modifiable: NonModifiable - } + tag: "NonModifiable" + non_modifiable: NonModifiable + } export type ModifiableCastingTime = { /** @@ -21,9 +21,7 @@ export type ModifiableCastingTime = { } /** - * The casting time may have two different values: One for use in “normal” time, - * i. e. actions, combat rounds and others, and one for use during lovemaking, - * which is a rule set from Aventurian Intimacy. + * The casting time may have two different values: One for use in “normal” time, i. e. actions, combat rounds and others, and one for use during lovemaking, which is a rule set from Aventurian Intimacy. * * There must always be at least one casting time value. * @minProperties 1 @@ -35,17 +33,13 @@ export type CastingTimeIncludingLovemaking = { default?: CastingTime /** - * The casting time during lovemaking. In Aventurian Intimacy, you may only - * use an activatable skill during lovemaking if it has a casting time used - * during lovemaking. + * The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. */ during_lovemaking?: CastingTimeDuringLovemaking } /** - * The casting time during lovemaking. In Aventurian Intimacy, you may only use - * an activatable skill during lovemaking if it has a casting time used during - * lovemaking. + * The casting time during lovemaking. In Aventurian Intimacy, you may only use an activatable skill during lovemaking if it has a casting time used during lovemaking. */ export type CastingTimeDuringLovemaking = { /** @@ -61,9 +55,7 @@ export type CastingTimeDuringLovemaking = { unit: CastingTimeDuringLovemakingUnit } -export type CastingTimeDuringLovemakingUnit = - | "SeductionActions" - | "Rounds" +export type CastingTimeDuringLovemakingUnit = "SeductionActions" | "Rounds" export type FastSkillNonModifiableCastingTime = { /** diff --git a/src/types/_ActivatableSkillCost.ts b/src/types/_ActivatableSkillCost.ts index 3fc06e06..8358097c 100644 --- a/src/types/_ActivatableSkillCost.ts +++ b/src/types/_ActivatableSkillCost.ts @@ -5,35 +5,35 @@ import { ResponsiveText, ResponsiveTextOptional, ResponsiveTextReplace } from ". export type OneTimeCost = | { - tag: "Single" - single: SingleOneTimeCost - } + tag: "Single" + single: SingleOneTimeCost + } | { - tag: "Conjunction" - conjunction: MultipleOneTimeCosts - } + tag: "Conjunction" + conjunction: MultipleOneTimeCosts + } | { - tag: "Disjunction" - disjunction: MultipleOneTimeCosts - } + tag: "Disjunction" + disjunction: MultipleOneTimeCosts + } | { - tag: "Map" - map: CostMap - } + tag: "Map" + map: CostMap + } export type SingleOneTimeCost = | { - tag: "Modifiable" - modifiable: ModifiableOneTimeCost - } + tag: "Modifiable" + modifiable: ModifiableOneTimeCost + } | { - tag: "NonModifiable" - non_modifiable: NonModifiableOneTimeCost - } + tag: "NonModifiable" + non_modifiable: NonModifiableOneTimeCost + } | { - tag: "Indefinite" - indefinite: IndefiniteOneTimeCost - } + tag: "Indefinite" + indefinite: IndefiniteOneTimeCost + } /** * @minItems 2 @@ -90,8 +90,7 @@ export type NonModifiableOneTimeCost = { permanent_value?: number /** - * The cost have to be per a specific countable entity, e.g. `8 KP per - * person`. + * The cost have to be per a specific countable entity, e.g. `8 KP per person`. */ per?: NonModifiableOneTimeCostPerCountable @@ -104,8 +103,7 @@ export type NonModifiableOneTimeCost = { export type NonModifiableOneTimeCostPerCountable = { /** - * If defined, the minimum total AE that have to be spent casting the - * skill. + * If defined, the minimum total AE that have to be spent casting the skill. */ minimum_total?: number @@ -145,8 +143,7 @@ export type IndefiniteOneTimeCostTranslation = { } /** - * A content that is `2/4/8/16 AE for an item the size of a - * cup/chest/door/castle gate` may be respresented as the following map: + * A content that is `2/4/8/16 AE for an item the size of a cup/chest/door/castle gate` may be respresented as the following map: * * ```yaml * options: @@ -161,8 +158,7 @@ export type IndefiniteOneTimeCostTranslation = { * for_append: "an item the size of a" * ``` * - * This will generate the exact same string as seen above – given it is set - * for a spellwork and thus `AE` is used. + * This will generate the exact same string as seen above – given it is set for a spellwork and thus `AE` is used. */ export type CostMap = { /** @@ -205,8 +201,7 @@ export type CostMapOptionTranslation = { label: NonEmptyString /** - * The description of the option if used standalone. Only used if - * different from `label`. + * The description of the option if used standalone. Only used if different from `label`. */ label_standalone?: NonEmptyString } @@ -223,23 +218,20 @@ export type CostMapTranslation = { list_append?: NonEmptyString /** - * 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. + * 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?: NonEmptyString } export type SustainedCost = | { - tag: "Modifiable" - modifiable: ModifiableSustainedCost - } + tag: "Modifiable" + modifiable: ModifiableSustainedCost + } | { - tag: "NonModifiable" - non_modifiable: NonModifiableSustainedCost - } + tag: "NonModifiable" + non_modifiable: NonModifiableSustainedCost + } export type ModifiableSustainedCost = { /** @@ -270,8 +262,7 @@ export type NonModifiableSustainedCost = { value: number /** - * The cost have to be per a specific countable entity, e.g. `8 KP per - * person per 5 minutes`. + * The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`. */ per?: NonModifiableSustainedCostPerCountable @@ -283,8 +274,7 @@ export type NonModifiableSustainedCost = { export type NonModifiableSustainedCostPerCountable = { /** - * If defined, the minimum total AE that have to be spent casting the - * skill. + * If defined, the minimum total AE that have to be spent casting the skill. */ minimum_total?: number diff --git a/src/types/_ActivatableSkillEffect.ts b/src/types/_ActivatableSkillEffect.ts index 691a3e55..0bc64e3d 100644 --- a/src/types/_ActivatableSkillEffect.ts +++ b/src/types/_ActivatableSkillEffect.ts @@ -1,9 +1,7 @@ import { NonEmptyMarkdown } from "./_NonEmptyString.js" /** - * 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. + * 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. */ export type ActivatableSkillEffect = | { @@ -28,45 +26,38 @@ export type ActivatableSkillPlainEffect = { export type ActivatableSkillEffectForEachQualityLevel = { /** - * The effect description before the list of effects for each quality - * level. + * The effect description before the list of effects for each quality level. */ text_before: NonEmptyMarkdown /** - * The list of effects for each quality level. The first element - * represents QL 1, the second element QL 2, and so on. + * The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. * @minLength 6 * @maxLength 6 */ quality_levels: NonEmptyMarkdown[] /** - * The effect description after the list of effects for each quality - * level. + * The effect description after the list of effects for each quality level. */ text_after?: NonEmptyMarkdown } export type ActivatableSkillEffectForEachTwoQualityLevels = { /** - * The effect description before the list of effects for each quality - * level. + * The effect description before the list of effects for each quality level. */ text_before: NonEmptyMarkdown /** - * The list of effects for each two quality levels. The first element - * represents QL 1–2, the second element QL 3–4 and the third element QL - * 5–6. + * The list of effects for each two quality levels. The first element represents QL 1–2, the second element QL 3–4 and the third element QL 5–6. * @minLength 3 * @maxLength 3 */ quality_levels: NonEmptyMarkdown[] /** - * The effect description after the list of effects for each quality - * level. + * The effect description after the list of effects for each quality level. */ text_after?: NonEmptyMarkdown } diff --git a/src/types/_ActivatableSkillRange.ts b/src/types/_ActivatableSkillRange.ts index 8ab4e58c..71a4e9d1 100644 --- a/src/types/_ActivatableSkillRange.ts +++ b/src/types/_ActivatableSkillRange.ts @@ -102,15 +102,12 @@ export type CheckResultBasedRange = { */ export type RangeTranslation = { /** - * A note, appended to the generated string in parenthesis. If the - * generated is modified using `replacement`, the note is appended to - * the modifier string. + * A note, appended to the generated string in parenthesis. If the generated is modified using `replacement`, the note is appended to the modifier string. */ note?: ResponsiveTextOptional /** - * A replacement string. If `note` is provided, it is appended to the - * replaced string. + * A replacement string. If `note` is provided, it is appended to the replaced string. */ replacement?: ResponsiveTextReplace } diff --git a/src/types/_ActivatableSkillTargetCategory.ts b/src/types/_ActivatableSkillTargetCategory.ts index 434d6870..7b77db73 100644 --- a/src/types/_ActivatableSkillTargetCategory.ts +++ b/src/types/_ActivatableSkillTargetCategory.ts @@ -5,8 +5,7 @@ import { TargetCategoryReference } from "./_SimpleReferences.js" /** * The target category – the kind of creature or object – the skill affects. * - * If no target categories are given, the skill applies to all target - * categories. + * If no target categories are given, the skill applies to all target categories. */ export type AffectedTargetCategories = SpecificAffectedTargetCategory[] diff --git a/src/types/_Blessed.ts b/src/types/_Blessed.ts index 14e9568f..0e448ff6 100644 --- a/src/types/_Blessed.ts +++ b/src/types/_Blessed.ts @@ -11,9 +11,7 @@ export type SkillTraditionWithAspects = { tradition: BlessedTraditionReference /** - * The aspect(s) from the tradition the ceremony belongs to. Note that not - * all traditions have aspects. Traditions with aspects must have at least one - * aspect specified. + * The aspect(s) from the tradition the ceremony belongs to. Note that not all traditions have aspects. Traditions with aspects must have at least one aspect specified. * @minItems 1 * @maxItems 2 */ diff --git a/src/types/_DiseasePoison.ts b/src/types/_DiseasePoison.ts index f80f23c5..f69c4fcc 100644 --- a/src/types/_DiseasePoison.ts +++ b/src/types/_DiseasePoison.ts @@ -9,19 +9,12 @@ import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js" import { Errata } from "./source/_Erratum.js" /** - * Depending on the disease, apply Spirit or Toughness as a penalty to the - * disease roll. It may also happen that the lower of both is applied as a - * penalty. + * Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty. */ -export type Resistance = - | "Spirit" - | "Toughness" - | "LowerOfSpiritAndToughness" +export type Resistance = "Spirit" | "Toughness" | "LowerOfSpiritAndToughness" /** - * What causes the disease? The GM rolls 1D20 to see if a character gets - * infected. If the infection check succeeds, the GM makes a disease check to - * determine the severity of the infection. + * What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection. */ export type Cause = { /** @@ -47,9 +40,7 @@ export type CauseTranslation = { name: string /** - * The chance to get infected by this cause. If present for this - * language, this overrides the universal `chance` field; they cannot be - * used at the same time. + * The chance to get infected by this cause. If present for this language, this overrides the universal `chance` field; they cannot be used at the same time. */ chance?: NonEmptyString @@ -82,14 +73,12 @@ export type DiseaseTranslation = { incubation_time: NonEmptyString /** - * The damage caused by the disease. If the disease check fails, apply the - * lessened effects. + * The damage caused by the disease. If the disease check fails, apply the lessened effects. */ damage: Reduceable /** - * The duration of the disease. If the disease check fails, use the - * lessened duration. + * The duration of the disease. If the disease check fails, use the lessened duration. */ duration: Reduceable @@ -112,11 +101,9 @@ export type DiseaseTranslation = { } /** - * An effect or other parameter that may be reduced by a failed disease check - * for lessening or a degraded poison. + * An effect or other parameter that may be reduced by a failed disease check for lessening or a degraded poison. * - * This streamlines the wording for diseases and poison by using a unified - * wording for *lessened* (disease) and *degraded* (poison). + * This streamlines the wording for diseases and poison by using a unified wording for *lessened* (disease) and *degraded* (poison). */ export type Reduceable = { /** @@ -125,8 +112,7 @@ export type Reduceable = { default: Content /** - * The reduced value. In the source, it's the text after the slash. Some - * entries may not have a reduced value. + * The reduced value. In the source, it's the text after the slash. Some entries may not have a reduced value. */ reduced?: Content } diff --git a/src/types/_Enhancements.ts b/src/types/_Enhancements.ts index 5a4929b9..701b5fc8 100644 --- a/src/types/_Enhancements.ts +++ b/src/types/_Enhancements.ts @@ -2,10 +2,10 @@ * @title Enhancements */ -import { Errata } from "./source/_Erratum.js" -import { PublicationRefs } from "./source/_PublicationRef.js" import { LocaleMap } from "./_LocaleMap.js" import { EnhancementPrerequisites } from "./_Prerequisite.js" +import { Errata } from "./source/_Erratum.js" +import { PublicationRefs } from "./source/_PublicationRef.js" /** * A list of enhancements. @@ -35,8 +35,7 @@ export type Enhancement = { skill_rating: number /** - * The value to multiply with the numeric representation of the associated - * skill's improvement cost to form the final AP cost of this enhancement. + * The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement. * @integer * @minimum 1 */ diff --git a/src/types/_I18n.ts b/src/types/_I18n.ts index a6b63063..be63f38c 100644 --- a/src/types/_I18n.ts +++ b/src/types/_I18n.ts @@ -1,14 +1,7 @@ import { NonEmptyString } from "./_NonEmptyString.js" /** - * The item can be present in multiple pluralization categories; this object - * unifies handling of them. Not all of the options must be present, however, - * every possible category for that language should be defined. This means, that - * different languages may have a different amount of properties defined here. - * More information on pluralization and the Intl.PluralRules API on - * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, - * https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and - * http://cldr.unicode.org/index/cldr-spec/plural-rules. + * The item can be present in multiple pluralization categories; this object unifies handling of them. Not all of the options must be present, however, every possible category for that language should be defined. This means, that different languages may have a different amount of properties defined here. More information on pluralization and the Intl.PluralRules API on https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules, https://unicode-org.github.io/cldr/ldml/tr35-numbers.html#Language_Plural_Rules and http://cldr.unicode.org/index/cldr-spec/plural-rules. * * From the third link: * diff --git a/src/types/_Influence.ts b/src/types/_Influence.ts index 91715987..f76235c1 100644 --- a/src/types/_Influence.ts +++ b/src/types/_Influence.ts @@ -2,11 +2,11 @@ * @main Influence */ -import { Errata } from "./source/_Erratum.js" -import { PublicationRefs } from "./source/_PublicationRef.js" import { LocaleMap } from "./_LocaleMap.js" import { NonEmptyString } from "./_NonEmptyString.js" import { InfluencePrerequisites } from "./_Prerequisite.js" +import { Errata } from "./source/_Erratum.js" +import { PublicationRefs } from "./source/_PublicationRef.js" /** * @title Influence @@ -36,8 +36,7 @@ export type InfluenceTranslation = { name: NonEmptyString /** - * The effects of the influence. They should be sorted like they are in - * the book. + * The effects of the influence. They should be sorted like they are in the book. * @minItems 1 */ effects: InfluenceEffect[] @@ -47,8 +46,7 @@ export type InfluenceTranslation = { export type InfluenceEffect = { /** - * An optional label that is displayed and placed before the actual - * text. + * An optional label that is displayed and placed before the actual text. */ label?: NonEmptyString diff --git a/src/types/_Prerequisite.ts b/src/types/_Prerequisite.ts index 13e83313..2da58868 100644 --- a/src/types/_Prerequisite.ts +++ b/src/types/_Prerequisite.ts @@ -2,15 +2,28 @@ * @title Prerequisites */ -import { DisplayOption } from "./prerequisites/DisplayOption.js" -import { AdvantageDisadvantagePrerequisiteGroup, AnimistPowerPrerequisiteGroup, ArcaneTraditionPrerequisiteGroup, DerivedCharacteristicPrerequisiteGroup, EnhancementPrerequisiteGroup, GeneralPrerequisiteGroup, GeodeRitualPrerequisiteGroup, InfluencePrerequisiteGroup, LanguagePrerequisiteGroup, LiturgyPrerequisiteGroup, PersonalityTraitPrerequisiteGroup, ProfessionPrerequisiteGroup, PublicationPrerequisiteGroup, SpellworkPrerequisiteGroup } from "./prerequisites/PrerequisiteGroups.js" import { LocaleMap } from "./_LocaleMap.js" import { NonEmptyString } from "./_NonEmptyString.js" +import { DisplayOption } from "./prerequisites/DisplayOption.js" +import { + AdvantageDisadvantagePrerequisiteGroup, + AnimistPowerPrerequisiteGroup, + ArcaneTraditionPrerequisiteGroup, + DerivedCharacteristicPrerequisiteGroup, + EnhancementPrerequisiteGroup, + GeneralPrerequisiteGroup, + GeodeRitualPrerequisiteGroup, + InfluencePrerequisiteGroup, + LanguagePrerequisiteGroup, + LiturgyPrerequisiteGroup, + PersonalityTraitPrerequisiteGroup, + ProfessionPrerequisiteGroup, + PublicationPrerequisiteGroup, + SpellworkPrerequisiteGroup, +} from "./prerequisites/PrerequisiteGroups.js" /** - * A prerequisite group has no influence on validation logic. It serves as a - * single unit for displaying purposes, where the source uses a prerequisites - * item that cannot be represented as a single prerequisite. + * A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite. */ export type PrerequisiteGroup = { /** @@ -58,7 +71,8 @@ export type PrerequisiteForLevel = { */ export type PrerequisitesForLevels = PrerequisiteForLevel[] -export type DerivedCharacteristicPrerequisites = PlainPrerequisites +export type DerivedCharacteristicPrerequisites = + PlainPrerequisites export type PublicationPrerequisites = PlainPrerequisites @@ -80,7 +94,8 @@ export type ProfessionPrerequisites = PlainPrerequisites +export type AdvantageDisadvantagePrerequisites = + PrerequisitesForLevels /** * @title Arcane Tradition Prerequisites diff --git a/src/types/_ResponsiveText.ts b/src/types/_ResponsiveText.ts index e72fd89c..2e4afc64 100644 --- a/src/types/_ResponsiveText.ts +++ b/src/types/_ResponsiveText.ts @@ -1,10 +1,9 @@ import { NonEmptyString } from "./_NonEmptyString.js" /** - * A text from the source that can be also displayed in small areas using a - * compressed version. + * A text from the source that can be also displayed in small areas using a compressed version. */ - export type ResponsiveText = { +export type ResponsiveText = { /** * The full text from the source. */ @@ -17,25 +16,18 @@ import { NonEmptyString } from "./_NonEmptyString.js" } /** - * A text from the source that can be also displayed in small areas using a - * compressed version. It is used as a replacement for a generated text while - * the generated text is still provided and should be used. + * A text from the source that can be also displayed in small areas using a compressed version. It is used as a replacement for a generated text while the generated text is still provided and should be used. */ export type ResponsiveTextReplace = { /** - * The full replacement string. It must contain `$1`, which is going to be - * replaced with the generated string, so additional information can be - * provided without duplicating concrete numeric values. + * The full replacement string. It must contain `$1`, which is going to be replaced with the generated string, so additional information can be provided without duplicating concrete numeric values. * @minLength 1 * @pattern \$1 */ full: 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 string, so additional information can be provided without - * duplicating concrete numeric values. + * 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 string, so additional information can be provided without duplicating concrete numeric values. * @minLength 1 * @pattern \$1 */ @@ -43,8 +35,7 @@ export type ResponsiveTextReplace = { } /** - * A text from the source that can be also displayed in small areas using a - * compressed version, if available. + * A text from the source that can be also displayed in small areas using a compressed version, if available. */ export type ResponsiveTextOptional = { /** @@ -53,8 +44,7 @@ export type ResponsiveTextOptional = { full: NonEmptyString /** - * A compressed text for use in small areas (e.g. on character sheet). If this - * is not present, it should not appear in those areas. + * A compressed text for use in small areas (e.g. on character sheet). If this is not present, it should not appear in those areas. */ compressed?: NonEmptyString } diff --git a/src/types/_Spellwork.ts b/src/types/_Spellwork.ts index 9c35d3e4..ad0c65fa 100644 --- a/src/types/_Spellwork.ts +++ b/src/types/_Spellwork.ts @@ -1,9 +1,7 @@ import { MagicalTraditionIdentifier } from "./_Identifier.js" /** - * The tradition(s) the ritual is available for. It may be *generally* - * available to all traditions or it may be only familiar in specific - * traditions. + * The tradition(s) the ritual is available for. It may be *generally* available to all traditions or it may be only familiar in specific traditions. */ export type Traditions = | { tag: "General"; general: {} } diff --git a/src/types/equipment/EquipmentPackage.ts b/src/types/equipment/EquipmentPackage.ts index 95779e5b..ca5f1463 100644 --- a/src/types/equipment/EquipmentPackage.ts +++ b/src/types/equipment/EquipmentPackage.ts @@ -24,9 +24,7 @@ export type EquipmentPackage = { id: number /** - * All items in the package. You have to provide the item (template) - * identifier and you can optionally provide the number of how often an item - * is included in the package. + * All items in the package. You have to provide the item (template) identifier and you can optionally provide the number of how often an item is included in the package. * @minItems 2 */ items: EquipmentPackageItem[] diff --git a/src/types/equipment/item/Armor.ts b/src/types/equipment/item/Armor.ts index 0877fbc2..86417576 100644 --- a/src/types/equipment/item/Armor.ts +++ b/src/types/equipment/item/Armor.ts @@ -192,8 +192,7 @@ export type HitZone = export type HeadHitZone = { /** - * In some cases, multiple armors for the same hit zone can be combined. - * They're listed at the item that can be combined with others. + * In some cases, multiple armors for the same hit zone can be combined. They're listed at the item that can be combined with others. */ combination_possibilities?: HeadHitZoneCombinationPossibilities } @@ -206,8 +205,7 @@ export type HeadHitZoneCombinationPossibilities = { armors: ArmorReference[] /** - * The PRO value that is added to the PRO value of the other armor instead - * of adding the normale PRO value. + * The PRO value that is added to the PRO value of the other armor instead of adding the normale PRO value. * @integer * @minimum 0 */ diff --git a/src/types/equipment/item/BandageOrRemedy.ts b/src/types/equipment/item/BandageOrRemedy.ts index 24009a36..fd65d6d2 100644 --- a/src/types/equipment/item/BandageOrRemedy.ts +++ b/src/types/equipment/item/BandageOrRemedy.ts @@ -9,7 +9,14 @@ import { createSchemaValidator } from "../../../validation/builders/schema.js" import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js" import { LocaleMap } from "../../_LocaleMap.js" import { PublicationRefs } from "../../source/_PublicationRef.js" -import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js" +import { + CombatUse, + Complexity, + Cost, + DefaultItemTranslation, + StructurePoints, + Weight, +} from "./_Item.js" export type BandageOrRemedy = { /** @@ -28,14 +35,12 @@ export type BandageOrRemedy = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points?: StructurePoints /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse diff --git a/src/types/equipment/item/Book.ts b/src/types/equipment/item/Book.ts index e36b8830..555a62eb 100644 --- a/src/types/equipment/item/Book.ts +++ b/src/types/equipment/item/Book.ts @@ -30,8 +30,7 @@ export type Book = { complexity: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints diff --git a/src/types/equipment/item/CeremonialItem.ts b/src/types/equipment/item/CeremonialItem.ts index e469ca61..55f6984c 100644 --- a/src/types/equipment/item/CeremonialItem.ts +++ b/src/types/equipment/item/CeremonialItem.ts @@ -10,7 +10,14 @@ import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js" import { LocaleMap } from "../../_LocaleMap.js" import { BlessedTraditionReference } from "../../_SimpleReferences.js" import { PublicationRefs } from "../../source/_PublicationRef.js" -import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js" +import { + CombatUse, + Complexity, + Cost, + DefaultItemTranslation, + StructurePoints, + Weight, +} from "./_Item.js" export type CeremonialItem = { /** @@ -29,8 +36,7 @@ export type CeremonialItem = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints @@ -40,8 +46,7 @@ export type CeremonialItem = { associated_tradition: BlessedTraditionReference /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse diff --git a/src/types/equipment/item/Elixir.ts b/src/types/equipment/item/Elixir.ts index 456b4f24..91108465 100644 --- a/src/types/equipment/item/Elixir.ts +++ b/src/types/equipment/item/Elixir.ts @@ -33,8 +33,7 @@ export type Elixir = { laboratory: LaboratoryLevel /** - * The brewing difficulty, which represents the challenge of creating an - * elixir. + * The brewing difficulty, which represents the challenge of creating an elixir. * @integer */ brewing_difficulty: number @@ -77,8 +76,7 @@ export type ElixirTranslation = { brewing_process_prerequisites?: NonEmptyMarkdown /** - * The list of effects for each quality level. The first element - * represents QL 1, the second element QL 2, and so on. + * The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. * @minLength 6 * @maxLength 6 */ diff --git a/src/types/equipment/item/EquipmentOfBlessedOnes.ts b/src/types/equipment/item/EquipmentOfBlessedOnes.ts index 2c1c6c61..a70c7b04 100644 --- a/src/types/equipment/item/EquipmentOfBlessedOnes.ts +++ b/src/types/equipment/item/EquipmentOfBlessedOnes.ts @@ -19,8 +19,7 @@ export type EquipmentOfBlessedOnes = { cost: Cost /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints diff --git a/src/types/equipment/item/IlluminationLightSource.ts b/src/types/equipment/item/IlluminationLightSource.ts index b9be4904..9684e607 100644 --- a/src/types/equipment/item/IlluminationLightSource.ts +++ b/src/types/equipment/item/IlluminationLightSource.ts @@ -9,7 +9,14 @@ import { createSchemaValidator } from "../../../validation/builders/schema.js" import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js" import { LocaleMap } from "../../_LocaleMap.js" import { PublicationRefs } from "../../source/_PublicationRef.js" -import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js" +import { + CombatUse, + Complexity, + Cost, + DefaultItemTranslation, + StructurePoints, + Weight, +} from "./_Item.js" export type IlluminationLightSource = { /** @@ -28,20 +35,17 @@ export type IlluminationLightSource = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints /** - * The burning time is the time how long the light source can be lit. After - * that time you have to use a new light source. + * The burning time is the time how long the light source can be lit. After that time you have to use a new light source. */ burning_time: BurningTime /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse @@ -70,8 +74,7 @@ export type LimitedBurningTime = { unit: LimitedBurningTimeUnit } -export type LimitedBurningTimeUnit = - | "Hours" +export type LimitedBurningTimeUnit = "Hours" export const config: TypeConfig = { name: "IlluminationLightSource", diff --git a/src/types/equipment/item/Jewelry.ts b/src/types/equipment/item/Jewelry.ts index 0b4ef36e..26406e57 100644 --- a/src/types/equipment/item/Jewelry.ts +++ b/src/types/equipment/item/Jewelry.ts @@ -30,8 +30,7 @@ export type Jewelry = { complexity: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints diff --git a/src/types/equipment/item/LuxuryGood.ts b/src/types/equipment/item/LuxuryGood.ts index 38f74e49..30b2b0b7 100644 --- a/src/types/equipment/item/LuxuryGood.ts +++ b/src/types/equipment/item/LuxuryGood.ts @@ -9,7 +9,14 @@ import { createSchemaValidator } from "../../../validation/builders/schema.js" import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js" import { LocaleMap } from "../../_LocaleMap.js" import { PublicationRefs } from "../../source/_PublicationRef.js" -import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js" +import { + CombatUse, + Complexity, + Cost, + DefaultItemTranslation, + StructurePoints, + Weight, +} from "./_Item.js" export type LuxuryGood = { /** @@ -28,14 +35,12 @@ export type LuxuryGood = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points?: StructurePoints /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse diff --git a/src/types/equipment/item/MusicalInstrument.ts b/src/types/equipment/item/MusicalInstrument.ts index b61b10e7..3bc861da 100644 --- a/src/types/equipment/item/MusicalInstrument.ts +++ b/src/types/equipment/item/MusicalInstrument.ts @@ -28,8 +28,7 @@ export type MusicalInstrument = { complexity?: Complexity /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse diff --git a/src/types/equipment/item/Poison.ts b/src/types/equipment/item/Poison.ts index 284e8b11..9b0ff042 100644 --- a/src/types/equipment/item/Poison.ts +++ b/src/types/equipment/item/Poison.ts @@ -76,22 +76,18 @@ export type Poison = { translations: LocaleMap } -export type PoisonApplicationType = - | "Weapon" - | "Ingestion" - | "Inhalation" - | "Contact" +export type PoisonApplicationType = "Weapon" | "Ingestion" | "Inhalation" | "Contact" export type PoisonStart = - | { tag: "Immediate", immediate: {} } - | { tag: "Constant", constant: ConstantPoisonTime } - | { tag: "DiceBased", dice_based: DiceBasedPoisonTime } + | { tag: "Immediate"; immediate: {} } + | { tag: "Constant"; constant: ConstantPoisonTime } + | { tag: "DiceBased"; dice_based: DiceBasedPoisonTime } export type PoisonDuration = - | { tag: "Instant", instant: {} } - | { tag: "Constant", constant: ConstantPoisonTime } - | { tag: "DiceBased", dice_based: DiceBasedPoisonTime } - | { tag: "Indefinite", indefinite: IndefinitePoisonTime } + | { tag: "Instant"; instant: {} } + | { tag: "Constant"; constant: ConstantPoisonTime } + | { tag: "DiceBased"; dice_based: DiceBasedPoisonTime } + | { tag: "Indefinite"; indefinite: IndefinitePoisonTime } export type ConstantPoisonTime = { value: number @@ -103,11 +99,7 @@ export type DiceBasedPoisonTime = { unit: PoisonTimeUnit } -export type PoisonTimeUnit = - | "CombatRounds" - | "Minutes" - | "Hours" - | "Days" +export type PoisonTimeUnit = "CombatRounds" | "Minutes" | "Hours" | "Days" export type IndefinitePoisonTime = { /** @@ -164,8 +156,7 @@ export type AlchemicalPoison = { laboratory: LaboratoryLevel /** - * The brewing difficulty, which represents the challenge of creating an - * elixir. + * The brewing difficulty, which represents the challenge of creating an elixir. * @integer */ brewing_difficulty: number @@ -252,9 +243,7 @@ export type QualityLevelDemonicPoisonLevel = { source: QualityLevelDemonicPoisonLevelSource } -export type QualityLevelDemonicPoisonLevelSource = - | "Spellwork" - +export type QualityLevelDemonicPoisonLevelSource = "Spellwork" export type ConstantDemonicPoisonLevel = { /** @@ -278,15 +267,12 @@ export type DemonicPoisonTranslation = { export type Intoxicant = { /** - * Whether the use of the intoxicant is legal or not, usually from the - * perspective of most middle-Aventurian an northern-Aventurian nations. + * Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. */ legality: IntoxicantLegality /** - * The chance of getting addicted after an ingestion in addition to the - * maximum interval at which it, while addicted, must be ingested to not - * suffer from withdrawal symptoms. + * The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. */ addiction?: IntoxicantAddiction @@ -298,17 +284,14 @@ export type Intoxicant = { } /** - * Whether the use of the intoxicant is legal or not, usually from the - * perspective of most middle-Aventurian an northern-Aventurian nations. + * Whether the use of the intoxicant is legal or not, usually from the perspective of most middle-Aventurian an northern-Aventurian nations. */ export type IntoxicantLegality = { is_legal: boolean } /** - * The chance of getting addicted after an ingestion in addition to the maximum - * interval at which it, while addicted, must be ingested to not suffer from - * withdrawal symptoms. + * The chance of getting addicted after an ingestion in addition to the maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. */ export type IntoxicantAddiction = { /** @@ -317,19 +300,17 @@ export type IntoxicantAddiction = { chance: number /** - * The maximum interval at which it, while addicted, must be ingested to not - * suffer from withdrawal symptoms. + * The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. */ interval: IntoxicantAddictionInterval } /** - * The maximum interval at which it, while addicted, must be ingested to not - * suffer from withdrawal symptoms. + * The maximum interval at which it, while addicted, must be ingested to not suffer from withdrawal symptoms. */ export type IntoxicantAddictionInterval = - | { tag: "Constant", constant: ConstantIntoxicantAddictionInterval } - | { tag: "DiceBased", dice_based: DiceBasedIntoxicantAddictionInterval } + | { tag: "Constant"; constant: ConstantIntoxicantAddictionInterval } + | { tag: "DiceBased"; dice_based: DiceBasedIntoxicantAddictionInterval } export type ConstantIntoxicantAddictionInterval = { /** @@ -352,14 +333,12 @@ export type IntoxicantTranslation = { ingestion: NonEmptyString /** - * The intoxicants side effects that always happen, no matter whether the - * intoxicant has the default or the reduced effect. + * The intoxicants side effects that always happen, no matter whether the intoxicant has the default or the reduced effect. */ side_effect?: NonEmptyMarkdown /** - * What happens if the intoxicant has been overdosed, that is, it has been - * ingested another time within the duration. + * What happens if the intoxicant has been overdosed, that is, it has been ingested another time within the duration. */ overdose: NonEmptyMarkdown diff --git a/src/types/equipment/item/ToolOfTheTrade.ts b/src/types/equipment/item/ToolOfTheTrade.ts index f0fb7713..8fc73115 100644 --- a/src/types/equipment/item/ToolOfTheTrade.ts +++ b/src/types/equipment/item/ToolOfTheTrade.ts @@ -31,8 +31,7 @@ export type ToolOfTheTrade = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points?: StructurePoints diff --git a/src/types/equipment/item/Weapon.ts b/src/types/equipment/item/Weapon.ts index 9ebcab39..80a9fa3c 100644 --- a/src/types/equipment/item/Weapon.ts +++ b/src/types/equipment/item/Weapon.ts @@ -9,7 +9,12 @@ import { createSchemaValidator } from "../../../validation/builders/schema.js" import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js" import { LocaleMap } from "../../_LocaleMap.js" import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js" -import { BlessedTraditionReference, CultureReference, MagicalTraditionReference, RaceReference } from "../../_SimpleReferences.js" +import { + BlessedTraditionReference, + CultureReference, + MagicalTraditionReference, + RaceReference, +} from "../../_SimpleReferences.js" import { Errata } from "../../source/_Erratum.js" import { PublicationRefs } from "../../source/_PublicationRef.js" import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js" @@ -33,33 +38,28 @@ export type Weapon = { complexity: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points?: StructurePoints /** - * A list of stat blocks for each combat technique this weapon can be used - * with. + * A list of stat blocks for each combat technique this weapon can be used with. * @minItems 1 */ uses: WeaponUse[] /** - * If the weapon is sanctified by a god and thus restricted to it's Blessed - * Ones. + * If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. */ sanctified_by?: SanctifiedBy /** - * Define if during character creation this weapon can only be bought by - * characters of a specific race or culture. + * Define if during character creation this weapon can only be bought by characters of a specific race or culture. */ restricted_to_cultures?: RestrictedToCultures /** - * Define if during character creation this weapon can only be bought by - * characters of specific magical or blessed traditions. + * Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. * @minItems 1 */ restricted_to_traditions?: MagicalTraditionReference[] @@ -108,27 +108,23 @@ export type WeaponTranslation = { export type SecondaryWeapon = { /** - * A list of stat blocks for each combat technique this weapon can be used - * with. + * A list of stat blocks for each combat technique this weapon can be used with. * @minItems 1 */ uses: WeaponUse[] /** - * If the weapon is sanctified by a god and thus restricted to it's Blessed - * Ones. + * If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. */ sanctified_by?: SanctifiedBy /** - * Define if during character creation this weapon can only be bought by - * characters of a specific race or culture. + * Define if during character creation this weapon can only be bought by characters of a specific race or culture. */ restricted_to_cultures?: RestrictedToCultures /** - * Define if during character creation this weapon can only be bought by - * characters of specific magical or blessed traditions. + * Define if during character creation this weapon can only be bought by characters of specific magical or blessed traditions. * @minItems 1 */ restricted_to_traditions?: MagicalTraditionReference[] @@ -170,15 +166,13 @@ export type WeaponUseValues = | { tag: "Ranged"; ranged: RangedWeapon } /** - * If the weapon is sanctified by a god and thus restricted to it's Blessed - * Ones. + * If the weapon is sanctified by a god and thus restricted to it's Blessed Ones. * @minItems 1 */ export type SanctifiedBy = BlessedTraditionReference[] /** - * Define if during character creation this weapon can only be bought by - * characters of a specific race or culture. + * Define if during character creation this weapon can only be bought by characters of a specific race or culture. */ export type RestrictedToCultures = | { tag: "CulturesOfRace"; cultures_of_race: RaceReference } diff --git a/src/types/equipment/item/_Item.ts b/src/types/equipment/item/_Item.ts index 359781c2..2f5cfc66 100644 --- a/src/types/equipment/item/_Item.ts +++ b/src/types/equipment/item/_Item.ts @@ -1,7 +1,7 @@ -import { Errata } from "../../source/_Erratum.js" -import { PublicationRefs } from "../../source/_PublicationRef.js" import { LocaleMap } from "../../_LocaleMap.js" import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js" +import { Errata } from "../../source/_Erratum.js" +import { PublicationRefs } from "../../source/_PublicationRef.js" import { SecondaryArmor } from "./Armor.js" import { SecondaryWeapon } from "./Weapon.js" @@ -22,14 +22,12 @@ export type DefaultItem = { complexity?: Complexity /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. */ structure_points: StructurePoints /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ combat_use?: CombatUse @@ -42,8 +40,7 @@ export type DefaultItem = { } /** - * The item can also be used either as an improvised weapon or as an armor, - * although this is not the primary use case of the item. + * The item can also be used either as an improvised weapon or as an armor, although this is not the primary use case of the item. */ export type CombatUse = | { tag: "Weapon"; weapon: SecondaryWeapon } @@ -74,8 +71,7 @@ export type DefaultItemTranslation = { } /** - * The structure points of the item. Use an array if the item consists of - * multiple components that have individual structure points. + * 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 */ @@ -96,7 +92,7 @@ export type StructurePointsComponent = { export type Cost = | { tag: "Free"; free: {} } | { tag: "Various"; various: {} } - | { tag: "Invaluable", invaluable: {} } + | { tag: "Invaluable"; invaluable: {} } | { tag: "Fixed"; fixed: FixedCost } | { tag: "Range"; range: CostRange } diff --git a/src/types/equipment/item/_MeleeWeapon.ts b/src/types/equipment/item/_MeleeWeapon.ts index f355954f..820444cd 100644 --- a/src/types/equipment/item/_MeleeWeapon.ts +++ b/src/types/equipment/item/_MeleeWeapon.ts @@ -20,8 +20,7 @@ export type AttackModifier = number export type ParryModifier = number /** - * The damage of a weapon consists of a random part using dice and an optional - * flat part. + * The damage of a weapon consists of a random part using dice and an optional flat part. */ export type MeleeDamage = { /** @@ -64,8 +63,7 @@ export type MeleeWeapon = { combat_technique: CloseCombatTechniqueReference /** - * The damage of a weapon consists of a random part using dice and an optional - * flat part. + * The damage of a weapon consists of a random part using dice and an optional flat part. */ damage: MeleeDamage diff --git a/src/types/equipment/item/_RangedWeapon.ts b/src/types/equipment/item/_RangedWeapon.ts index 76898088..cc506eb0 100644 --- a/src/types/equipment/item/_RangedWeapon.ts +++ b/src/types/equipment/item/_RangedWeapon.ts @@ -8,10 +8,7 @@ import { RangedCombatTechniqueReference } from "../../_SimpleReferences.js" import { Length } from "./_Weapon.js" /** - * 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. + * 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. */ export type RangedDamage = | { tag: "Default"; default: DefaultRangedDamage } @@ -19,8 +16,7 @@ export type RangedDamage = | { tag: "Special"; special: {} } /** - * The damage of a weapon consists of a random part using dice and an optional - * flat part. + * The damage of a weapon consists of a random part using dice and an optional flat part. */ export type DefaultRangedDamage = { /** @@ -46,8 +42,7 @@ export type RangedWeapon = { combat_technique: RangedCombatTechniqueReference /** - * The damage of a weapon consists of a random part using dice and an optional - * flat part. + * The damage of a weapon consists of a random part using dice and an optional flat part. */ damage: RangedDamage diff --git a/src/types/equipment/item/_Weapon.ts b/src/types/equipment/item/_Weapon.ts index 6de7067f..112320da 100644 --- a/src/types/equipment/item/_Weapon.ts +++ b/src/types/equipment/item/_Weapon.ts @@ -1,16 +1,7 @@ import { AttributeReference } from "../../_SimpleReferences.js" /** - * 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). + * 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). * @minItems 1 * @uniqueItems */ @@ -20,8 +11,7 @@ export type PrimaryAttributeDamageThreshold = export type DefaultPrimaryAttributeDamageThreshold = { /** - * The attribute value representing the damage threshold for the primary - * attribute of the item's combat technique. + * The attribute value representing the damage threshold for the primary attribute of the item's combat technique. * @integer * @minimum 1 */ diff --git a/src/types/equipment/item/sub/ArmorType.ts b/src/types/equipment/item/sub/ArmorType.ts index 5c5153ba..56cd760d 100644 --- a/src/types/equipment/item/sub/ArmorType.ts +++ b/src/types/equipment/item/sub/ArmorType.ts @@ -22,9 +22,7 @@ export type ArmorType = { id: number /** - * An armor type can have a *sturdiness rating*. The higher the rating, the - * more durable the armor. Rolling higher than this rating during a sturdiness - * check means the armor receives one level of the new condition *Wear*. + * An armor type can have a *sturdiness rating*. The higher the rating, the more durable the armor. Rolling higher than this rating during a sturdiness check means the armor receives one level of the new condition *Wear*. * @integer * @minimum 1 * @msximum 20 diff --git a/src/types/magicalActions/AnimistPower.ts b/src/types/magicalActions/AnimistPower.ts index 0c62165a..5c117024 100644 --- a/src/types/magicalActions/AnimistPower.ts +++ b/src/types/magicalActions/AnimistPower.ts @@ -48,29 +48,22 @@ export type AnimistPower = { property: PropertyReference /** - * The tribe traditions the animist power is available to. It may be available - * to all or only specific tribes. + * The tribe traditions the animist power is available to. It may be available to all or only specific tribes. * - * If no tribe tradition is given, the animist power is generally available to - * all tribe traditions. + * If no tribe tradition is given, the animist power is generally available to all tribe traditions. * @uniqueItems */ tribe_tradition: AnimistTribeReference[] /** - * States which column is used to improve the skill. It is a fixed value or - * depends on the primary patron. + * States which column is used to improve the skill. It is a fixed value or depends on the primary patron. */ improvement_cost: AnimistPowerImprovementCost prerequisites?: AnimistPowerPrerequisites /** - * The animist power can have multiple levels. Each level is skilled - * separately. A previous level must be on at least 10 so that the next higher - * level can be activated and skilled. A higher level cannot be skilled higher - * than a lower level. Each level also adds an effect text to the text of the - * first level. + * The animist power can have multiple levels. Each level is skilled separately. A previous level must be on at least 10 so that the next higher level can be activated and skilled. A higher level cannot be skilled higher than a lower level. Each level also adds an effect text to the text of the first level. * @minItems 1 */ levels?: AnimistPowerLevel[] @@ -97,9 +90,7 @@ export type AnimistPowerTranslation = { name_in_library?: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -157,8 +148,7 @@ export type AnimistPowerPerformanceParameters = export type OneTimeAnimistPowerPerformanceParameters = { /** - * The AE cost value, either a flat value or defined dynamically by the - * primary patron. + * The AE cost value, either a flat value or defined dynamically by the primary patron. */ cost: OneTimeAnimistPowerCost @@ -205,8 +195,7 @@ export type OneTimeAnimistPowerDuration = export type SustainedAnimistPowerPerformanceParameters = { /** - * The AE cost value, either a flat value or defined dynamically by the - * primary patron. + * The AE cost value, either a flat value or defined dynamically by the primary patron. */ cost: SustainedAnimistPowerCost } diff --git a/src/types/magicalActions/Curse.ts b/src/types/magicalActions/Curse.ts index ff90babf..3e0e31cc 100644 --- a/src/types/magicalActions/Curse.ts +++ b/src/types/magicalActions/Curse.ts @@ -69,9 +69,7 @@ export type CurseTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -126,8 +124,7 @@ export type FixedCurseCost = { */ export type FixedCurseCostTranslation = { /** - * The cost have to be per a specific countable entity, e.g. `8 KP - * per person`. + * The cost have to be per a specific countable entity, e.g. `8 KP per person`. */ per?: ResponsiveText diff --git a/src/types/magicalActions/DominationRitual.ts b/src/types/magicalActions/DominationRitual.ts index 161b40ce..ff538cae 100644 --- a/src/types/magicalActions/DominationRitual.ts +++ b/src/types/magicalActions/DominationRitual.ts @@ -68,9 +68,7 @@ export type DominationRitualTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/magicalActions/ElvenMagicalSong.ts b/src/types/magicalActions/ElvenMagicalSong.ts index 11db00a5..d3c66dc4 100644 --- a/src/types/magicalActions/ElvenMagicalSong.ts +++ b/src/types/magicalActions/ElvenMagicalSong.ts @@ -81,9 +81,7 @@ export type ElvenMagicalSongTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -152,8 +150,7 @@ export type ElvenMagicalSongPermanentCostTranslation = { export type ElvenMagicalSongCostTranslation = { /** - * The cost have to be per a specific countable entity, e.g. `8 AE - * per person`. + * The cost have to be per a specific countable entity, e.g. `8 AE per person`. */ per: ResponsiveText } diff --git a/src/types/magicalActions/GeodeRitual.ts b/src/types/magicalActions/GeodeRitual.ts index e5861f3f..5984beae 100644 --- a/src/types/magicalActions/GeodeRitual.ts +++ b/src/types/magicalActions/GeodeRitual.ts @@ -69,9 +69,7 @@ export type GeodeRitualTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/magicalActions/JesterTrick.ts b/src/types/magicalActions/JesterTrick.ts index 747ce5e1..737745e8 100644 --- a/src/types/magicalActions/JesterTrick.ts +++ b/src/types/magicalActions/JesterTrick.ts @@ -75,9 +75,7 @@ export type JesterTrickTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/magicalActions/MagicalDance.ts b/src/types/magicalActions/MagicalDance.ts index d5b404f7..447ee7cb 100644 --- a/src/types/magicalActions/MagicalDance.ts +++ b/src/types/magicalActions/MagicalDance.ts @@ -48,8 +48,7 @@ export type MagicalDance = { property: PropertyReference /** - * The music tradition(s) the magical dance is available for. This also - * defines the different names in each music tradition. + * 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[] @@ -74,9 +73,7 @@ export type MagicalDanceTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -121,8 +118,7 @@ export type FixedMagicalDanceCost = { export type IndefiniteMagicalDanceCost = { /** - * Specified if the indefinite description's result value is to be - * modified by a certain number. + * Specified if the indefinite description's result value is to be modified by a certain number. */ modifier?: CheckResultBasedModifier diff --git a/src/types/magicalActions/MagicalMelody.ts b/src/types/magicalActions/MagicalMelody.ts index b4266a6b..9603be1a 100644 --- a/src/types/magicalActions/MagicalMelody.ts +++ b/src/types/magicalActions/MagicalMelody.ts @@ -41,8 +41,7 @@ export type MagicalMelody = { check_penalty?: SkillCheckPenalty /** - * Arcane bards must make a *Singing (area of application)* or *Music (area of - * application)* check for each magical melody. + * Arcane bards must make a *Singing (area of application)* or *Music (area of application)* check for each magical melody. * @minItems 1 * @maxItems 2 * @uniqueItems @@ -60,8 +59,7 @@ export type MagicalMelody = { property: PropertyReference /** - * The music tradition(s) the magical melody is available for. This also - * defines the different names in each music tradition. + * 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[] @@ -86,9 +84,7 @@ export type MagicalMelodyTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -128,8 +124,7 @@ export type FixedMagicalMelodyCost = { export type FirstPersonMagicalMelodyCost = { /** - * The (temporary) AE cost value for the first targeted person. The AE - * cost for each additional person is half this value. + * 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 diff --git a/src/types/magicalActions/MagicalRune.ts b/src/types/magicalActions/MagicalRune.ts index 67274edf..97be5fd6 100644 --- a/src/types/magicalActions/MagicalRune.ts +++ b/src/types/magicalActions/MagicalRune.ts @@ -34,8 +34,7 @@ export type MagicalRune = { /** * The options the magical rune has, if any. * - * If there are multiple options, the magical rune may be activated for each - * option, that is, multiple times. + * If there are multiple options, the magical rune may be activated for each option, that is, multiple times. */ options?: MagicalRuneOption[] @@ -76,15 +75,12 @@ export type MagicalRuneTranslation = { /** * The name of the magical rune. * - * If the rune has an option, the option’s name will/should not be included in - * the name as well as its surrounding parenthesis. It will/should be combined - * on demand. + * If the rune has an option, the option’s name will/should not be included in the name as well as its surrounding parenthesis. It will/should be combined on demand. */ name: NonEmptyString /** - * The full name of the entry as stated in the sources. Only use when `name` - * needs to be different from full name for text generation purposes. + * The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes. */ name_in_library?: NonEmptyString @@ -94,9 +90,7 @@ export type MagicalRuneTranslation = { native_name?: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect @@ -232,8 +226,7 @@ export type MagicalRuneCraftingTime = { export type MagicalRuneCraftingTimeTranslation = { /** - * The crafting time has to be per a specific countable entity, e.g. `8 - * action per person`. + * The crafting time has to be per a specific countable entity, e.g. `8 action per person`. */ per: ResponsiveText } @@ -304,8 +297,7 @@ export type MagicalRuneOptionTranslation = { /** * The name of the option. * - * The surrounding parenthesis will/should not be included, they will/should - * be generated. + * The surrounding parenthesis will/should not be included, they will/should be generated. */ name: NonEmptyString diff --git a/src/types/magicalActions/ZibiljaRitual.ts b/src/types/magicalActions/ZibiljaRitual.ts index ed04b55e..297cebfb 100644 --- a/src/types/magicalActions/ZibiljaRitual.ts +++ b/src/types/magicalActions/ZibiljaRitual.ts @@ -75,9 +75,7 @@ export type ZibiljaRitualTranslation = { name: NonEmptyString /** - * 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. + * 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: ActivatableSkillEffect diff --git a/src/types/magicalActions/_MusicTradition.ts b/src/types/magicalActions/_MusicTradition.ts index f75283ee..b13b56e3 100644 --- a/src/types/magicalActions/_MusicTradition.ts +++ b/src/types/magicalActions/_MusicTradition.ts @@ -2,8 +2,7 @@ import { LocaleMap } from "../_LocaleMap.js" import { NonEmptyString } from "../_NonEmptyString.js" /** - * A reference to a music tradition with the music-tradition-specific name of - * the entry + * A reference to a music tradition with the music-tradition-specific name of the entry */ export type MusicTraditionReference = { /** @@ -31,10 +30,6 @@ export type MusicDuration = { reusability: MusicReusability } -export type MusicLength = - | "Long" - | "Short" +export type MusicLength = "Long" | "Short" -export type MusicReusability = - | "OneTime" - | "Sustainable" +export type MusicReusability = "OneTime" | "Sustainable" diff --git a/src/types/prerequisites/ConditionalPrerequisites.ts b/src/types/prerequisites/ConditionalPrerequisites.ts index 5c3370a5..55144534 100644 --- a/src/types/prerequisites/ConditionalPrerequisites.ts +++ b/src/types/prerequisites/ConditionalPrerequisites.ts @@ -1,8 +1,7 @@ import { PreconditionGroup } from "./PrerequisiteGroups.js" /** - * A list of preconditions for the prerequisite it is defined on, so that it - * only takes effect if the prerequisites in this list are matched. + * A list of preconditions for the prerequisite it is defined on, so that it only takes effect if the prerequisites in this list are matched. * * Usually appears at the `when` property of the parent prerequisite. * @title Preconditions (`when`) diff --git a/src/types/prerequisites/DisplayOption.ts b/src/types/prerequisites/DisplayOption.ts index a139ebd7..64e27ebf 100644 --- a/src/types/prerequisites/DisplayOption.ts +++ b/src/types/prerequisites/DisplayOption.ts @@ -11,16 +11,9 @@ export type DisplayOption = export type ReplacementDisplayOption = { /** - * If the replacement text is a sentence or sentence-like fragment, this - * property ensures it is integrated into the prerequisite string correctly. + * If the replacement text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. * - * A standalone sentence is connected to the previous prerequisite string with - * a period and a period is also added at the end of the sentence - * automatically, if it is not present. A connected sentence is connected to - * the previous prerequisite string with a semicolon and a period is not added - * to the end of the sentence. In this case, if there are prerequisites after - * this one, they will be connected using a semicolon again, unless a - * different punctuation mark is present at the end of the given text. + * A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. */ sentence_type?: SentenceType diff --git a/src/types/prerequisites/single/ActivatablePrerequisite.ts b/src/types/prerequisites/single/ActivatablePrerequisite.ts index c5a08cc6..dc75d5e1 100644 --- a/src/types/prerequisites/single/ActivatablePrerequisite.ts +++ b/src/types/prerequisites/single/ActivatablePrerequisite.ts @@ -25,8 +25,7 @@ export type ActivatablePrerequisite = { level?: number /** - * Required select options. Order is important. Typically, you only need the - * first array index, though. + * Required select options. Order is important. Typically, you only need the first array index, though. * @minItems 1 */ options?: RequirableSelectOptionIdentifier[] diff --git a/src/types/prerequisites/single/EnhancementPrerequisite.ts b/src/types/prerequisites/single/EnhancementPrerequisite.ts index ff30018b..6ec90a49 100644 --- a/src/types/prerequisites/single/EnhancementPrerequisite.ts +++ b/src/types/prerequisites/single/EnhancementPrerequisite.ts @@ -2,9 +2,7 @@ import { SkillWithEnhancementsIdentifier } from "../../_IdentifierGroup.js" import { DisplayOption } from "../DisplayOption.js" /** - * Requires a specific enhancement from a skill. This should **not** be used - * for enhancements themselves; they can only require enhancements from the same - * skill they enhance. + * Requires a specific enhancement from a skill. This should **not** be used for enhancements themselves; they can only require enhancements from the same skill they enhance. * @title External Enhancement Prerequisite */ export type ExternalEnhancementPrerequisite = { @@ -38,8 +36,7 @@ export type EnhancementsReference = { } /** - * Requires a specific enhancement from a skill. This can only be used by an - * enhancement to require another enhancement from the same skill. + * Requires a specific enhancement from a skill. This can only be used by an enhancement to require another enhancement from the same skill. * @title Internal Enhancement Prerequisite */ export type InternalEnhancementPrerequisite = EnhancementsReference diff --git a/src/types/prerequisites/single/RacePrerequisite.ts b/src/types/prerequisites/single/RacePrerequisite.ts index 8d4b0542..96ea65df 100644 --- a/src/types/prerequisites/single/RacePrerequisite.ts +++ b/src/types/prerequisites/single/RacePrerequisite.ts @@ -2,9 +2,7 @@ import { RaceIdentifier } from "../../_Identifier.js" import { DisplayOption } from "../DisplayOption.js" /** - * Requires a specific race or one of a specific set of races. You can also - * provide an object to say whether the hero must meet one of the races or - * if the entry does not allow one of the races. + * Requires a specific race or one of a specific set of races. You can also provide an object to say whether the hero must meet one of the races or if the entry does not allow one of the races. * @title Race Prerequisite */ export type RacePrerequisite = { diff --git a/src/types/prerequisites/single/RatedMinimumNumberPrerequisite.ts b/src/types/prerequisites/single/RatedMinimumNumberPrerequisite.ts index 487bcbc9..25d54a2d 100644 --- a/src/types/prerequisites/single/RatedMinimumNumberPrerequisite.ts +++ b/src/types/prerequisites/single/RatedMinimumNumberPrerequisite.ts @@ -6,16 +6,14 @@ import { DisplayOption } from "../DisplayOption.js" */ export type RatedMinimumNumberPrerequisite = { /** - * The minimum number of skills that need to be on the defined minimum skill - * rating. + * The minimum number of skills that need to be on the defined minimum skill rating. * @integer * @minimum 1 */ number: number /** - * The minimum skill rating the defined minimum number of skills need to be - * on. + * The minimum skill rating the defined minimum number of skills need to be on. * @integer * @minimum 1 */ @@ -48,10 +46,7 @@ export type CombatTechniquesTarget = { group: CombatTechniquesTargetGroup } -export type CombatTechniquesTargetGroup = - | "All" - | "Close" - | "Ranged" +export type CombatTechniquesTargetGroup = "All" | "Close" | "Ranged" export type RatedMinimumNumberPrerequisiteSpellworksTarget = { /** diff --git a/src/types/prerequisites/single/TextPrerequisite.ts b/src/types/prerequisites/single/TextPrerequisite.ts index e938d4b9..e0ca295f 100644 --- a/src/types/prerequisites/single/TextPrerequisite.ts +++ b/src/types/prerequisites/single/TextPrerequisite.ts @@ -2,42 +2,26 @@ import { LocaleMap } from "../../_LocaleMap.js" import { NonEmptyMarkdown } from "../../_NonEmptyString.js" /** - * A prerequisite that is either not verifyable in general – e.g. roleplay or - * background information – or the referenced entities were not made available - * for use yet – e.g. races –, but which should be displayed, because it is part - * of the prerequisite string from the sources. + * A prerequisite that is either not verifyable in general – e.g. roleplay or background information – or the referenced entities were not made available for use yet – e.g. races –, but which should be displayed, because it is part of the prerequisite string from the sources. * @title Text Prerequisite */ export type TextPrerequisite = { /** - * The method how the prerequisite should be verified. Either is passes all - * verification text or it denies all verification tests. The latter results - * in the associated entry to never be available for purchase. + * The method how the prerequisite should be verified. Either is passes all verification text or it denies all verification tests. The latter results in the associated entry to never be available for purchase. */ verification: TextVerificationRule /** - * If the text is a sentence or sentence-like fragment, this property ensures - * it is integrated into the prerequisite string correctly. + * If the text is a sentence or sentence-like fragment, this property ensures it is integrated into the prerequisite string correctly. * - * A standalone sentence is connected to the previous prerequisite string with - * a period and a period is also added at the end of the sentence - * automatically, if it is not present. A connected sentence is connected to - * the previous prerequisite string with a semicolon and a period is not added - * to the end of the sentence. In this case, if there are prerequisites after - * this one, they will be connected using a semicolon again, unless a - * different punctuation mark is present at the end of the given text. + * A standalone sentence is connected to the previous prerequisite string with a period and a period is also added at the end of the sentence automatically, if it is not present. A connected sentence is connected to the previous prerequisite string with a semicolon and a period is not added to the end of the sentence. In this case, if there are prerequisites after this one, they will be connected using a semicolon again, unless a different punctuation mark is present at the end of the given text. */ sentence_type?: SentenceType /** - * If the text does not represent an actual prerequisite but a prerequisite - * for the use of certain aspects or the entry the prerequisite is associated - * with, or something like that, this property is set to `true`. + * If the text does not represent an actual prerequisite but a prerequisite for the use of certain aspects or the entry the prerequisite is associated with, or something like that, this property is set to `true`. * - * If all prerequisites of an entry are marked as meta, the entry is - * considered to have no prerequisites and thus the string `none` must be - * rendered before the list of meta prerequisites. + * If all prerequisites of an entry are marked as meta, the entry is considered to have no prerequisites and thus the string `none` must be rendered before the list of meta prerequisites. * * This is the only use case for this property. */ diff --git a/src/types/prerequisites/single/TraditionPrerequisite.ts b/src/types/prerequisites/single/TraditionPrerequisite.ts index ad986970..eb2d1c8c 100644 --- a/src/types/prerequisites/single/TraditionPrerequisite.ts +++ b/src/types/prerequisites/single/TraditionPrerequisite.ts @@ -5,8 +5,7 @@ import { DisplayOption } from "../DisplayOption.js" */ export type BlessedTraditionPrerequisite = { /** - * The blessed tradition prerequisite may only be satified if the blessed - * tradition is either church or shamanistic. + * The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. */ restriction?: BlessedTraditionPrerequisiteRestriction @@ -14,20 +13,16 @@ export type BlessedTraditionPrerequisite = { } /** - * The blessed tradition prerequisite may only be satified if the blessed - * tradition is either church or shamanistic. + * The blessed tradition prerequisite may only be satified if the blessed tradition is either church or shamanistic. */ -export type BlessedTraditionPrerequisiteRestriction = - | "Church" - | "Shamanistic" +export type BlessedTraditionPrerequisiteRestriction = "Church" | "Shamanistic" /** * @title Magical Tradition Prerequisite */ export type MagicalTraditionPrerequisite = { /** - * The magical tradition prerequisite may only be satified if the magical - * tradition can learn rituals or can bind familiars. + * The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. */ restriction?: MagicalTraditionPrerequisiteRestriction @@ -35,9 +30,6 @@ export type MagicalTraditionPrerequisite = { } /** - * The magical tradition prerequisite may only be satified if the magical - * tradition can learn rituals or can bind familiars. + * The magical tradition prerequisite may only be satified if the magical tradition can learn rituals or can bind familiars. */ -export type MagicalTraditionPrerequisiteRestriction = - | "CanLearnRituals" - | "CanBindFamiliars" +export type MagicalTraditionPrerequisiteRestriction = "CanLearnRituals" | "CanBindFamiliars" diff --git a/src/types/rule/CoreRule.ts b/src/types/rule/CoreRule.ts index b5c2f112..155b5df2 100644 --- a/src/types/rule/CoreRule.ts +++ b/src/types/rule/CoreRule.ts @@ -53,9 +53,7 @@ export type ContentNode = | { tag: "ReferenceList"; reference_list: ReferenceListNode } /** - * A core rule nested inside this core rule. It may be displayed as a separate - * page or its content may be included in this rule's text, which will - * automatically generate a proper heading. No content node of a type other than + * A core rule nested inside this core rule. It may be displayed as a separate page or its content may be included in this rule's text, which will automatically generate a proper heading. No content node of a type other than * `Child` should follow a child node, since then it may look like the the text * may be part of the child node. */ @@ -66,16 +64,13 @@ export type ChildNode = { id: CoreRuleIdentifier /** - * If the nested core rule's content should be integrated into this core rule - * and a proper heading should be added. Otherwise create a link to a separate - * view of that core rule. + * If the nested core rule's content should be integrated into this core rule and a proper heading should be added. Otherwise create a link to a separate view of that core rule. */ include: boolean } /** - * A simple text block, containing one or multiple paragraphs. Headings are not - * allowed, they should be handled as nested core rules instead. + * A simple text block, containing one or multiple paragraphs. Headings are not allowed, they should be handled as nested core rules instead. */ export type TextNode = { /** @@ -167,30 +162,21 @@ export type ReferenceListNodeSource = export type ReferenceListNodeImprovementCostSource = { /** - * Define if the cost for attributes or skills should be defined. The - * cost for attributes start with value 9, while the cost for skills - * start with 1 in addition to possible activation cost. + * Define if the cost for attributes or skills should be defined. The cost for attributes start with value 9, while the cost for skills start with 1 in addition to possible activation cost. */ target: ReferenceListNodeImprovementCostSourceTarget /** * The highest value the improvement cost are displayed for. * - * The minimum maximum value should depend on what is the upper bound of - * the range of adventure point cost that are equal across multiple - * values (value increases for attributes are always 15 up to (and - * including) value 14, while value increases for skills are always 1 to - * 4, depending on the improvement cost, up to (and including) value - * 12), since those ranges should be combined into a single table row. + * The minimum maximum value should depend on what is the upper bound of the range of adventure point cost that are equal across multiple values (value increases for attributes are always 15 up to (and including) value 14, while value increases for skills are always 1 to 4, depending on the improvement cost, up to (and including) value 12), since those ranges should be combined into a single table row. * @integer * @minimum 12 */ maximum_rating: number } -export type ReferenceListNodeImprovementCostSourceTarget = - | "Attributes" - | "Skills" +export type ReferenceListNodeImprovementCostSourceTarget = "Attributes" | "Skills" export type ReferenceListNodeTranslation = { /** diff --git a/src/types/rule/FocusRule.ts b/src/types/rule/FocusRule.ts index 3bf509ac..2ab4574f 100644 --- a/src/types/rule/FocusRule.ts +++ b/src/types/rule/FocusRule.ts @@ -38,8 +38,7 @@ export type FocusRule = { level: number /** - * Has the focus rule not been implemented in Optolith yet? This is also true - * if the focus rule does not (currently) apply to any Optolith feature. + * Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. */ is_missing_implementation: boolean diff --git a/src/types/rule/OptionalRule.ts b/src/types/rule/OptionalRule.ts index 9340fafb..db7eaeb5 100644 --- a/src/types/rule/OptionalRule.ts +++ b/src/types/rule/OptionalRule.ts @@ -24,8 +24,7 @@ export type OptionalRule = { id: number /** - * Has the focus rule not been implemented in Optolith yet? This is also true - * if the focus rule does not (currently) apply to any Optolith feature. + * Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature. */ is_missing_implementation: boolean diff --git a/src/types/source/Publication.ts b/src/types/source/Publication.ts index 05b9087a..3b5e4792 100644 --- a/src/types/source/Publication.ts +++ b/src/types/source/Publication.ts @@ -33,8 +33,7 @@ export type Publication = { contains_adult_content: boolean /** - * If the publication is not (fully) implemented and thus needs to be excluded - * from * stable releases. + * If the publication is not (fully) implemented and thus needs to be excluded from * stable releases. */ is_missing_implementation: boolean @@ -74,8 +73,7 @@ export type PublicationTranslation = { release_date?: string /** - * If this publication translation is not (fully) implemented and thus needs - * to be excluded from stable releases. + * If this publication translation is not (fully) implemented and thus needs to be excluded from stable releases. */ is_missing_implementation: boolean } @@ -83,11 +81,7 @@ export type PublicationTranslation = { /** * The publication category. */ -export type Category = - | "CoreRules" - | "ExpansionRules" - | "Sourcebook" - | "RegionalSourcebook" +export type Category = "CoreRules" | "ExpansionRules" | "Sourcebook" | "RegionalSourcebook" export const config: TypeConfig = { name: "Publication", diff --git a/src/types/source/_PublicationRef.ts b/src/types/source/_PublicationRef.ts index aa7d6989..fd505edd 100644 --- a/src/types/source/_PublicationRef.ts +++ b/src/types/source/_PublicationRef.ts @@ -12,12 +12,10 @@ import { LocaleMap } from "../_LocaleMap.js" */ export type PublicationRefs = PublicationRef[] - /** - * A source reference. It contains the book's publisher identifier and the page - * where it occurs. If an entry spans multiple pages, provide the last page as - * well. - * @title Publication Reference - */ +/** + * A source reference. It contains the book's publisher identifier and the page where it occurs. If an entry spans multiple pages, provide the last page as well. + * @title Publication Reference + */ export type PublicationRef = { /** * The publication's identifier. @@ -43,16 +41,14 @@ export type SimpleOccurrences = SimpleOccurrence[] */ export type SimpleOccurrence = { /** - * The page where it occurs. If the entry spans multiple pages, use this as - * the first page and `last_page` as the last page. + * The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. * @integer * @minimum 1 */ first_page: number /** - * The last page where it occurs. If there is only one page, set this to the - * same as `first_page` oder remove it. + * The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. * @integer * @minimum 2 */ @@ -69,8 +65,7 @@ export type VersionedOccurrence = { initial: InitialOccurrence /** - * Revisions of the entry, resulting in either changed page references or - * re-addition or removal of an entry. + * Revisions of the entry, resulting in either changed page references or re-addition or removal of an entry. * @minItems 1 */ revisions?: Revision[] @@ -81,8 +76,7 @@ export type VersionedOccurrence = { */ export type InitialOccurrence = { /** - * The publication's printing since which the entry is present. Leave - * empty if present since the beginning. + * The publication's printing since which the entry is present. Leave empty if present since the beginning. * @integer * @minimum 2 */ @@ -96,8 +90,7 @@ export type InitialOccurrence = { } /** - * A revision of the entry, resulting in either changed page references or - * re-addition or removal of an entry. + * A revision of the entry, resulting in either changed page references or re-addition or removal of an entry. * @title Revision */ export type Revision = @@ -106,12 +99,11 @@ export type Revision = export type Since = { /** - * The publication's printing since which the entry is present again or has - * changed page references. + * The publication's printing since which the entry is present again or has changed page references. * @integer * @minimum 2 */ - printing: number; + printing: number /** * The changed or new page references. @@ -126,7 +118,7 @@ export type Deprecation = { * @integer * @minimum 2 */ - printing: number; + printing: number } /** @@ -134,14 +126,12 @@ export type Deprecation = { */ export type PageRange = { /** - * The page where it occurs. If the entry spans multiple pages, use this as - * the first page and `last_page` as the last page. + * The page where it occurs. If the entry spans multiple pages, use this as the first page and `last_page` as the last page. */ first_page: Page /** - * The last page where it occurs. If there is only one page, set this to the - * same as `first_page` oder remove it. + * The last page where it occurs. If there is only one page, set this to the same as `first_page` oder remove it. */ last_page?: Page } diff --git a/src/types/specialAbility/AdvancedCombatSpecialAbility.ts b/src/types/specialAbility/AdvancedCombatSpecialAbility.ts index 159c1e6e..87e76a57 100644 --- a/src/types/specialAbility/AdvancedCombatSpecialAbility.ts +++ b/src/types/specialAbility/AdvancedCombatSpecialAbility.ts @@ -62,22 +62,23 @@ export type AdvancedCombatSpecialAbilityTranslation = { penalty?: string /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement /** - * A string that gets appended to the default AP Value text with a preceding - * space. This always happens if present, even if the generated AP Value text - * is replaced. + * A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. */ ap_value_append?: Activatable.AdventurePointsValueAppend errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + AdvancedCombatSpecialAbility, + AdvancedCombatSpecialAbility["id"], + "AdvancedCombatSpecialAbility" +> = { name: "AdvancedCombatSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("AdvancedCombatSpecialAbility"), diff --git a/src/types/specialAbility/BlessedTradition.ts b/src/types/specialAbility/BlessedTradition.ts index 4bf967d4..7262fd9f 100644 --- a/src/types/specialAbility/BlessedTradition.ts +++ b/src/types/specialAbility/BlessedTradition.ts @@ -34,8 +34,7 @@ export type BlessedTradition = { skill_uses?: Activatable.SkillUses /** - * The tradition's primary attribute. Leave empty if the tradition does not - * have one. + * The tradition's primary attribute. Leave empty if the tradition does not have one. */ primary?: AttributeReference @@ -64,8 +63,7 @@ export type BlessedTradition = { favored_skills: SkillReference[] /** - * On activation of the tradition, a specific number of skills from a list of - * skills must be selected as being favored. + * On activation of the tradition, a specific number of skills from a list of skills must be selected as being favored. */ favored_skills_selection?: FavoredSkillsSelection @@ -75,8 +73,7 @@ export type BlessedTradition = { type: BlessedTraditionType /** - * The select option's identifier of the disadvantage *Principles* that - * represent this tradition's code, if any. + * The select option's identifier of the disadvantage *Principles* that represent this tradition's code, if any. */ associated_principles_id?: number @@ -163,8 +160,7 @@ export type BlessedTraditionTranslation = { name: Activatable.Name /** - * A shorter name of the tradition's name, used in liturgical chant - * descriptions. + * A shorter name of the tradition's name, used in liturgical chant descriptions. * @minLength 1 */ name_compressed?: string @@ -174,8 +170,7 @@ export type BlessedTraditionTranslation = { // input?: Activatable.Input /** - * The special rules of the tradition. They should be sorted like they are - * in the book. + * The special rules of the tradition. They should be sorted like they are in the book. * @minItems 1 */ special_rules: SpecialRule[] diff --git a/src/types/specialAbility/CeremonialItemSpecialAbility.ts b/src/types/specialAbility/CeremonialItemSpecialAbility.ts index 485f2673..dbff643c 100644 --- a/src/types/specialAbility/CeremonialItemSpecialAbility.ts +++ b/src/types/specialAbility/CeremonialItemSpecialAbility.ts @@ -53,8 +53,7 @@ export type CeremonialItemSpecialAbilityTranslation = { effect: Activatable.Effect /** - * The prerequisites text. It is only used if the text cannot be generated - * from the given information. + * The prerequisites text. It is only used if the text cannot be generated from the given information. */ prerequisites?: Activatable.PrerequisitesReplacement diff --git a/src/types/specialAbility/FatePointSpecialAbility.ts b/src/types/specialAbility/FatePointSpecialAbility.ts index 1e71950d..58cc8455 100644 --- a/src/types/specialAbility/FatePointSpecialAbility.ts +++ b/src/types/specialAbility/FatePointSpecialAbility.ts @@ -51,15 +51,18 @@ export type FatePointSpecialAbilityTranslation = { rules: Activatable.Rules /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + FatePointSpecialAbility, + FatePointSpecialAbility["id"], + "FatePointSpecialAbility" +> = { name: "FatePointSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("FatePointSpecialAbility"), diff --git a/src/types/specialAbility/GeneralSpecialAbility.ts b/src/types/specialAbility/GeneralSpecialAbility.ts index 15abd772..8dee43cd 100644 --- a/src/types/specialAbility/GeneralSpecialAbility.ts +++ b/src/types/specialAbility/GeneralSpecialAbility.ts @@ -54,16 +54,18 @@ export type GeneralSpecialAbilityTranslation = { rules: Activatable.Rules /** - * A string that gets appended to the default AP Value text with a preceding - * space. This always happens if present, even if the generated AP Value text - * is replaced. + * A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced. */ ap_value_append?: Activatable.AdventurePointsValueAppend errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + GeneralSpecialAbility, + GeneralSpecialAbility["id"], + "GeneralSpecialAbility" +> = { name: "GeneralSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("GeneralSpecialAbility"), diff --git a/src/types/specialAbility/KarmaSpecialAbility.ts b/src/types/specialAbility/KarmaSpecialAbility.ts index 016786c4..0da5d16b 100644 --- a/src/types/specialAbility/KarmaSpecialAbility.ts +++ b/src/types/specialAbility/KarmaSpecialAbility.ts @@ -47,15 +47,18 @@ export type KarmaSpecialAbilityTranslation = { rules: Activatable.Rules /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + KarmaSpecialAbility, + KarmaSpecialAbility["id"], + "KarmaSpecialAbility" +> = { name: "KarmaSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("KarmaSpecialAbility"), diff --git a/src/types/specialAbility/MagicalSpecialAbility.ts b/src/types/specialAbility/MagicalSpecialAbility.ts index d378ae50..eb3205d0 100644 --- a/src/types/specialAbility/MagicalSpecialAbility.ts +++ b/src/types/specialAbility/MagicalSpecialAbility.ts @@ -54,15 +54,18 @@ export type MagicalSpecialAbilityTranslation = { rules: Activatable.Rules /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + MagicalSpecialAbility, + MagicalSpecialAbility["id"], + "MagicalSpecialAbility" +> = { name: "MagicalSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("MagicalSpecialAbility"), diff --git a/src/types/specialAbility/MagicalTradition.ts b/src/types/specialAbility/MagicalTradition.ts index 799c8ef1..160085f3 100644 --- a/src/types/specialAbility/MagicalTradition.ts +++ b/src/types/specialAbility/MagicalTradition.ts @@ -32,8 +32,7 @@ export type MagicalTradition = { skill_uses?: Activatable.SkillUses /** - * The tradition's primary attribute. Leave empty if the tradition does not - * have one. + * The tradition's primary attribute. Leave empty if the tradition does not have one. */ primary?: PrimaryAttribute @@ -58,14 +57,12 @@ export type MagicalTradition = { can_bind_familiars: boolean /** - * Does the tradition allow learning more traditions or having learned a - * different tradition before learning this tradition? + * Does the tradition allow learning more traditions or having learned a different tradition before learning this tradition? */ allows_multiple_traditions: boolean /** - * Is the maximum AP you're able to spent on magical advantages and able to - * get by magical disadvantages different than the default of 50 AP? + * Is the maximum AP you're able to spent on magical advantages and able to get by magical disadvantages different than the default of 50 AP? * @integer * @minimum 25 * @maximum 30 @@ -74,8 +71,7 @@ export type MagicalTradition = { alternative_magical_adventure_points_maximum?: number /** - * Are advantages/disadvantages required to not exclusively apply to arcane - * spellworks, but also to the tradition's magical actions or applications? + * Are advantages/disadvantages required to not exclusively apply to arcane spellworks, but also to the tradition's magical actions or applications? */ require_non_spellwork_exclusive_effects: boolean @@ -85,8 +81,7 @@ export type MagicalTradition = { is_magical_dilettante: boolean /** - * If arcane spellworks from a different tradition count as arcane spellworks - * of this tradition, this is the different tradition's reference. + * If arcane spellworks from a different tradition count as arcane spellworks of this tradition, this is the different tradition's reference. */ use_arcane_spellworks_from_tradition?: MagicalTraditionReference @@ -115,9 +110,7 @@ export type PrimaryAttribute = { id: AttributeIdentifier /** - * Typically, the value of the primary attribute (if one exists) is added - * onto the base of 20 AE to get the actual AE. But sometimes, only half the - * value is added. + * Typically, the value of the primary attribute (if one exists) is added onto the base of 20 AE to get the actual AE. But sometimes, only half the value is added. */ use_half_for_arcane_energy: boolean } @@ -126,8 +119,7 @@ export type MagicalTraditionTranslation = { name: Activatable.Name /** - * The name used for the traditions list of arcane spellworks if it is - * different than the `name` of the special ability. + * The name used for the traditions list of arcane spellworks if it is different than the `name` of the special ability. * @minLength 1 */ name_for_arcane_spellworks?: string @@ -137,8 +129,7 @@ export type MagicalTraditionTranslation = { // input?: Activatable.Input /** - * The special rules of the tradition. They should be sorted like they are - * in the book. + * The special rules of the tradition. They should be sorted like they are in the book. * @minItems 1 */ special_rules: SpecialRule[] diff --git a/src/types/specialAbility/PactGift.ts b/src/types/specialAbility/PactGift.ts index 502c5bfb..cb5a799f 100644 --- a/src/types/specialAbility/PactGift.ts +++ b/src/types/specialAbility/PactGift.ts @@ -29,8 +29,7 @@ export type PactGift = { permanent_demonic_consumption?: PactGiftPermanentDemonicConsumption /** - * This pact gift has direct influence on the existence of other entries. It - * may add or remove entries. + * This pact gift has direct influence on the existence of other entries. It may add or remove entries. * @minItems 1 */ automatic_entries?: AutomaticEntry[] @@ -63,8 +62,7 @@ export type FixedPactGiftPermanentDemonicConsumption = { export type PactGiftPermanentDemonicConsumptionPerLevel = { /** - * The levels of *Demonic Consumption* the pact gift causes per activated - * level of the pact gift. + * The levels of *Demonic Consumption* the pact gift causes per activated level of the pact gift. * @integer * @minimum 1 * @maximum 4 @@ -79,21 +77,17 @@ export type AutomaticEntry = { action: AutomaticEntryAction /** - * If an entry is added or removed, does is cost or grant adventure points - * or is it free of charge? + * If an entry is added or removed, does is cost or grant adventure points or is it free of charge? */ apply_ap_value: boolean /** - * The entry that is to be added or removed. It can be a fixed entry or a - * selection where the player must choose one entry. + * The entry that is to be added or removed. It can be a fixed entry or a selection where the player must choose one entry. */ target: AutomaticEntryTarget } -export type AutomaticEntryAction = - | "Add" - | "Remove" +export type AutomaticEntryAction = "Add" | "Remove" export type AutomaticEntryTarget = | { tag: "Selection"; selection: AutomaticEntryTargetSelection } @@ -103,9 +97,7 @@ export type AutomaticEntryTargetSelection = { list: AutomaticEntryTargetSelectionList } -export type AutomaticEntryTargetSelectionList = - | "MagicalTraditions" - | "MagicalDilettanteTraditions" +export type AutomaticEntryTargetSelectionList = "MagicalTraditions" | "MagicalDilettanteTraditions" export type FixedAutomaticEntryTarget = { id: ActivatableIdentifier diff --git a/src/types/specialAbility/SikaryanDrainSpecialAbility.ts b/src/types/specialAbility/SikaryanDrainSpecialAbility.ts index dc6cf62d..b84064bc 100644 --- a/src/types/specialAbility/SikaryanDrainSpecialAbility.ts +++ b/src/types/specialAbility/SikaryanDrainSpecialAbility.ts @@ -47,15 +47,18 @@ export type SikaryanDrainSpecialAbilityTranslation = { rules: Activatable.Rules /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement errata?: Errata } -export const config: TypeConfig = { +export const config: TypeConfig< + SikaryanDrainSpecialAbility, + SikaryanDrainSpecialAbility["id"], + "SikaryanDrainSpecialAbility" +> = { name: "SikaryanDrainSpecialAbility", id: getFilenamePrefixAsNumericId, integrityValidator: todo("SikaryanDrainSpecialAbility"), diff --git a/src/types/specialAbility/VampiricGift.ts b/src/types/specialAbility/VampiricGift.ts index d1664600..3681a51c 100644 --- a/src/types/specialAbility/VampiricGift.ts +++ b/src/types/specialAbility/VampiricGift.ts @@ -47,8 +47,7 @@ export type VampiricGiftTranslation = { rules: Activatable.Rules /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement diff --git a/src/types/specialAbility/_Tradition.ts b/src/types/specialAbility/_Tradition.ts index 940d38fc..be323475 100644 --- a/src/types/specialAbility/_Tradition.ts +++ b/src/types/specialAbility/_Tradition.ts @@ -2,8 +2,7 @@ import { NonEmptyString } from "../_NonEmptyString.js" export type SpecialRule = { /** - * An optional label that is displayed and placed before the actual - * text. + * An optional label that is displayed and placed before the actual text. */ label?: NonEmptyString diff --git a/src/types/specialAbility/sub/Language.ts b/src/types/specialAbility/sub/Language.ts index 43dd6be5..17766fed 100644 --- a/src/types/specialAbility/sub/Language.ts +++ b/src/types/specialAbility/sub/Language.ts @@ -33,16 +33,14 @@ export type Language = { continent: AssociatedContinent[] /** - * Language-specific specializations. Either a list of possible options or a - * indefinite description of what may be a specialization. + * Language-specific specializations. Either a list of possible options or a indefinite description of what may be a specialization. */ specializations?: Specializations prerequisites?: LanguagePrerequisites /** - * The maximum possible level of the language. Only specified if lower than - * default of 3. + * The maximum possible level of the language. Only specified if lower than default of 3. * @minimum 1 * @maximum 2 * @default 3 @@ -90,8 +88,7 @@ export type SpecificSpecializationTranslation = { name: NonEmptyString /** - * The specialization description. It will be appended to the name in - * parenthesis. + * The specialization description. It will be appended to the name in parenthesis. */ description?: NonEmptyString } @@ -110,8 +107,7 @@ export type IndefiniteSpecializationsTranslation = { description: NonEmptyString /** - * An input label or placeholder text for an UI element if it differs - * from the `description`. + * An input label or placeholder text for an UI element if it differs from the `description`. */ label?: NonEmptyString } diff --git a/src/types/traditionArtifacts/CauldronEnchantment.ts b/src/types/traditionArtifacts/CauldronEnchantment.ts index cc4de97c..e4be8d63 100644 --- a/src/types/traditionArtifacts/CauldronEnchantment.ts +++ b/src/types/traditionArtifacts/CauldronEnchantment.ts @@ -30,8 +30,7 @@ export type CauldronEnchantment = { volume: Activatable.Volume /** - * Witches can learn to brew special things in their Witch's Cauldron. These - * brews can be categorized in different types. + * Witches can learn to brew special things in their Witch's Cauldron. These brews can be categorized in different types. */ brew: BrewReference diff --git a/src/types/traditionArtifacts/SpellSwordEnchantment.ts b/src/types/traditionArtifacts/SpellSwordEnchantment.ts index 973eaa00..6bb794c5 100644 --- a/src/types/traditionArtifacts/SpellSwordEnchantment.ts +++ b/src/types/traditionArtifacts/SpellSwordEnchantment.ts @@ -66,8 +66,7 @@ export type SpellSwordEnchantmentTranslation = { bindingCost?: string /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement diff --git a/src/types/traditionArtifacts/StaffEnchantment.ts b/src/types/traditionArtifacts/StaffEnchantment.ts index 78835c9b..9a46b468 100644 --- a/src/types/traditionArtifacts/StaffEnchantment.ts +++ b/src/types/traditionArtifacts/StaffEnchantment.ts @@ -80,8 +80,7 @@ export type StaffEnchantmentTranslation = { bindingCost?: string /** - * The AP value. It is only used if the text cannot be generated from the - * given information. + * The AP value. It is only used if the text cannot be generated from the given information. */ ap_value?: Activatable.AdventurePointsValueReplacement