optolith/database-schema
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: delete old generated artifacts

Browse Source
This commit is contained in:
Lukas Obermann
2026-03-20 15:52:34 +01:00
parent 30db26fc6b
commit fb9c15c762
430 changed files with 0 additions and 90052 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/Advantage.md
-134
View File
@@ -1,134 +0,0 @@
# Advantage
## Definitions
### <a name="Advantage"></a> Advantage (`Advantage`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#Advantage/id">See details</a>
`levels?` | | <a href="#Advantage/levels">See details</a>
`select_options?` | | <a href="#Advantage/select_options">See details</a>
`skill_applications?` | | <a href="#Advantage/skill_applications">See details</a>
`skill_uses?` | | <a href="#Advantage/skill_uses">See details</a>
`maximum?` | | <a href="#Advantage/maximum">See details</a>
`prerequisites?` | | <a href="#Advantage/prerequisites">See details</a>
`ap_value` | | <a href="#Advantage/ap_value">See details</a>
`has_maximum_spent_influence` | Does this advantage count towards the maximum of AP to be spent on advantages? | <a href="#Advantage/has_maximum_spent_influence">See details</a>
`is_exclusive_to_arcane_spellworks` | Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications? | <a href="#Advantage/is_exclusive_to_arcane_spellworks">See details</a>
`src` | | <a href="#Advantage/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Advantage/translations">See details</a>
#### <a name="Advantage/id"></a> `id`
- **Type:** <a href="#Id">Id</a>
#### <a name="Advantage/levels"></a> `levels?`
- **Type:** <a href="#Levels">Levels</a>
#### <a name="Advantage/select_options"></a> `select_options?`
- **Type:** <a href="#SelectOptions">SelectOptions</a>
#### <a name="Advantage/skill_applications"></a> `skill_applications?`
- **Type:** <a href="#SkillApplications">SkillApplications</a>
#### <a name="Advantage/skill_uses"></a> `skill_uses?`
- **Type:** <a href="#SkillUses">SkillUses</a>
#### <a name="Advantage/maximum"></a> `maximum?`
- **Type:** <a href="#Maximum">Maximum</a>
#### <a name="Advantage/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#AdvantageDisadvantagePrerequisites">AdvantageDisadvantagePrerequisites</a>
#### <a name="Advantage/ap_value"></a> `ap_value`
- **Type:** <a href="#AdventurePointsValue">AdventurePointsValue</a>
#### <a name="Advantage/has_maximum_spent_influence"></a> `has_maximum_spent_influence`
Does this advantage count towards the maximum of AP to be spent on advantages?
- **Type:** Boolean
- **Default:** `true`
#### <a name="Advantage/is_exclusive_to_arcane_spellworks"></a> `is_exclusive_to_arcane_spellworks`
Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications?
- **Type:** Boolean
- **Default:** `false`
#### <a name="Advantage/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Advantage/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#AdvantageTranslation">AdvantageTranslation</a>&gt;
---
### <a name="AdvantageTranslation"></a> `AdvantageTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | | <a href="#AdvantageTranslation/name">See details</a>
`name_in_library?` | | <a href="#AdvantageTranslation/name_in_library">See details</a>
`input?` | A string that is used as a label for an input field. | <a href="#AdvantageTranslation/input">See details</a>
`rules` | | <a href="#AdvantageTranslation/rules">See details</a>
`range?` | The range. | <a href="#AdvantageTranslation/range">See details</a>
`ap_value?` | | <a href="#AdvantageTranslation/ap_value">See details</a>
`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 href="#AdvantageTranslation/ap_value_append">See details</a>
`errata?` | | <a href="#AdvantageTranslation/errata">See details</a>
#### <a name="AdvantageTranslation/name"></a> `name`
- **Type:** <a href="#Name">Name</a>
#### <a name="AdvantageTranslation/name_in_library"></a> `name_in_library?`
- **Type:** <a href="#NameInLibrary">NameInLibrary</a>
#### <a name="AdvantageTranslation/input"></a> `input?`
A string that is used as a label for an input field.
- **Type:** <a href="#Input">Input</a>
#### <a name="AdvantageTranslation/rules"></a> `rules`
- **Type:** <a href="#Rules">Rules</a>
#### <a name="AdvantageTranslation/range"></a> `range?`
The range.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="AdvantageTranslation/ap_value"></a> `ap_value?`
- **Type:** <a href="#AdventurePointsValueReplacement">AdventurePointsValueReplacement</a>
#### <a name="AdvantageTranslation/ap_value_append"></a> `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.
- **Type:** <a href="#AdventurePointsValueAppend">AdventurePointsValueAppend</a>
#### <a name="AdvantageTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/AnimalDisease.md
-92
View File
@@ -1,92 +0,0 @@
# Animal Disease
## Definitions
### <a name="AnimalDisease"></a> Animal Disease (`AnimalDisease`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The animal disease's identifier. An unique, increasing integer. | <a href="#AnimalDisease/id">See details</a>
`level` | The animal disease's level. | <a href="#AnimalDisease/level">See details</a>
`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. | <a href="#AnimalDisease/resistance">See details</a>
`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. | <a href="#AnimalDisease/cause">See details</a>
`animal_types` | The animal types this disease applies to. | <a href="#AnimalDisease/animal_types">See details</a>
`communicability_to_intelligent_creatures` | If and at which chance the disease can be communicated to intelligent creatures. | <a href="#AnimalDisease/communicability_to_intelligent_creatures">See details</a>
`src` | | <a href="#AnimalDisease/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#AnimalDisease/translations">See details</a>
#### <a name="AnimalDisease/id"></a> `id`
The animal disease's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="AnimalDisease/level"></a> `level`
The animal disease's level.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="AnimalDisease/resistance"></a> `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.
- **Type:** <a href="./_DiseasePoison.md#Resistance">Resistance</a>
#### <a name="AnimalDisease/cause"></a> `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.
- **Type:** List
- **Items:** <a href="#AnimalDisease/cause[]">AnimalDisease/cause[]</a>
- **Minimum Items:** `1`
#### <a name="AnimalDisease/animal_types"></a> `animal_types`
The animal types this disease applies to.
If no animal types are given, the animal disease applies to all animal types.
- **Type:** List
- **Items:** <a href="#AnimalDisease/animal_types[]">AnimalDisease/animal_types[]</a>
#### <a name="AnimalDisease/communicability_to_intelligent_creatures"></a> `communicability_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.
- **Type:** List
- **Items:** <a href="#AnimalDisease/communicability_to_intelligent_creatures[]">AnimalDisease/communicability_to_intelligent_creatures[]</a>
#### <a name="AnimalDisease/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="AnimalDisease/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_DiseasePoison.md#DiseaseTranslation">DiseaseTranslation</a>&gt;
---
### <a name="AnimalDisease/cause[]"></a> `AnimalDisease/cause[]`
- **Type:** <a href="./_DiseasePoison.md#Cause">Cause</a>
---
### <a name="AnimalDisease/animal_types[]"></a> `AnimalDisease/animal_types[]`
- **Type:** <a href="./_SimpleReferences.md#AnimalTypeReference">AnimalTypeReference</a>
---
### <a name="AnimalDisease/communicability_to_intelligent_creatures[]"></a> `AnimalDisease/communicability_to_intelligent_creatures[]`
- **Type:** <a href="./_DiseasePoison.md#Cause">Cause</a>
docs/reference/AnimalType.md
-41
View File
@@ -1,41 +0,0 @@
# Animal Type
## Definitions
### <a name="AnimalType"></a> Animal Type (`AnimalType`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The animal type's identifier. An unique, increasing integer. | <a href="#AnimalType/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#AnimalType/translations">See details</a>
#### <a name="AnimalType/id"></a> `id`
The animal type's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="AnimalType/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#AnimalTypeTranslation">AnimalTypeTranslation</a>&gt;
---
### <a name="AnimalTypeTranslation"></a> `AnimalTypeTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The animal type name. | <a href="#AnimalTypeTranslation/name">See details</a>
#### <a name="AnimalTypeTranslation/name"></a> `name`
The animal type name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/ArcaneBardTradition.md
-7
View File
@@ -1,7 +0,0 @@
# Arcane Bard Tradition
## Definitions
### <a name="ArcaneBardTradition"></a> Arcane Bard Tradition (`ArcaneBardTradition`)
- **Type:** <a href="./_ArcaneTradition.md#ArcaneTradition">ArcaneTradition</a>
docs/reference/ArcaneDancerTradition.md
-7
View File
@@ -1,7 +0,0 @@
# Arcane Dancer Tradition
## Definitions
### <a name="ArcaneDancerTradition"></a> Arcane Dancer Tradition (`ArcaneDancerTradition`)
- **Type:** <a href="./_ArcaneTradition.md#ArcaneTradition">ArcaneTradition</a>
docs/reference/Aspect.md
-48
View File
@@ -1,48 +0,0 @@
# Aspect
## Definitions
### <a name="Aspect"></a> Aspect (`Aspect`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The aspect's identifier. An unique, increasing integer. | <a href="#Aspect/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Aspect/translations">See details</a>
#### <a name="Aspect/id"></a> `id`
The aspect's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Aspect/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#AspectTranslation">AspectTranslation</a>&gt;
---
### <a name="AspectTranslation"></a> `AspectTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The aspect name. | <a href="#AspectTranslation/name">See details</a>
`master_of_aspect_suffix?` | The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*. | <a href="#AspectTranslation/master_of_aspect_suffix">See details</a>
#### <a name="AspectTranslation/name"></a> `name`
The aspect name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AspectTranslation/master_of_aspect_suffix"></a> `master_of_aspect_suffix?`
The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Attribute.md
-55
View File
@@ -1,55 +0,0 @@
# Attribute
## Definitions
### <a name="Attribute"></a> Attribute (`Attribute`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The attribute's identifier. An unique, increasing integer. | <a href="#Attribute/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Attribute/translations">See details</a>
#### <a name="Attribute/id"></a> `id`
The attribute's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Attribute/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#AttributeTranslation">AttributeTranslation</a>&gt;
---
### <a name="AttributeTranslation"></a> `AttributeTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The attribute's name. | <a href="#AttributeTranslation/name">See details</a>
`abbreviation` | The abbreviation of the attribute's name. | <a href="#AttributeTranslation/abbreviation">See details</a>
`description` | The description of the attribute. | <a href="#AttributeTranslation/description">See details</a>
#### <a name="AttributeTranslation/name"></a> `name`
The attribute's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AttributeTranslation/abbreviation"></a> `abbreviation`
The abbreviation of the attribute's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AttributeTranslation/description"></a> `description`
The description of the attribute.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Blessing.md
-312
View File
@@ -1,312 +0,0 @@
# Blessing
## Definitions
### <a name="Blessing"></a> Blessing (`Blessing`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The blessing's identifier. An unique, increasing integer. | <a href="#Blessing/id">See details</a>
`parameters` | Measurable parameters of a blessing. | <a href="#Blessing/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#Blessing/target">See details</a>
`src` | | <a href="#Blessing/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Blessing/translations">See details</a>
#### <a name="Blessing/id"></a> `id`
The blessing's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Blessing/parameters"></a> `parameters`
Measurable parameters of a blessing.
- **Type:** <a href="#BlessingPerformanceParameters">BlessingPerformanceParameters</a>
#### <a name="Blessing/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="Blessing/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Blessing/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#BlessingTranslation">BlessingTranslation</a>&gt;
---
### <a name="BlessingTranslation"></a> `BlessingTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the blessing. | <a href="#BlessingTranslation/name">See details</a>
`effect` | The effect description. | <a href="#BlessingTranslation/effect">See details</a>
`range` | | <a href="#BlessingTranslation/range">See details</a>
`duration` | | <a href="#BlessingTranslation/duration">See details</a>
`target` | | <a href="#BlessingTranslation/target">See details</a>
`errata?` | | <a href="#BlessingTranslation/errata">See details</a>
#### <a name="BlessingTranslation/name"></a> `name`
The name of the blessing.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="BlessingTranslation/effect"></a> `effect`
The effect description.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="BlessingTranslation/range"></a> `range`
- **Type:** String
#### <a name="BlessingTranslation/duration"></a> `duration`
- **Type:** String
#### <a name="BlessingTranslation/target"></a> `target`
- **Type:** String
#### <a name="BlessingTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="BlessingPerformanceParameters"></a> `BlessingPerformanceParameters`
Measurable parameters of a blessing.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`range` | | <a href="#BlessingPerformanceParameters/range">See details</a>
`duration` | | <a href="#BlessingPerformanceParameters/duration">See details</a>
#### <a name="BlessingPerformanceParameters/range"></a> `range`
- **Type:** <a href="#BlessingRange">BlessingRange</a>
#### <a name="BlessingPerformanceParameters/duration"></a> `duration`
- **Type:** <a href="#BlessingDuration">BlessingDuration</a>
---
### <a name="BlessingRange"></a> `BlessingRange`
- **Type:** Union
- **Cases:** <a href="#BlessingRange'Self">BlessingRange'Self</a> | <a href="#BlessingRange'Touch">BlessingRange'Touch</a> | <a href="#BlessingRange'Fixed">BlessingRange'Fixed</a>
---
### <a name="BlessingRange'Self"></a> `BlessingRange'Self`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingRange'Self/tag">See details</a>
`self` | | <a href="#BlessingRange'Self/self">See details</a>
#### <a name="BlessingRange'Self/tag"></a> `tag`
- **Constant:** `"Self"`
#### <a name="BlessingRange'Self/self"></a> `self`
- **Type:** <a href="#BlessingRange'Self/self">Object</a>
---
### <a name="BlessingRange'Self/self"></a> `BlessingRange'Self/self`
- **Type:** Empty Object
---
### <a name="BlessingRange'Touch"></a> `BlessingRange'Touch`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingRange'Touch/tag">See details</a>
`touch` | | <a href="#BlessingRange'Touch/touch">See details</a>
#### <a name="BlessingRange'Touch/tag"></a> `tag`
- **Constant:** `"Touch"`
#### <a name="BlessingRange'Touch/touch"></a> `touch`
- **Type:** <a href="#BlessingRange'Touch/touch">Object</a>
---
### <a name="BlessingRange'Touch/touch"></a> `BlessingRange'Touch/touch`
- **Type:** Empty Object
---
### <a name="BlessingRange'Fixed"></a> `BlessingRange'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingRange'Fixed/tag">See details</a>
`fixed` | | <a href="#BlessingRange'Fixed/fixed">See details</a>
#### <a name="BlessingRange'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="BlessingRange'Fixed/fixed"></a> `fixed`
- **Type:** <a href="./_ActivatableSkillRange.md#FixedRange">FixedRange</a>
---
### <a name="BlessingDuration"></a> `BlessingDuration`
- **Type:** Union
- **Cases:** <a href="#BlessingDuration'Immediate">BlessingDuration'Immediate</a> | <a href="#BlessingDuration'Fixed">BlessingDuration'Fixed</a> | <a href="#BlessingDuration'Indefinite">BlessingDuration'Indefinite</a>
---
### <a name="BlessingDuration'Immediate"></a> `BlessingDuration'Immediate`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingDuration'Immediate/tag">See details</a>
`immediate` | | <a href="#BlessingDuration'Immediate/immediate">See details</a>
#### <a name="BlessingDuration'Immediate/tag"></a> `tag`
- **Constant:** `"Immediate"`
#### <a name="BlessingDuration'Immediate/immediate"></a> `immediate`
- **Type:** <a href="#BlessingDuration'Immediate/immediate">Object</a>
---
### <a name="BlessingDuration'Immediate/immediate"></a> `BlessingDuration'Immediate/immediate`
- **Type:** Empty Object
---
### <a name="BlessingDuration'Fixed"></a> `BlessingDuration'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingDuration'Fixed/tag">See details</a>
`fixed` | | <a href="#BlessingDuration'Fixed/fixed">See details</a>
#### <a name="BlessingDuration'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="BlessingDuration'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FixedBlessingDuration">FixedBlessingDuration</a>
---
### <a name="BlessingDuration'Indefinite"></a> `BlessingDuration'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessingDuration'Indefinite/tag">See details</a>
`indefinite` | | <a href="#BlessingDuration'Indefinite/indefinite">See details</a>
#### <a name="BlessingDuration'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="BlessingDuration'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#IndefiniteBlessingDuration">IndefiniteBlessingDuration</a>
---
### <a name="FixedBlessingDuration"></a> `FixedBlessingDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) duration. | <a href="#FixedBlessingDuration/value">See details</a>
`unit` | The duration unit. | <a href="#FixedBlessingDuration/unit">See details</a>
#### <a name="FixedBlessingDuration/value"></a> `value`
The (unitless) duration.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FixedBlessingDuration/unit"></a> `unit`
The duration unit.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnit">DurationUnit</a>
---
### <a name="IndefiniteBlessingDuration"></a> `IndefiniteBlessingDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IndefiniteBlessingDuration/translations">See details</a>
#### <a name="IndefiniteBlessingDuration/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#IndefiniteBlessingDurationTranslation">IndefiniteBlessingDurationTranslation</a>&gt;
---
### <a name="IndefiniteBlessingDurationTranslation"></a> `IndefiniteBlessingDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the duration. | <a href="#IndefiniteBlessingDurationTranslation/description">See details</a>
#### <a name="IndefiniteBlessingDurationTranslation/description"></a> `description`
A description of the duration.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
docs/reference/Cantrip.md
-537
View File
@@ -1,537 +0,0 @@
# Cantrip
## Definitions
### <a name="Cantrip"></a> Cantrip (`Cantrip`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The cantrip's identifier. An unique, increasing integer. | <a href="#Cantrip/id">See details</a>
`parameters` | Measurable parameters of a cantrip. | <a href="#Cantrip/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#Cantrip/target">See details</a>
`property` | The associated property. | <a href="#Cantrip/property">See details</a>
`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 href="#Cantrip/note">See details</a>
`src` | | <a href="#Cantrip/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Cantrip/translations">See details</a>
`enhancements?` | | <a href="#Cantrip/enhancements">See details</a>
#### <a name="Cantrip/id"></a> `id`
The cantrip's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Cantrip/parameters"></a> `parameters`
Measurable parameters of a cantrip.
- **Type:** <a href="#CantripPerformanceParameters">CantripPerformanceParameters</a>
#### <a name="Cantrip/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="Cantrip/property"></a> `property`
The associated property.
- **Type:** <a href="./_SimpleReferences.md#PropertyReference">PropertyReference</a>
#### <a name="Cantrip/note"></a> `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.
- **Type:** <a href="#CantripNote">CantripNote</a>
#### <a name="Cantrip/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Cantrip/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CantripTranslation">CantripTranslation</a>&gt;
#### <a name="Cantrip/enhancements"></a> `enhancements?`
- **Type:** <a href="./_Enhancements.md#Enhancements">Enhancements</a>
---
### <a name="CantripNote"></a> `CantripNote`
- **Type:** Union
- **Cases:** <a href="#CantripNote'Exclusive">CantripNote'Exclusive</a> | <a href="#CantripNote'Common">CantripNote'Common</a>
---
### <a name="CantripNote'Exclusive"></a> `CantripNote'Exclusive`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripNote'Exclusive/tag">See details</a>
`exclusive` | | <a href="#CantripNote'Exclusive/exclusive">See details</a>
#### <a name="CantripNote'Exclusive/tag"></a> `tag`
- **Constant:** `"Exclusive"`
#### <a name="CantripNote'Exclusive/exclusive"></a> `exclusive`
- **Type:** <a href="#ExclusiveCantripNote">ExclusiveCantripNote</a>
---
### <a name="CantripNote'Common"></a> `CantripNote'Common`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripNote'Common/tag">See details</a>
`common` | | <a href="#CantripNote'Common/common">See details</a>
#### <a name="CantripNote'Common/tag"></a> `tag`
- **Constant:** `"Common"`
#### <a name="CantripNote'Common/common"></a> `common`
- **Type:** <a href="#CommonCantripNotes">CommonCantripNotes</a>
---
### <a name="ExclusiveCantripNote"></a> `ExclusiveCantripNote`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`traditions` | The traditions the cantrip is exclusively available to. | <a href="#ExclusiveCantripNote/traditions">See details</a>
#### <a name="ExclusiveCantripNote/traditions"></a> `traditions`
The traditions the cantrip is exclusively available to.
- **Type:** List
- **Items:** <a href="#ExclusiveCantripNote/traditions[]">ExclusiveCantripNote/traditions[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
---
### <a name="ExclusiveCantripNote/traditions[]"></a> `ExclusiveCantripNote/traditions[]`
- **Type:** <a href="./_SimpleReferences.md#MagicalTraditionReference">MagicalTraditionReference</a>
---
### <a name="CommonCantripNotes"></a> `CommonCantripNotes`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`list` | The academies and traditions the cantrip is commonly teached in. | <a href="#CommonCantripNotes/list">See details</a>
#### <a name="CommonCantripNotes/list"></a> `list`
The academies and traditions the cantrip is commonly teached in.
- **Type:** List
- **Items:** <a href="#CommonCantripNotes/list[]">CommonCantripNotes/list[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
---
### <a name="CommonCantripNotes/list[]"></a> `CommonCantripNotes/list[]`
- **Type:** <a href="#CommonCantripNote">CommonCantripNote</a>
---
### <a name="CommonCantripNote"></a> `CommonCantripNote`
- **Type:** Union
- **Cases:** <a href="#CommonCantripNote'Academy">CommonCantripNote'Academy</a> | <a href="#CommonCantripNote'Tradition">CommonCantripNote'Tradition</a>
---
### <a name="CommonCantripNote'Academy"></a> `CommonCantripNote'Academy`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CommonCantripNote'Academy/tag">See details</a>
`academy` | | <a href="#CommonCantripNote'Academy/academy">See details</a>
#### <a name="CommonCantripNote'Academy/tag"></a> `tag`
- **Constant:** `"Academy"`
#### <a name="CommonCantripNote'Academy/academy"></a> `academy`
- **Type:** <a href="./_SimpleReferences.md#CurriculumReference">CurriculumReference</a>
---
### <a name="CommonCantripNote'Tradition"></a> `CommonCantripNote'Tradition`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CommonCantripNote'Tradition/tag">See details</a>
`tradition` | | <a href="#CommonCantripNote'Tradition/tradition">See details</a>
#### <a name="CommonCantripNote'Tradition/tag"></a> `tag`
- **Constant:** `"Tradition"`
#### <a name="CommonCantripNote'Tradition/tradition"></a> `tradition`
- **Type:** <a href="#CommonCantripTraditionNote">CommonCantripTraditionNote</a>
---
### <a name="CommonCantripTraditionNote"></a> `CommonCantripTraditionNote`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The magical tradition's identifier. | <a href="#CommonCantripTraditionNote/id">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CommonCantripTraditionNote/translations">See details</a>
#### <a name="CommonCantripTraditionNote/id"></a> `id`
The magical tradition's identifier.
- **Type:** <a href="./_Identifier.md#MagicalTraditionIdentifier">MagicalTraditionIdentifier</a>
#### <a name="CommonCantripTraditionNote/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CommonCantripTraditionNoteTranslation">CommonCantripTraditionNoteTranslation</a>&gt;
---
### <a name="CommonCantripTraditionNoteTranslation"></a> `CommonCantripTraditionNoteTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`note` | A note, appended to the generated string in parenthesis. | <a href="#CommonCantripTraditionNoteTranslation/note">See details</a>
#### <a name="CommonCantripTraditionNoteTranslation/note"></a> `note`
A note, appended to the generated string in parenthesis.
- **Type:** String
- **Minimum Length:** `1`
---
### <a name="CantripTranslation"></a> `CantripTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the spell. | <a href="#CantripTranslation/name">See details</a>
`effect` | The effect description. | <a href="#CantripTranslation/effect">See details</a>
`range` | | <a href="#CantripTranslation/range">See details</a>
`duration` | | <a href="#CantripTranslation/duration">See details</a>
`target` | | <a href="#CantripTranslation/target">See details</a>
`errata?` | | <a href="#CantripTranslation/errata">See details</a>
#### <a name="CantripTranslation/name"></a> `name`
The name of the spell.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CantripTranslation/effect"></a> `effect`
The effect description.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="CantripTranslation/range"></a> `range`
- **Type:** String
#### <a name="CantripTranslation/duration"></a> `duration`
- **Type:** String
#### <a name="CantripTranslation/target"></a> `target`
- **Type:** String
#### <a name="CantripTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="CantripPerformanceParameters"></a> `CantripPerformanceParameters`
Measurable parameters of a blessing.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`range` | | <a href="#CantripPerformanceParameters/range">See details</a>
`duration` | | <a href="#CantripPerformanceParameters/duration">See details</a>
#### <a name="CantripPerformanceParameters/range"></a> `range`
- **Type:** <a href="#CantripRange">CantripRange</a>
#### <a name="CantripPerformanceParameters/duration"></a> `duration`
- **Type:** <a href="#CantripDuration">CantripDuration</a>
---
### <a name="CantripRange"></a> `CantripRange`
- **Type:** Union
- **Cases:** <a href="#CantripRange'Self">CantripRange'Self</a> | <a href="#CantripRange'Touch">CantripRange'Touch</a> | <a href="#CantripRange'Fixed">CantripRange'Fixed</a>
---
### <a name="CantripRange'Self"></a> `CantripRange'Self`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripRange'Self/tag">See details</a>
`self` | | <a href="#CantripRange'Self/self">See details</a>
#### <a name="CantripRange'Self/tag"></a> `tag`
- **Constant:** `"Self"`
#### <a name="CantripRange'Self/self"></a> `self`
- **Type:** <a href="#CantripRange'Self/self">Object</a>
---
### <a name="CantripRange'Self/self"></a> `CantripRange'Self/self`
- **Type:** Empty Object
---
### <a name="CantripRange'Touch"></a> `CantripRange'Touch`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripRange'Touch/tag">See details</a>
`touch` | | <a href="#CantripRange'Touch/touch">See details</a>
#### <a name="CantripRange'Touch/tag"></a> `tag`
- **Constant:** `"Touch"`
#### <a name="CantripRange'Touch/touch"></a> `touch`
- **Type:** <a href="#CantripRange'Touch/touch">Object</a>
---
### <a name="CantripRange'Touch/touch"></a> `CantripRange'Touch/touch`
- **Type:** Empty Object
---
### <a name="CantripRange'Fixed"></a> `CantripRange'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripRange'Fixed/tag">See details</a>
`fixed` | | <a href="#CantripRange'Fixed/fixed">See details</a>
#### <a name="CantripRange'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="CantripRange'Fixed/fixed"></a> `fixed`
- **Type:** <a href="./_ActivatableSkillRange.md#FixedRange">FixedRange</a>
---
### <a name="CantripDuration"></a> `CantripDuration`
- **Type:** Union
- **Cases:** <a href="#CantripDuration'Immediate">CantripDuration'Immediate</a> | <a href="#CantripDuration'Fixed">CantripDuration'Fixed</a> | <a href="#CantripDuration'DuringLovemaking">CantripDuration'DuringLovemaking</a> | <a href="#CantripDuration'Indefinite">CantripDuration'Indefinite</a>
---
### <a name="CantripDuration'Immediate"></a> `CantripDuration'Immediate`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripDuration'Immediate/tag">See details</a>
`immediate` | | <a href="#CantripDuration'Immediate/immediate">See details</a>
#### <a name="CantripDuration'Immediate/tag"></a> `tag`
- **Constant:** `"Immediate"`
#### <a name="CantripDuration'Immediate/immediate"></a> `immediate`
- **Type:** <a href="#CantripDuration'Immediate/immediate">Object</a>
---
### <a name="CantripDuration'Immediate/immediate"></a> `CantripDuration'Immediate/immediate`
- **Type:** Empty Object
---
### <a name="CantripDuration'Fixed"></a> `CantripDuration'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripDuration'Fixed/tag">See details</a>
`fixed` | | <a href="#CantripDuration'Fixed/fixed">See details</a>
#### <a name="CantripDuration'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="CantripDuration'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FixedCantripDuration">FixedCantripDuration</a>
---
### <a name="CantripDuration'DuringLovemaking"></a> `CantripDuration'DuringLovemaking`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripDuration'DuringLovemaking/tag">See details</a>
`during_lovemaking` | | <a href="#CantripDuration'DuringLovemaking/during_lovemaking">See details</a>
#### <a name="CantripDuration'DuringLovemaking/tag"></a> `tag`
- **Constant:** `"DuringLovemaking"`
#### <a name="CantripDuration'DuringLovemaking/during_lovemaking"></a> `during_lovemaking`
- **Type:** <a href="./_ActivatableSkillCastingTime.md#CastingTimeDuringLovemaking">CastingTimeDuringLovemaking</a>
---
### <a name="CantripDuration'Indefinite"></a> `CantripDuration'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CantripDuration'Indefinite/tag">See details</a>
`indefinite` | | <a href="#CantripDuration'Indefinite/indefinite">See details</a>
#### <a name="CantripDuration'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="CantripDuration'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#IndefiniteCantripDuration">IndefiniteCantripDuration</a>
---
### <a name="FixedCantripDuration"></a> `FixedCantripDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If `true`, the duration is a maximum duration. | <a href="#FixedCantripDuration/is_maximum">See details</a>
`value` | The (unitless) duration. | <a href="#FixedCantripDuration/value">See details</a>
`unit` | The duration unit. | <a href="#FixedCantripDuration/unit">See details</a>
#### <a name="FixedCantripDuration/is_maximum"></a> `is_maximum?`
If `true`, the duration is a maximum duration.
- **Constant:** `true`
#### <a name="FixedCantripDuration/value"></a> `value`
The (unitless) duration.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FixedCantripDuration/unit"></a> `unit`
The duration unit.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnit">DurationUnit</a>
---
### <a name="IndefiniteCantripDuration"></a> `IndefiniteCantripDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IndefiniteCantripDuration/translations">See details</a>
#### <a name="IndefiniteCantripDuration/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#IndefiniteCantripDurationTranslation">IndefiniteCantripDurationTranslation</a>&gt;
---
### <a name="IndefiniteCantripDurationTranslation"></a> `IndefiniteCantripDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the duration. | <a href="#IndefiniteCantripDurationTranslation/description">See details</a>
#### <a name="IndefiniteCantripDurationTranslation/description"></a> `description`
A description of the duration.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
docs/reference/Ceremony.md
-150
View File
@@ -1,150 +0,0 @@
# Ceremony
## Definitions
### <a name="Ceremony"></a> Ceremony (`Ceremony`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The ceremony's identifier. An unique, increasing integer. | <a href="#Ceremony/id">See details</a>
`check` | Lists the linked three attributes used to make a skill check. | <a href="#Ceremony/check">See details</a>
`check_penalty?` | In some cases, the target's Spirit or Toughness is applied as a penalty. | <a href="#Ceremony/check_penalty">See details</a>
`parameters` | Measurable parameters of a ceremony. | <a href="#Ceremony/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#Ceremony/target">See details</a>
`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. | <a href="#Ceremony/traditions">See details</a>
`improvement_cost` | States which column is used to improve the skill. | <a href="#Ceremony/improvement_cost">See details</a>
`prerequisites?` | | <a href="#Ceremony/prerequisites">See details</a>
`src` | | <a href="#Ceremony/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Ceremony/translations">See details</a>
`enhancements?` | | <a href="#Ceremony/enhancements">See details</a>
#### <a name="Ceremony/id"></a> `id`
The ceremony's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Ceremony/check"></a> `check`
Lists the linked three attributes used to make a skill check.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="Ceremony/check_penalty"></a> `check_penalty?`
In some cases, the target's Spirit or Toughness is applied as a penalty.
- **Type:** <a href="./_SkillCheck.md#SkillCheckPenalty">SkillCheckPenalty</a>
#### <a name="Ceremony/parameters"></a> `parameters`
Measurable parameters of a ceremony.
- **Type:** <a href="./_ActivatableSkill.md#SlowPerformanceParameters">SlowPerformanceParameters</a>
#### <a name="Ceremony/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="Ceremony/traditions"></a> `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.
- **Type:** List
- **Items:** <a href="#Ceremony/traditions[]">Ceremony/traditions[]</a>
- **Minimum Items:** `1`
#### <a name="Ceremony/improvement_cost"></a> `improvement_cost`
States which column is used to improve the skill.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="Ceremony/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#LiturgyPrerequisites">LiturgyPrerequisites</a>
#### <a name="Ceremony/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Ceremony/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CeremonyTranslation">CeremonyTranslation</a>&gt;
#### <a name="Ceremony/enhancements"></a> `enhancements?`
- **Type:** <a href="./_Enhancements.md#Enhancements">Enhancements</a>
---
### <a name="Ceremony/traditions[]"></a> `Ceremony/traditions[]`
- **Type:** <a href="./_Blessed.md#SkillTradition">SkillTradition</a>
---
### <a name="CeremonyTranslation"></a> `CeremonyTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the ceremony. | <a href="#CeremonyTranslation/name">See details</a>
`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 href="#CeremonyTranslation/name_compressed">See details</a>
`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. | <a href="#CeremonyTranslation/effect">See details</a>
`casting_time` | | <a href="#CeremonyTranslation/casting_time">See details</a>
`cost` | | <a href="#CeremonyTranslation/cost">See details</a>
`range` | | <a href="#CeremonyTranslation/range">See details</a>
`duration` | | <a href="#CeremonyTranslation/duration">See details</a>
`target` | | <a href="#CeremonyTranslation/target">See details</a>
`errata?` | | <a href="#CeremonyTranslation/errata">See details</a>
#### <a name="CeremonyTranslation/name"></a> `name`
The name of the ceremony.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CeremonyTranslation/name_compressed"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CeremonyTranslation/effect"></a> `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.
- **Type:** <a href="./_ActivatableSkillEffect.md#ActivatableSkillEffect">ActivatableSkillEffect</a>
#### <a name="CeremonyTranslation/casting_time"></a> `casting_time`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="CeremonyTranslation/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="CeremonyTranslation/range"></a> `range`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="CeremonyTranslation/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="CeremonyTranslation/target"></a> `target`
- **Type:** String
#### <a name="CeremonyTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/CombatTechnique_Close.md
-135
View File
@@ -1,135 +0,0 @@
# Close Combat Technique
## Definitions
### <a name="CloseCombatTechnique"></a> Close Combat Technique (`CloseCombatTechnique`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The close combat technique's identifier. An unique, increasing integer. | <a href="#CloseCombatTechnique/id">See details</a>
`special` | Special rules for the combat technique that apply to all weapons in this category. | <a href="#CloseCombatTechnique/special">See details</a>
`primary_attribute` | The primary attribute(s). | <a href="#CloseCombatTechnique/primary_attribute">See details</a>
`breaking_point_rating` | The *Breaking Point Rating* of the respective combat technique. | <a href="#CloseCombatTechnique/breaking_point_rating">See details</a>
`improvement_cost` | | <a href="#CloseCombatTechnique/improvement_cost">See details</a>
`src` | | <a href="#CloseCombatTechnique/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CloseCombatTechnique/translations">See details</a>
#### <a name="CloseCombatTechnique/id"></a> `id`
The close combat technique's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="CloseCombatTechnique/special"></a> `special`
Special rules for the combat technique that apply to all weapons in this category.
- **Type:** <a href="#CloseCombatTechniqueSpecialRules">CloseCombatTechniqueSpecialRules</a>
#### <a name="CloseCombatTechnique/primary_attribute"></a> `primary_attribute`
The primary attribute(s).
- **Type:** List
- **Items:** <a href="#CloseCombatTechnique/primary_attribute[]">CloseCombatTechnique/primary_attribute[]</a>
- **Minimum Items:** `1`
- **Maximum Items:** `2`
- **Unique Items:** Yes
#### <a name="CloseCombatTechnique/breaking_point_rating"></a> `breaking_point_rating`
The *Breaking Point Rating* of the respective combat technique.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="CloseCombatTechnique/improvement_cost"></a> `improvement_cost`
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="CloseCombatTechnique/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="CloseCombatTechnique/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CloseCombatTechniqueTranslation">CloseCombatTechniqueTranslation</a>&gt;
---
### <a name="CloseCombatTechnique/primary_attribute[]"></a> `CloseCombatTechnique/primary_attribute[]`
- **Type:** <a href="./_SimpleReferences.md#AttributeReference">AttributeReference</a>
---
### <a name="CloseCombatTechniqueSpecialRules"></a> `CloseCombatTechniqueSpecialRules`
Special rules for the combat technique that apply to all weapons in this category.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`can_parry` | Is parrying possible with this combat technique? | <a href="#CloseCombatTechniqueSpecialRules/can_parry">See details</a>
`has_damage_threshold` | | <a href="#CloseCombatTechniqueSpecialRules/has_damage_threshold">See details</a>
`has_reach` | | <a href="#CloseCombatTechniqueSpecialRules/has_reach">See details</a>
`has_length` | | <a href="#CloseCombatTechniqueSpecialRules/has_length">See details</a>
`has_shield_size` | | <a href="#CloseCombatTechniqueSpecialRules/has_shield_size">See details</a>
#### <a name="CloseCombatTechniqueSpecialRules/can_parry"></a> `can_parry`
Is parrying possible with this combat technique?
- **Type:** Boolean
#### <a name="CloseCombatTechniqueSpecialRules/has_damage_threshold"></a> `has_damage_threshold`
- **Type:** Boolean
#### <a name="CloseCombatTechniqueSpecialRules/has_reach"></a> `has_reach`
- **Type:** Boolean
#### <a name="CloseCombatTechniqueSpecialRules/has_length"></a> `has_length`
- **Type:** Boolean
#### <a name="CloseCombatTechniqueSpecialRules/has_shield_size"></a> `has_shield_size`
- **Type:** Boolean
---
### <a name="CloseCombatTechniqueTranslation"></a> `CloseCombatTechniqueTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the condition. | <a href="#CloseCombatTechniqueTranslation/name">See details</a>
`special?` | Additional rules for the condition, if applicable. | <a href="#CloseCombatTechniqueTranslation/special">See details</a>
`errata?` | | <a href="#CloseCombatTechniqueTranslation/errata">See details</a>
#### <a name="CloseCombatTechniqueTranslation/name"></a> `name`
The name of the condition.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CloseCombatTechniqueTranslation/special"></a> `special?`
Additional rules for the condition, if applicable.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="CloseCombatTechniqueTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/CombatTechnique_Ranged.md
-113
View File
@@ -1,113 +0,0 @@
# Ranged Combat Technique
## Definitions
### <a name="RangedCombatTechnique"></a> Ranged Combat Technique (`RangedCombatTechnique`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The ranged combat technique's identifier. An unique, increasing integer. | <a href="#RangedCombatTechnique/id">See details</a>
`special` | Special rules for the combat technique that apply to all weapons in this category. | <a href="#RangedCombatTechnique/special">See details</a>
`primary_attribute` | The primary attribute(s). | <a href="#RangedCombatTechnique/primary_attribute">See details</a>
`breaking_point_rating` | The *Breaking Point Rating* of the respective combat technique. | <a href="#RangedCombatTechnique/breaking_point_rating">See details</a>
`improvement_cost` | | <a href="#RangedCombatTechnique/improvement_cost">See details</a>
`src` | | <a href="#RangedCombatTechnique/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#RangedCombatTechnique/translations">See details</a>
#### <a name="RangedCombatTechnique/id"></a> `id`
The ranged combat technique's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="RangedCombatTechnique/special"></a> `special`
Special rules for the combat technique that apply to all weapons in this category.
- **Type:** <a href="#RangedCombatTechniqueSpecialRules">RangedCombatTechniqueSpecialRules</a>
#### <a name="RangedCombatTechnique/primary_attribute"></a> `primary_attribute`
The primary attribute(s).
- **Type:** List
- **Items:** <a href="#RangedCombatTechnique/primary_attribute[]">RangedCombatTechnique/primary_attribute[]</a>
- **Minimum Items:** `1`
- **Maximum Items:** `2`
- **Unique Items:** Yes
#### <a name="RangedCombatTechnique/breaking_point_rating"></a> `breaking_point_rating`
The *Breaking Point Rating* of the respective combat technique.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="RangedCombatTechnique/improvement_cost"></a> `improvement_cost`
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="RangedCombatTechnique/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="RangedCombatTechnique/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RangedCombatTechniqueTranslation">RangedCombatTechniqueTranslation</a>&gt;
---
### <a name="RangedCombatTechnique/primary_attribute[]"></a> `RangedCombatTechnique/primary_attribute[]`
- **Type:** <a href="./_SimpleReferences.md#AttributeReference">AttributeReference</a>
---
### <a name="RangedCombatTechniqueSpecialRules"></a> `RangedCombatTechniqueSpecialRules`
Special rules for the combat technique that apply to all weapons in this category.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`has_ammunition` | | <a href="#RangedCombatTechniqueSpecialRules/has_ammunition">See details</a>
#### <a name="RangedCombatTechniqueSpecialRules/has_ammunition"></a> `has_ammunition`
- **Type:** Boolean
---
### <a name="RangedCombatTechniqueTranslation"></a> `RangedCombatTechniqueTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the condition. | <a href="#RangedCombatTechniqueTranslation/name">See details</a>
`special?` | Additional rules for the condition, if applicable. | <a href="#RangedCombatTechniqueTranslation/special">See details</a>
`errata?` | | <a href="#RangedCombatTechniqueTranslation/errata">See details</a>
#### <a name="RangedCombatTechniqueTranslation/name"></a> `name`
The name of the condition.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="RangedCombatTechniqueTranslation/special"></a> `special?`
Additional rules for the condition, if applicable.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="RangedCombatTechniqueTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Condition.md
-74
View File
@@ -1,74 +0,0 @@
# Condition
## Definitions
### <a name="Condition"></a> Condition (`Condition`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The condition's identifier. An unique, increasing integer. | <a href="#Condition/id">See details</a>
`src` | | <a href="#Condition/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Condition/translations">See details</a>
#### <a name="Condition/id"></a> `id`
The condition's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Condition/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Condition/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ConditionTranslation">ConditionTranslation</a>&gt;
---
### <a name="ConditionTranslation"></a> `ConditionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The condition's name. | <a href="#ConditionTranslation/name">See details</a>
`rules?` | Additional rules for the condition, if applicable. | <a href="#ConditionTranslation/rules">See details</a>
`effects` | The effects for level 1 to 4. | <a href="#ConditionTranslation/effects">See details</a>
`errata?` | | <a href="#ConditionTranslation/errata">See details</a>
#### <a name="ConditionTranslation/name"></a> `name`
The condition's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ConditionTranslation/rules"></a> `rules?`
Additional rules for the condition, if applicable.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ConditionTranslation/effects"></a> `effects`
The effects for level 1 to 4.
- **Type:** List
- **Items:** <a href="#ConditionTranslation/effects[]">ConditionTranslation/effects[]</a>
- **Minimum Items:** `4`
- **Maximum Items:** `4`
#### <a name="ConditionTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="ConditionTranslation/effects[]"></a> `ConditionTranslation/effects[]`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
docs/reference/Continent.md
-46
View File
@@ -1,46 +0,0 @@
# Continent
Continents are mostly referenced to in languages and scripts that occur on a specific continent.
## Definitions
### <a name="Continent"></a> Continent (`Continent`)
Continents are mostly referenced to in languages and scripts that occur on a specific continent.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The continent's identifier. An unique, increasing integer. | <a href="#Continent/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Continent/translations">See details</a>
#### <a name="Continent/id"></a> `id`
The continent's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Continent/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ContinentTranslation">ContinentTranslation</a>&gt;
---
### <a name="ContinentTranslation"></a> `ContinentTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The continent name. | <a href="#ContinentTranslation/name">See details</a>
#### <a name="ContinentTranslation/name"></a> `name`
The continent name.
- **Type:** String
- **Minimum Length:** `1`
docs/reference/Culture.md
-934
View File
@@ -1,934 +0,0 @@
# Culture
## Definitions
### <a name="Culture"></a> Culture (`Culture`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | An unique, increasing integer. | <a href="#Culture/id">See details</a>
`language` | A list of native languages (usually it is only one). | <a href="#Culture/language">See details</a>
`script?` | A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty. | <a href="#Culture/script">See details</a>
`area_knowledge` | If the area knowledge has a fixed value or can be adjusted. | <a href="#Culture/area_knowledge">See details</a>
`social_status` | A list of possible social status in the respective culture. | <a href="#Culture/social_status">See details</a>
`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 href="#Culture/common_professions">See details</a>
`common_advantages?` | A list of common advantages. | <a href="#Culture/common_advantages">See details</a>
`common_disadvantages?` | A list of common disadvantages. | <a href="#Culture/common_disadvantages">See details</a>
`uncommon_advantages?` | A list of uncommon advantages. | <a href="#Culture/uncommon_advantages">See details</a>
`uncommon_disadvantages?` | A list of uncommon disadvantages. | <a href="#Culture/uncommon_disadvantages">See details</a>
`common_skills` | A list of common skills. | <a href="#Culture/common_skills">See details</a>
`uncommon_skills?` | A list of uncommon skills. | <a href="#Culture/uncommon_skills">See details</a>
`cultural_package` | The skill points you get for buying the culture package. | <a href="#Culture/cultural_package">See details</a>
`src` | | <a href="#Culture/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Culture/translations">See details</a>
#### <a name="Culture/id"></a> `id`
An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Culture/language"></a> `language`
A list of native languages (usually it is only one).
- **Type:** List
- **Items:** <a href="#Culture/language[]">Culture/language[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/script"></a> `script?`
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:** <a href="#Culture/script[]">Culture/script[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/area_knowledge"></a> `area_knowledge`
If the area knowledge has a fixed value or can be adjusted.
- **Type:** <a href="#AreaKnowledge">AreaKnowledge</a>
#### <a name="Culture/social_status"></a> `social_status`
A list of possible social status in the respective culture.
- **Type:** List
- **Items:** <a href="#Culture/social_status[]">Culture/social_status[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/common_professions"></a> `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).
- **Type:** <a href="#CommonProfessions">CommonProfessions</a>
#### <a name="Culture/common_advantages"></a> `common_advantages?`
A list of common advantages.
- **Type:** List
- **Items:** <a href="#Culture/common_advantages[]">Culture/common_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/common_disadvantages"></a> `common_disadvantages?`
A list of common disadvantages.
- **Type:** List
- **Items:** <a href="#Culture/common_disadvantages[]">Culture/common_disadvantages[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/uncommon_advantages"></a> `uncommon_advantages?`
A list of uncommon advantages.
- **Type:** List
- **Items:** <a href="#Culture/uncommon_advantages[]">Culture/uncommon_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/uncommon_disadvantages"></a> `uncommon_disadvantages?`
A list of uncommon disadvantages.
- **Type:** List
- **Items:** <a href="#Culture/uncommon_disadvantages[]">Culture/uncommon_disadvantages[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/common_skills"></a> `common_skills`
A list of common skills.
- **Type:** List
- **Items:** <a href="#Culture/common_skills[]">Culture/common_skills[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/uncommon_skills"></a> `uncommon_skills?`
A list of uncommon skills.
- **Type:** List
- **Items:** <a href="#Culture/uncommon_skills[]">Culture/uncommon_skills[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/cultural_package"></a> `cultural_package`
The skill points you get for buying the culture package.
- **Type:** List
- **Items:** <a href="#Culture/cultural_package[]">Culture/cultural_package[]</a>
- **Minimum Items:** `1`
#### <a name="Culture/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Culture/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CultureTranslation">CultureTranslation</a>&gt;
---
### <a name="Culture/language[]"></a> `Culture/language[]`
- **Type:** <a href="./_SimpleReferences.md#LanguageReference">LanguageReference</a>
---
### <a name="Culture/script[]"></a> `Culture/script[]`
- **Type:** <a href="./_SimpleReferences.md#ScriptReference">ScriptReference</a>
---
### <a name="Culture/social_status[]"></a> `Culture/social_status[]`
- **Type:** <a href="./_SimpleReferences.md#SocialStatusReference">SocialStatusReference</a>
---
### <a name="Culture/common_advantages[]"></a> `Culture/common_advantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>&gt;
---
### <a name="Culture/common_disadvantages[]"></a> `Culture/common_disadvantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>&gt;
---
### <a name="Culture/uncommon_advantages[]"></a> `Culture/uncommon_advantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>&gt;
---
### <a name="Culture/uncommon_disadvantages[]"></a> `Culture/uncommon_disadvantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>&gt;
---
### <a name="Culture/common_skills[]"></a> `Culture/common_skills[]`
- **Type:** <a href="#CommonnessRatedSkill">CommonnessRatedSkill</a>
---
### <a name="Culture/uncommon_skills[]"></a> `Culture/uncommon_skills[]`
- **Type:** <a href="#CommonnessRatedSkill">CommonnessRatedSkill</a>
---
### <a name="Culture/cultural_package[]"></a> `Culture/cultural_package[]`
- **Type:** <a href="#CulturalPackageItem">CulturalPackageItem</a>
---
### <a name="AreaKnowledge"></a> `AreaKnowledge`
If the area knowledge has a fixed value or can be adjusted.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_fixed` | `true` if the area knowledge has a fixed value, `false` if it can be adjusted. | <a href="#AreaKnowledge/is_fixed">See details</a>
#### <a name="AreaKnowledge/is_fixed"></a> `is_fixed`
`true` if the area knowledge has a fixed value, `false` if it can be
adjusted.
- **Type:** Boolean
---
### <a name="CommonnessWeight"></a> `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).
- **Type:** Union
- **Cases:** <a href="#CommonnessWeight'0">CommonnessWeight'0</a> | <a href="#CommonnessWeight'1">CommonnessWeight'1</a>
---
### <a name="CommonnessWeight'0"></a> `CommonnessWeight'0`
- **Constant:** `"Mostly"`
---
### <a name="CommonnessWeight'1"></a> `CommonnessWeight'1`
- **Constant:** `"Only"`
---
### <a name="Weighted"></a> `Weighted<ProfessionOrVariant>`
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
Key | Description | Details
:-- | :-- | :--
`elements` | The list of more common professions or profession variants. | <a href="#Weighted/elements">See details</a>
`weight` | 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). | <a href="#Weighted/weight">See details</a>
#### <a name="Weighted/elements"></a> `elements`
The list of more common professions or profession variants.
- **Type:** List
- **Items:** <a href="#Weighted/elements[]">Weighted/elements[]</a>
- **Minimum Items:** `1`
#### <a name="Weighted/weight"></a> `weight`
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:** <a href="#CommonnessWeight">CommonnessWeight</a>
---
### <a name="Weighted/elements[]"></a> `Weighted/elements[]`
- **Type:** <a href="#ProfessionOrVariant">ProfessionOrVariant</a>
---
### <a name="CommonProfessionConstraintsOperation"></a> `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).
- **Type:** Union
- **Cases:** <a href="#CommonProfessionConstraintsOperation'0">CommonProfessionConstraintsOperation'0</a> | <a href="#CommonProfessionConstraintsOperation'1">CommonProfessionConstraintsOperation'1</a>
---
### <a name="CommonProfessionConstraintsOperation'0"></a> `CommonProfessionConstraintsOperation'0`
- **Constant:** `"Intersection"`
---
### <a name="CommonProfessionConstraintsOperation'1"></a> `CommonProfessionConstraintsOperation'1`
- **Constant:** `"Difference"`
---
### <a name="CommonProfessionConstraints"></a> `CommonProfessionConstraints<Constraint>`
A list of professions. The filter specifies how the list is applied to all mundane professions.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`constraints` | The list of constraints. | <a href="#CommonProfessionConstraints/constraints">See details</a>
`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). | <a href="#CommonProfessionConstraints/operation">See details</a>
#### <a name="CommonProfessionConstraints/constraints"></a> `constraints`
The list of constraints.
- **Type:** List
- **Items:** <a href="#CommonProfessionConstraints/constraints[]">CommonProfessionConstraints/constraints[]</a>
- **Minimum Items:** `1`
#### <a name="CommonProfessionConstraints/operation"></a> `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).
- **Type:** <a href="#CommonProfessionConstraintsOperation">CommonProfessionConstraintsOperation</a>
---
### <a name="CommonProfessionConstraints/constraints[]"></a> `CommonProfessionConstraints/constraints[]`
- **Type:** <a href="#Constraint">Constraint</a>
---
### <a name="Rarity"></a> `Rarity`
Some professions may be found in a culture, but are not that common.
- **Type:** Union
- **Cases:** <a href="#Rarity'0">Rarity'0</a> | <a href="#Rarity'1">Rarity'1</a>
---
### <a name="Rarity'0"></a> `Rarity'0`
- **Constant:** `"Rare"`
---
### <a name="Rarity'1"></a> `Rarity'1`
- **Constant:** `"VeryRare"`
---
### <a name="ProfessionConstraint"></a> `ProfessionConstraint`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The profession's identifier. | <a href="#ProfessionConstraint/id">See details</a>
`weighted_variants?` | Some profession variants are more common than others. There may be cultures where some variants are not represented at all. | <a href="#ProfessionConstraint/weighted_variants">See details</a>
`rarity?` | Some professions may be found in a culture, but are not that common. | <a href="#ProfessionConstraint/rarity">See details</a>
#### <a name="ProfessionConstraint/id"></a> `id`
The profession's identifier.
- **Type:** <a href="./_Identifier.md#ProfessionIdentifier">ProfessionIdentifier</a>
#### <a name="ProfessionConstraint/weighted_variants"></a> `weighted_variants?`
Some profession variants are more common than others. There may be cultures where some variants are not represented at all.
- **Type:** <a href="#Weighted">Weighted</a>&lt;<a href="./_SimpleReferences.md#ProfessionVariantReference">ProfessionVariantReference</a>&gt;
#### <a name="ProfessionConstraint/rarity"></a> `rarity?`
Some professions may be found in a culture, but are not that common.
- **Type:** <a href="#Rarity">Rarity</a>
---
### <a name="MundaneProfessionSubgroupConstraint"></a> `MundaneProfessionSubgroupConstraint`
Some professions may be found in a culture, but are not that common.
- **Type:** Union
- **Cases:** <a href="#MundaneProfessionSubgroupConstraint'0">MundaneProfessionSubgroupConstraint'0</a> | <a href="#MundaneProfessionSubgroupConstraint'1">MundaneProfessionSubgroupConstraint'1</a> | <a href="#MundaneProfessionSubgroupConstraint'2">MundaneProfessionSubgroupConstraint'2</a>
---
### <a name="MundaneProfessionSubgroupConstraint'0"></a> `MundaneProfessionSubgroupConstraint'0`
- **Constant:** `"Profane"`
---
### <a name="MundaneProfessionSubgroupConstraint'1"></a> `MundaneProfessionSubgroupConstraint'1`
- **Constant:** `"Fighter"`
---
### <a name="MundaneProfessionSubgroupConstraint'2"></a> `MundaneProfessionSubgroupConstraint'2`
- **Constant:** `"Religious"`
---
### <a name="MagicalTraditionConstraint"></a> `MagicalTraditionConstraint`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The magical tradition's identifier. | <a href="#MagicalTraditionConstraint/id">See details</a>
`weighted_professions?` | Some professions are more common than others. There may be cultures where some professions are not represented at all. | <a href="#MagicalTraditionConstraint/weighted_professions">See details</a>
`rarity?` | Some traditions may be found in a culture, but are not that common. | <a href="#MagicalTraditionConstraint/rarity">See details</a>
#### <a name="MagicalTraditionConstraint/id"></a> `id`
The magical tradition's identifier.
- **Type:** <a href="./_Identifier.md#MagicalTraditionIdentifier">MagicalTraditionIdentifier</a>
#### <a name="MagicalTraditionConstraint/weighted_professions"></a> `weighted_professions?`
Some professions are more common than others. There may be cultures where some professions are not represented at all.
- **Type:** <a href="#Weighted">Weighted</a>&lt;<a href="./_SimpleReferences.md#ProfessionReference">ProfessionReference</a>&gt;
#### <a name="MagicalTraditionConstraint/rarity"></a> `rarity?`
Some traditions may be found in a culture, but are not that common.
- **Type:** <a href="#Rarity">Rarity</a>
---
### <a name="BlessedTraditionConstraint"></a> `BlessedTraditionConstraint`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The magical tradition's identifier. | <a href="#BlessedTraditionConstraint/id">See details</a>
`weighted_professions?` | Some professions are more common than others. There may be cultures where some professions are not represented at all. | <a href="#BlessedTraditionConstraint/weighted_professions">See details</a>
`rarity?` | Some traditions may be found in a culture, but are not that common. | <a href="#BlessedTraditionConstraint/rarity">See details</a>
#### <a name="BlessedTraditionConstraint/id"></a> `id`
The magical tradition's identifier.
- **Type:** <a href="./_Identifier.md#BlessedTraditionIdentifier">BlessedTraditionIdentifier</a>
#### <a name="BlessedTraditionConstraint/weighted_professions"></a> `weighted_professions?`
Some professions are more common than others. There may be cultures where some professions are not represented at all.
- **Type:** <a href="#Weighted">Weighted</a>&lt;<a href="./_SimpleReferences.md#ProfessionReference">ProfessionReference</a>&gt;
#### <a name="BlessedTraditionConstraint/rarity"></a> `rarity?`
Some traditions may be found in a culture, but are not that common.
- **Type:** <a href="#Rarity">Rarity</a>
---
### <a name="MundaneCommonProfessionConstraint"></a> `MundaneCommonProfessionConstraint`
- **Type:** Union
- **Cases:** <a href="#MundaneCommonProfessionConstraint'Profession">MundaneCommonProfessionConstraint'Profession</a> | <a href="#MundaneCommonProfessionConstraint'ProfessionSubgroup">MundaneCommonProfessionConstraint'ProfessionSubgroup</a>
---
### <a name="MundaneCommonProfessionConstraint'Profession"></a> `MundaneCommonProfessionConstraint'Profession`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#MundaneCommonProfessionConstraint'Profession/tag">See details</a>
`profession` | | <a href="#MundaneCommonProfessionConstraint'Profession/profession">See details</a>
#### <a name="MundaneCommonProfessionConstraint'Profession/tag"></a> `tag`
- **Constant:** `"Profession"`
#### <a name="MundaneCommonProfessionConstraint'Profession/profession"></a> `profession`
- **Type:** <a href="#ProfessionConstraint">ProfessionConstraint</a>
---
### <a name="MundaneCommonProfessionConstraint'ProfessionSubgroup"></a> `MundaneCommonProfessionConstraint'ProfessionSubgroup`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#MundaneCommonProfessionConstraint'ProfessionSubgroup/tag">See details</a>
`profession_subgroup` | | <a href="#MundaneCommonProfessionConstraint'ProfessionSubgroup/profession_subgroup">See details</a>
#### <a name="MundaneCommonProfessionConstraint'ProfessionSubgroup/tag"></a> `tag`
- **Constant:** `"ProfessionSubgroup"`
#### <a name="MundaneCommonProfessionConstraint'ProfessionSubgroup/profession_subgroup"></a> `profession_subgroup`
- **Type:** <a href="#MundaneProfessionSubgroupConstraint">MundaneProfessionSubgroupConstraint</a>
---
### <a name="MagicCommonProfessionConstraint"></a> `MagicCommonProfessionConstraint`
- **Type:** Union
- **Cases:** <a href="#MagicCommonProfessionConstraint'Tradition">MagicCommonProfessionConstraint'Tradition</a> | <a href="#MagicCommonProfessionConstraint'MagicDilettante">MagicCommonProfessionConstraint'MagicDilettante</a> | <a href="#MagicCommonProfessionConstraint'Profession">MagicCommonProfessionConstraint'Profession</a>
---
### <a name="MagicCommonProfessionConstraint'Tradition"></a> `MagicCommonProfessionConstraint'Tradition`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#MagicCommonProfessionConstraint'Tradition/tag">See details</a>
`tradition` | | <a href="#MagicCommonProfessionConstraint'Tradition/tradition">See details</a>
#### <a name="MagicCommonProfessionConstraint'Tradition/tag"></a> `tag`
- **Constant:** `"Tradition"`
#### <a name="MagicCommonProfessionConstraint'Tradition/tradition"></a> `tradition`
- **Type:** <a href="#MagicalTraditionConstraint">MagicalTraditionConstraint</a>
---
### <a name="MagicCommonProfessionConstraint'MagicDilettante"></a> `MagicCommonProfessionConstraint'MagicDilettante`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#MagicCommonProfessionConstraint'MagicDilettante/tag">See details</a>
`magic_dilettante` | | <a href="#MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante">See details</a>
#### <a name="MagicCommonProfessionConstraint'MagicDilettante/tag"></a> `tag`
- **Constant:** `"MagicDilettante"`
#### <a name="MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante"></a> `magic_dilettante`
- **Type:** <a href="#MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante">Object</a>
---
### <a name="MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante"></a> `MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante`
- **Type:** Empty Object
---
### <a name="MagicCommonProfessionConstraint'Profession"></a> `MagicCommonProfessionConstraint'Profession`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#MagicCommonProfessionConstraint'Profession/tag">See details</a>
`profession` | | <a href="#MagicCommonProfessionConstraint'Profession/profession">See details</a>
#### <a name="MagicCommonProfessionConstraint'Profession/tag"></a> `tag`
- **Constant:** `"Profession"`
#### <a name="MagicCommonProfessionConstraint'Profession/profession"></a> `profession`
- **Type:** <a href="#ProfessionConstraint">ProfessionConstraint</a>
---
### <a name="BlessedCommonProfessionConstraint"></a> `BlessedCommonProfessionConstraint`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BlessedCommonProfessionConstraint/tag">See details</a>
`tradition` | | <a href="#BlessedCommonProfessionConstraint/tradition">See details</a>
#### <a name="BlessedCommonProfessionConstraint/tag"></a> `tag`
- **Constant:** `"Tradition"`
#### <a name="BlessedCommonProfessionConstraint/tradition"></a> `tradition`
- **Type:** <a href="#BlessedTraditionConstraint">BlessedTraditionConstraint</a>
---
### <a name="PlainCommonProfessions"></a> `PlainCommonProfessions`
- **Type:** <a href="#CommonProfessionConstraints">CommonProfessionConstraints</a>&lt;<a href="./_SimpleReferences.md#ProfessionReference">ProfessionReference</a>&gt;
---
### <a name="GroupedCommonProfessions"></a> `GroupedCommonProfessions`
Lists of professions by group.
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`mundane?` | | <a href="#GroupedCommonProfessions/mundane">See details</a>
`magic?` | | <a href="#GroupedCommonProfessions/magic">See details</a>
`blessed?` | | <a href="#GroupedCommonProfessions/blessed">See details</a>
#### <a name="GroupedCommonProfessions/mundane"></a> `mundane?`
- **Type:** <a href="#CommonProfessionConstraints">CommonProfessionConstraints</a>&lt;<a href="#MundaneCommonProfessionConstraint">MundaneCommonProfessionConstraint</a>&gt;
#### <a name="GroupedCommonProfessions/magic"></a> `magic?`
- **Type:** <a href="#CommonProfessionConstraints">CommonProfessionConstraints</a>&lt;<a href="#MagicCommonProfessionConstraint">MagicCommonProfessionConstraint</a>&gt;
#### <a name="GroupedCommonProfessions/blessed"></a> `blessed?`
- **Type:** <a href="#CommonProfessionConstraints">CommonProfessionConstraints</a>&lt;<a href="#BlessedCommonProfessionConstraint">BlessedCommonProfessionConstraint</a>&gt;
---
### <a name="CommonProfessions"></a> `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).
- **Type:** Union
- **Cases:** <a href="#CommonProfessions'Plain">CommonProfessions'Plain</a> | <a href="#CommonProfessions'Grouped">CommonProfessions'Grouped</a>
---
### <a name="CommonProfessions'Plain"></a> `CommonProfessions'Plain`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CommonProfessions'Plain/tag">See details</a>
`plain` | | <a href="#CommonProfessions'Plain/plain">See details</a>
#### <a name="CommonProfessions'Plain/tag"></a> `tag`
- **Constant:** `"Plain"`
#### <a name="CommonProfessions'Plain/plain"></a> `plain`
- **Type:** <a href="#PlainCommonProfessions">PlainCommonProfessions</a>
---
### <a name="CommonProfessions'Grouped"></a> `CommonProfessions'Grouped`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CommonProfessions'Grouped/tag">See details</a>
`grouped` | | <a href="#CommonProfessions'Grouped/grouped">See details</a>
#### <a name="CommonProfessions'Grouped/tag"></a> `tag`
- **Constant:** `"Grouped"`
#### <a name="CommonProfessions'Grouped/grouped"></a> `grouped`
- **Type:** <a href="#GroupedCommonProfessions">GroupedCommonProfessions</a>
---
### <a name="CommonnessRatedSkill"></a> `CommonnessRatedSkill`
- **Type:** <a href="./_SimpleReferences.md#SkillReference">SkillReference</a>
---
### <a name="CulturalPackageItem"></a> `CulturalPackageItem`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill's identifier. | <a href="#CulturalPackageItem/id">See details</a>
`points` | The skill points for the respective skill you get for buying the cultural package. | <a href="#CulturalPackageItem/points">See details</a>
#### <a name="CulturalPackageItem/id"></a> `id`
The skill's identifier.
- **Type:** <a href="./_Identifier.md#SkillIdentifier">SkillIdentifier</a>
#### <a name="CulturalPackageItem/points"></a> `points`
The skill points for the respective skill you get for buying the cultural package.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `2`
---
### <a name="CultureTranslation"></a> `CultureTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the state. | <a href="#CultureTranslation/name">See details</a>
`area_knowledge` | The description of the area knowledge. | <a href="#CultureTranslation/area_knowledge">See details</a>
`common_advantages?` | The respective common advantages text from the source book. | <a href="#CultureTranslation/common_advantages">See details</a>
`common_disadvantages?` | The respective common disadvantages text from the source book. | <a href="#CultureTranslation/common_disadvantages">See details</a>
`uncommon_advantages?` | The respective uncommon advantages text from the source book. | <a href="#CultureTranslation/uncommon_advantages">See details</a>
`uncommon_disadvantages?` | The respective uncommon disadvantages text from the source book. | <a href="#CultureTranslation/uncommon_disadvantages">See details</a>
`common_names` | Structured description of common names. | <a href="#CultureTranslation/common_names">See details</a>
`errata?` | | <a href="#CultureTranslation/errata">See details</a>
#### <a name="CultureTranslation/name"></a> `name`
The name of the state.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CultureTranslation/area_knowledge"></a> `area_knowledge`
The description of the area knowledge.
- **Type:** <a href="#AreaKnowledgeTranslation">AreaKnowledgeTranslation</a>
#### <a name="CultureTranslation/common_advantages"></a> `common_advantages?`
The respective common advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CultureTranslation/common_disadvantages"></a> `common_disadvantages?`
The respective common disadvantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CultureTranslation/uncommon_advantages"></a> `uncommon_advantages?`
The respective uncommon advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CultureTranslation/uncommon_disadvantages"></a> `uncommon_disadvantages?`
The respective uncommon disadvantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CultureTranslation/common_names"></a> `common_names`
Structured description of common names.
- **Type:** <a href="#CommonNames">CommonNames</a>
#### <a name="CultureTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="AreaKnowledgeTranslation"></a> `AreaKnowledgeTranslation`
Description and examples of the area knowledge.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | The full description without examples in parenthesis. | <a href="#AreaKnowledgeTranslation/description">See details</a>
`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 href="#AreaKnowledgeTranslation/abbreviated">See details</a>
`examples?` | Examples of areas, if applicable. | <a href="#AreaKnowledgeTranslation/examples">See details</a>
#### <a name="AreaKnowledgeTranslation/description"></a> `description`
The full description without examples in parenthesis.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="AreaKnowledgeTranslation/abbreviated"></a> `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.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="AreaKnowledgeTranslation/examples"></a> `examples?`
Examples of areas, if applicable.
- **Type:** List
- **Items:** <a href="#AreaKnowledgeTranslation/examples[]">AreaKnowledgeTranslation/examples[]</a>
- **Minimum Items:** `1`
---
### <a name="AreaKnowledgeTranslation/examples[]"></a> `AreaKnowledgeTranslation/examples[]`
- **Type:** <a href="#AreaKnowledgeExample">AreaKnowledgeExample</a>
---
### <a name="AreaKnowledgeExample"></a> `AreaKnowledgeExample`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`area` | | <a href="#AreaKnowledgeExample/area">See details</a>
#### <a name="AreaKnowledgeExample/area"></a> `area`
- **Type:** String
- **Minimum Length:** `1`
---
### <a name="CommonNames"></a> `CommonNames`
Structured description of common names.
- **Type:** Object
- **Minimum Properties:** `1`
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. | <a href="#CommonNames/first_name_groups">See details</a>
`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. | <a href="#CommonNames/last_name_groups">See details</a>
`naming_rules?` | Special naming rules. | <a href="#CommonNames/naming_rules">See details</a>
#### <a name="CommonNames/first_name_groups"></a> `first_name_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:** <a href="#CommonNames/first_name_groups[]">CommonNames/first_name_groups[]</a>
- **Minimum Items:** `1`
#### <a name="CommonNames/last_name_groups"></a> `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.
- **Type:** List
- **Items:** <a href="#CommonNames/last_name_groups[]">CommonNames/last_name_groups[]</a>
- **Minimum Items:** `1`
#### <a name="CommonNames/naming_rules"></a> `naming_rules?`
Special naming rules.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="CommonNames/first_name_groups[]"></a> `CommonNames/first_name_groups[]`
- **Type:** <a href="#CommonNameGroup">CommonNameGroup</a>
---
### <a name="CommonNames/last_name_groups[]"></a> `CommonNames/last_name_groups[]`
- **Type:** <a href="#CommonNameGroup">CommonNameGroup</a>
---
### <a name="CommonNameGroup"></a> `CommonNameGroup`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`label` | The group label. | <a href="#CommonNameGroup/label">See details</a>
`sex?` | The binary sex if the group is only for a certain binary sex. | <a href="#CommonNameGroup/sex">See details</a>
`names` | The names from the group. | <a href="#CommonNameGroup/names">See details</a>
#### <a name="CommonNameGroup/label"></a> `label`
The group label.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CommonNameGroup/sex"></a> `sex?`
The binary sex if the group is only for a certain binary sex.
- **Type:** <a href="./_Sex.md#BinarySex">BinarySex</a>
#### <a name="CommonNameGroup/names"></a> `names`
The names from the group.
- **Type:** List
- **Items:** <a href="#CommonNameGroup/names[]">CommonNameGroup/names[]</a>
- **Minimum Items:** `1`
---
### <a name="CommonNameGroup/names[]"></a> `CommonNameGroup/names[]`
- **Type:** <a href="#CommonName">CommonName</a>
---
### <a name="CommonName"></a> `CommonName`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | | <a href="#CommonName/name">See details</a>
`note?` | Additional information about the name, appended in parenthesis. | <a href="#CommonName/note">See details</a>
#### <a name="CommonName/name"></a> `name`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CommonName/note"></a> `note?`
Additional information about the name, appended in parenthesis.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/DerivedCharacteristic.md
-102
View File
@@ -1,102 +0,0 @@
# Derived Characteristic
## Definitions
### <a name="DerivedCharacteristic"></a> Derived Characteristic (`DerivedCharacteristic`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | An unique, increasing integer. | <a href="#DerivedCharacteristic/id">See details</a>
`prerequisites?` | | <a href="#DerivedCharacteristic/prerequisites">See details</a>
`src` | | <a href="#DerivedCharacteristic/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#DerivedCharacteristic/translations">See details</a>
#### <a name="DerivedCharacteristic/id"></a> `id`
An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="DerivedCharacteristic/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#DerivedCharacteristicPrerequisites">DerivedCharacteristicPrerequisites</a>
#### <a name="DerivedCharacteristic/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="DerivedCharacteristic/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#DerivedCharacteristicTranslation">DerivedCharacteristicTranslation</a>&gt;
---
### <a name="DerivedCharacteristicTranslation"></a> `DerivedCharacteristicTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The characteristic's name. | <a href="#DerivedCharacteristicTranslation/name">See details</a>
`abbreviation` | The characteristic's abbreviation. | <a href="#DerivedCharacteristicTranslation/abbreviation">See details</a>
`calculation?` | Possible calculation strings for the final value. | <a href="#DerivedCharacteristicTranslation/calculation">See details</a>
#### <a name="DerivedCharacteristicTranslation/name"></a> `name`
The characteristic's name.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="DerivedCharacteristicTranslation/abbreviation"></a> `abbreviation`
The characteristic's abbreviation.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="DerivedCharacteristicTranslation/calculation"></a> `calculation?`
Possible calculation strings for the final value.
- **Type:** <a href="#CalculationTranslation">CalculationTranslation</a>
---
### <a name="CalculationTranslation"></a> `CalculationTranslation`
Possible calculation strings for the final value.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`default` | The default calculation string. | <a href="#CalculationTranslation/default">See details</a>
`half_primary?` | The calculation string if only half of the primary attribute is used. | <a href="#CalculationTranslation/half_primary">See details</a>
`no_primary?` | The calculation string if no primary attribute is used. | <a href="#CalculationTranslation/no_primary">See details</a>
#### <a name="CalculationTranslation/default"></a> `default`
The default calculation string.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CalculationTranslation/half_primary"></a> `half_primary?`
The calculation string if only half of the primary attribute is used.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CalculationTranslation/no_primary"></a> `no_primary?`
The calculation string if no primary attribute is used.
- **Type:** String
- **Minimum Length:** `1`
docs/reference/Disadvantage.md
-117
View File
@@ -1,117 +0,0 @@
# Disadvantage
## Definitions
### <a name="Disadvantage"></a> Disadvantage (`Disadvantage`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#Disadvantage/id">See details</a>
`levels?` | | <a href="#Disadvantage/levels">See details</a>
`select_options?` | | <a href="#Disadvantage/select_options">See details</a>
`maximum?` | | <a href="#Disadvantage/maximum">See details</a>
`prerequisites?` | | <a href="#Disadvantage/prerequisites">See details</a>
`ap_value` | | <a href="#Disadvantage/ap_value">See details</a>
`has_maximum_spent_influence` | Does this disadvantage count towards the maximum of AP to be spent on disadvantages? | <a href="#Disadvantage/has_maximum_spent_influence">See details</a>
`is_exclusive_to_arcane_spellworks` | Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications? | <a href="#Disadvantage/is_exclusive_to_arcane_spellworks">See details</a>
`src` | | <a href="#Disadvantage/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Disadvantage/translations">See details</a>
#### <a name="Disadvantage/id"></a> `id`
- **Type:** <a href="#Id">Id</a>
#### <a name="Disadvantage/levels"></a> `levels?`
- **Type:** <a href="#Levels">Levels</a>
#### <a name="Disadvantage/select_options"></a> `select_options?`
- **Type:** <a href="#SelectOptions">SelectOptions</a>
#### <a name="Disadvantage/maximum"></a> `maximum?`
- **Type:** <a href="#Maximum">Maximum</a>
#### <a name="Disadvantage/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#AdvantageDisadvantagePrerequisites">AdvantageDisadvantagePrerequisites</a>
#### <a name="Disadvantage/ap_value"></a> `ap_value`
- **Type:** <a href="#AdventurePointsValue">AdventurePointsValue</a>
#### <a name="Disadvantage/has_maximum_spent_influence"></a> `has_maximum_spent_influence`
Does this disadvantage count towards the maximum of AP to be spent on disadvantages?
- **Type:** Boolean
#### <a name="Disadvantage/is_exclusive_to_arcane_spellworks"></a> `is_exclusive_to_arcane_spellworks`
Does this disadvantage exclusively applies to arcane spellworks and not to magical actions and magical applications?
- **Type:** Boolean
#### <a name="Disadvantage/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Disadvantage/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#DisadvantageTranslation">DisadvantageTranslation</a>&gt;
---
### <a name="DisadvantageTranslation"></a> `DisadvantageTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | | <a href="#DisadvantageTranslation/name">See details</a>
`name_in_library?` | | <a href="#DisadvantageTranslation/name_in_library">See details</a>
`input?` | A string that is used as a label for an input field. | <a href="#DisadvantageTranslation/input">See details</a>
`rules` | | <a href="#DisadvantageTranslation/rules">See details</a>
`range?` | The range. | <a href="#DisadvantageTranslation/range">See details</a>
`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 href="#DisadvantageTranslation/ap_value_append">See details</a>
`errata?` | | <a href="#DisadvantageTranslation/errata">See details</a>
#### <a name="DisadvantageTranslation/name"></a> `name`
- **Type:** <a href="#Name">Name</a>
#### <a name="DisadvantageTranslation/name_in_library"></a> `name_in_library?`
- **Type:** <a href="#NameInLibrary">NameInLibrary</a>
#### <a name="DisadvantageTranslation/input"></a> `input?`
A string that is used as a label for an input field.
- **Type:** <a href="#Input">Input</a>
#### <a name="DisadvantageTranslation/rules"></a> `rules`
- **Type:** <a href="#Rules">Rules</a>
#### <a name="DisadvantageTranslation/range"></a> `range?`
The range.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="DisadvantageTranslation/ap_value_append"></a> `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.
- **Type:** <a href="#AdventurePointsValueAppend">AdventurePointsValueAppend</a>
#### <a name="DisadvantageTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Disease.md
-60
View File
@@ -1,60 +0,0 @@
# Disease
## Definitions
### <a name="Disease"></a> Disease (`Disease`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The disease's identifier. An unique, increasing integer. | <a href="#Disease/id">See details</a>
`level` | The disease's level. | <a href="#Disease/level">See details</a>
`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. | <a href="#Disease/resistance">See details</a>
`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. | <a href="#Disease/cause">See details</a>
`src` | | <a href="#Disease/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Disease/translations">See details</a>
#### <a name="Disease/id"></a> `id`
The disease's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Disease/level"></a> `level`
The disease's level.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Disease/resistance"></a> `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.
- **Type:** <a href="./_DiseasePoison.md#Resistance">Resistance</a>
#### <a name="Disease/cause"></a> `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.
- **Type:** List
- **Items:** <a href="#Disease/cause[]">Disease/cause[]</a>
- **Minimum Items:** `1`
#### <a name="Disease/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Disease/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_DiseasePoison.md#DiseaseTranslation">DiseaseTranslation</a>&gt;
---
### <a name="Disease/cause[]"></a> `Disease/cause[]`
- **Type:** <a href="./_DiseasePoison.md#Cause">Cause</a>
docs/reference/Element.md
-42
View File
@@ -1,42 +0,0 @@
# Element
## Definitions
### <a name="Element"></a> Element (`Element`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The element's identifier. An unique, increasing integer. | <a href="#Element/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Element/translations">See details</a>
#### <a name="Element/id"></a> `id`
The element's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Element/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ElementTranslation">ElementTranslation</a>&gt;
---
### <a name="ElementTranslation"></a> `ElementTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The element's name. | <a href="#ElementTranslation/name">See details</a>
#### <a name="ElementTranslation/name"></a> `name`
The element's name.
- **Type:** String
- **Minimum Length:** `1`
docs/reference/ExperienceLevel.md
-95
View File
@@ -1,95 +0,0 @@
# Experience Level
Adventure Points and maximum values at hero creation.
## Definitions
### <a name="ExperienceLevel"></a> Experience Level (`ExperienceLevel`)
Adventure Points and maximum values at hero creation.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | An unique, increasing integer. | <a href="#ExperienceLevel/id">See details</a>
`adventure_points` | The AP value you get. | <a href="#ExperienceLevel/adventure_points">See details</a>
`max_attribute_value` | The highest possible attribute value. | <a href="#ExperienceLevel/max_attribute_value">See details</a>
`max_skill_rating` | The highest possible skill rating. | <a href="#ExperienceLevel/max_skill_rating">See details</a>
`max_combat_technique_rating` | The highest possible combat technique rating. | <a href="#ExperienceLevel/max_combat_technique_rating">See details</a>
`max_attribute_total` | The limit for the sum of all attribute values. | <a href="#ExperienceLevel/max_attribute_total">See details</a>
`max_number_of_spells_liturgical_chants` | The maximum of spells/chants you can activate. | <a href="#ExperienceLevel/max_number_of_spells_liturgical_chants">See details</a>
`max_number_of_unfamiliar_spells` | The maximum of spells of an unfamiliar tradition you can activate. | <a href="#ExperienceLevel/max_number_of_unfamiliar_spells">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#ExperienceLevel/translations">See details</a>
#### <a name="ExperienceLevel/id"></a> `id`
An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="ExperienceLevel/adventure_points"></a> `adventure_points`
The AP value you get.
- **Type:** Integer
#### <a name="ExperienceLevel/max_attribute_value"></a> `max_attribute_value`
The highest possible attribute value.
- **Type:** Integer
#### <a name="ExperienceLevel/max_skill_rating"></a> `max_skill_rating`
The highest possible skill rating.
- **Type:** Integer
#### <a name="ExperienceLevel/max_combat_technique_rating"></a> `max_combat_technique_rating`
The highest possible combat technique rating.
- **Type:** Integer
#### <a name="ExperienceLevel/max_attribute_total"></a> `max_attribute_total`
The limit for the sum of all attribute values.
- **Type:** Integer
#### <a name="ExperienceLevel/max_number_of_spells_liturgical_chants"></a> `max_number_of_spells_liturgical_chants`
The maximum of spells/chants you can activate.
- **Type:** Integer
#### <a name="ExperienceLevel/max_number_of_unfamiliar_spells"></a> `max_number_of_unfamiliar_spells`
The maximum of spells of an unfamiliar tradition you can activate.
- **Type:** Integer
#### <a name="ExperienceLevel/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ExperienceLevelTranslation">ExperienceLevelTranslation</a>&gt;
---
### <a name="ExperienceLevelTranslation"></a> `ExperienceLevelTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the experience level. | <a href="#ExperienceLevelTranslation/name">See details</a>
#### <a name="ExperienceLevelTranslation/name"></a> `name`
The name of the experience level.
- **Type:** String
- **Minimum Length:** `1`
docs/reference/EyeColor.md
-41
View File
@@ -1,41 +0,0 @@
# Eye Color
## Definitions
### <a name="EyeColor"></a> Eye Color (`EyeColor`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The eye color's identifier. An unique, increasing integer. | <a href="#EyeColor/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#EyeColor/translations">See details</a>
#### <a name="EyeColor/id"></a> `id`
The eye color's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="EyeColor/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#EyeColorTranslation">EyeColorTranslation</a>&gt;
---
### <a name="EyeColorTranslation"></a> `EyeColorTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The eye color. | <a href="#EyeColorTranslation/name">See details</a>
#### <a name="EyeColorTranslation/name"></a> `name`
The eye color.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/FamiliarsTrick.md
-689
View File
@@ -1,689 +0,0 @@
# Familiar's Trick
## Definitions
### <a name="FamiliarsTrick"></a> Familiar's Trick (`FamiliarsTrick`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The familiar's trick's identifier. An unique, increasing integer. | <a href="#FamiliarsTrick/id">See details</a>
`animal_types` | The animal types this trick is available to. Either it is available to all or only a list of specific animal types. | <a href="#FamiliarsTrick/animal_types">See details</a>
`parameters` | Measurable parameters of a familiar's trick. | <a href="#FamiliarsTrick/parameters">See details</a>
`property` | The property of the trick. | <a href="#FamiliarsTrick/property">See details</a>
`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. | <a href="#FamiliarsTrick/ap_value">See details</a>
`src` | | <a href="#FamiliarsTrick/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FamiliarsTrick/translations">See details</a>
#### <a name="FamiliarsTrick/id"></a> `id`
The familiar's trick's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrick/animal_types"></a> `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.
- **Type:** List
- **Items:** <a href="#FamiliarsTrick/animal_types[]">FamiliarsTrick/animal_types[]</a>
#### <a name="FamiliarsTrick/parameters"></a> `parameters`
Measurable parameters of a familiar's trick.
- **Type:** <a href="#FamiliarsTrickPerformanceParameters">FamiliarsTrickPerformanceParameters</a>
#### <a name="FamiliarsTrick/property"></a> `property`
The property of the trick.
- **Type:** <a href="#FamiliarsTrickProperty">FamiliarsTrickProperty</a>
#### <a name="FamiliarsTrick/ap_value"></a> `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.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrick/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="FamiliarsTrick/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FamiliarsTrickTranslation">FamiliarsTrickTranslation</a>&gt;
---
### <a name="FamiliarsTrick/animal_types[]"></a> `FamiliarsTrick/animal_types[]`
- **Type:** <a href="./_SimpleReferences.md#AnimalTypeReference">AnimalTypeReference</a>
---
### <a name="FamiliarsTrickProperty"></a> `FamiliarsTrickProperty`
- **Type:** Union
- **Cases:** <a href="#FamiliarsTrickProperty'Fixed">FamiliarsTrickProperty'Fixed</a> | <a href="#FamiliarsTrickProperty'Indefinite">FamiliarsTrickProperty'Indefinite</a>
---
### <a name="FamiliarsTrickProperty'Fixed"></a> `FamiliarsTrickProperty'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickProperty'Fixed/tag">See details</a>
`fixed` | | <a href="#FamiliarsTrickProperty'Fixed/fixed">See details</a>
#### <a name="FamiliarsTrickProperty'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="FamiliarsTrickProperty'Fixed/fixed"></a> `fixed`
- **Type:** <a href="./_SimpleReferences.md#PropertyReference">PropertyReference</a>
---
### <a name="FamiliarsTrickProperty'Indefinite"></a> `FamiliarsTrickProperty'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickProperty'Indefinite/tag">See details</a>
`indefinite` | | <a href="#FamiliarsTrickProperty'Indefinite/indefinite">See details</a>
#### <a name="FamiliarsTrickProperty'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="FamiliarsTrickProperty'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#IndefiniteFamiliarsTrickProperty">IndefiniteFamiliarsTrickProperty</a>
---
### <a name="IndefiniteFamiliarsTrickProperty"></a> `IndefiniteFamiliarsTrickProperty`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IndefiniteFamiliarsTrickProperty/translations">See details</a>
#### <a name="IndefiniteFamiliarsTrickProperty/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#IndefiniteFamiliarsTrickPropertyTranslation">IndefiniteFamiliarsTrickPropertyTranslation</a>&gt;
---
### <a name="IndefiniteFamiliarsTrickPropertyTranslation"></a> `IndefiniteFamiliarsTrickPropertyTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the property. | <a href="#IndefiniteFamiliarsTrickPropertyTranslation/description">See details</a>
#### <a name="IndefiniteFamiliarsTrickPropertyTranslation/description"></a> `description`
A description of the property.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="FamiliarsTrickTranslation"></a> `FamiliarsTrickTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the familiar's trick. | <a href="#FamiliarsTrickTranslation/name">See details</a>
`effect` | The effect description. | <a href="#FamiliarsTrickTranslation/effect">See details</a>
`cost` | | <a href="#FamiliarsTrickTranslation/cost">See details</a>
`duration` | | <a href="#FamiliarsTrickTranslation/duration">See details</a>
`errata?` | | <a href="#FamiliarsTrickTranslation/errata">See details</a>
#### <a name="FamiliarsTrickTranslation/name"></a> `name`
The name of the familiar's trick.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="FamiliarsTrickTranslation/effect"></a> `effect`
The effect description.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="FamiliarsTrickTranslation/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="FamiliarsTrickTranslation/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="FamiliarsTrickTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="FamiliarsTrickPerformanceParameters"></a> `FamiliarsTrickPerformanceParameters`
Measurable parameters of a familiar's trick.
- **Type:** Union
- **Cases:** <a href="#FamiliarsTrickPerformanceParameters'OneTime">FamiliarsTrickPerformanceParameters'OneTime</a> | <a href="#FamiliarsTrickPerformanceParameters'OneTimeInterval">FamiliarsTrickPerformanceParameters'OneTimeInterval</a> | <a href="#FamiliarsTrickPerformanceParameters'Sustained">FamiliarsTrickPerformanceParameters'Sustained</a>
---
### <a name="FamiliarsTrickPerformanceParameters'OneTime"></a> `FamiliarsTrickPerformanceParameters'OneTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickPerformanceParameters'OneTime/tag">See details</a>
`one_time` | | <a href="#FamiliarsTrickPerformanceParameters'OneTime/one_time">See details</a>
#### <a name="FamiliarsTrickPerformanceParameters'OneTime/tag"></a> `tag`
- **Constant:** `"OneTime"`
#### <a name="FamiliarsTrickPerformanceParameters'OneTime/one_time"></a> `one_time`
- **Type:** <a href="#FamiliarsTrickOneTimePerformanceParameters">FamiliarsTrickOneTimePerformanceParameters</a>
---
### <a name="FamiliarsTrickPerformanceParameters'OneTimeInterval"></a> `FamiliarsTrickPerformanceParameters'OneTimeInterval`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickPerformanceParameters'OneTimeInterval/tag">See details</a>
`one_time_interval` | | <a href="#FamiliarsTrickPerformanceParameters'OneTimeInterval/one_time_interval">See details</a>
#### <a name="FamiliarsTrickPerformanceParameters'OneTimeInterval/tag"></a> `tag`
- **Constant:** `"OneTimeInterval"`
#### <a name="FamiliarsTrickPerformanceParameters'OneTimeInterval/one_time_interval"></a> `one_time_interval`
- **Type:** <a href="#FamiliarsTrickOneTimeIntervalPerformanceParameters">FamiliarsTrickOneTimeIntervalPerformanceParameters</a>
---
### <a name="FamiliarsTrickPerformanceParameters'Sustained"></a> `FamiliarsTrickPerformanceParameters'Sustained`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickPerformanceParameters'Sustained/tag">See details</a>
`sustained` | | <a href="#FamiliarsTrickPerformanceParameters'Sustained/sustained">See details</a>
#### <a name="FamiliarsTrickPerformanceParameters'Sustained/tag"></a> `tag`
- **Constant:** `"Sustained"`
#### <a name="FamiliarsTrickPerformanceParameters'Sustained/sustained"></a> `sustained`
- **Type:** <a href="#FamiliarsTrickSustainedPerformanceParameters">FamiliarsTrickSustainedPerformanceParameters</a>
---
### <a name="FamiliarsTrickOneTimePerformanceParameters"></a> `FamiliarsTrickOneTimePerformanceParameters`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | | <a href="#FamiliarsTrickOneTimePerformanceParameters/cost">See details</a>
`duration` | | <a href="#FamiliarsTrickOneTimePerformanceParameters/duration">See details</a>
#### <a name="FamiliarsTrickOneTimePerformanceParameters/cost"></a> `cost`
- **Type:** <a href="#FamiliarsTrickOneTimeCost">FamiliarsTrickOneTimeCost</a>
#### <a name="FamiliarsTrickOneTimePerformanceParameters/duration"></a> `duration`
- **Type:** <a href="#FamiliarsTrickOneTimeDuration">FamiliarsTrickOneTimeDuration</a>
---
### <a name="FamiliarsTrickOneTimeCost"></a> `FamiliarsTrickOneTimeCost`
- **Type:** Union
- **Cases:** <a href="#FamiliarsTrickOneTimeCost'Fixed">FamiliarsTrickOneTimeCost'Fixed</a> | <a href="#FamiliarsTrickOneTimeCost'All">FamiliarsTrickOneTimeCost'All</a> | <a href="#FamiliarsTrickOneTimeCost'Indefinite">FamiliarsTrickOneTimeCost'Indefinite</a>
---
### <a name="FamiliarsTrickOneTimeCost'Fixed"></a> `FamiliarsTrickOneTimeCost'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeCost'Fixed/tag">See details</a>
`fixed` | | <a href="#FamiliarsTrickOneTimeCost'Fixed/fixed">See details</a>
#### <a name="FamiliarsTrickOneTimeCost'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="FamiliarsTrickOneTimeCost'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FamiliarsTrickFixedOneTimeCost">FamiliarsTrickFixedOneTimeCost</a>
---
### <a name="FamiliarsTrickOneTimeCost'All"></a> `FamiliarsTrickOneTimeCost'All`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeCost'All/tag">See details</a>
`all` | | <a href="#FamiliarsTrickOneTimeCost'All/all">See details</a>
#### <a name="FamiliarsTrickOneTimeCost'All/tag"></a> `tag`
- **Constant:** `"All"`
#### <a name="FamiliarsTrickOneTimeCost'All/all"></a> `all`
- **Type:** <a href="#FamiliarsTrickAllOneTimeCost">FamiliarsTrickAllOneTimeCost</a>
---
### <a name="FamiliarsTrickOneTimeCost'Indefinite"></a> `FamiliarsTrickOneTimeCost'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeCost'Indefinite/tag">See details</a>
`indefinite` | | <a href="#FamiliarsTrickOneTimeCost'Indefinite/indefinite">See details</a>
#### <a name="FamiliarsTrickOneTimeCost'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="FamiliarsTrickOneTimeCost'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#FamiliarsTrickIndefiniteOneTimeCost">FamiliarsTrickIndefiniteOneTimeCost</a>
---
### <a name="FamiliarsTrickFixedOneTimeCost"></a> `FamiliarsTrickFixedOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`ae_value` | The AE cost value. | <a href="#FamiliarsTrickFixedOneTimeCost/ae_value">See details</a>
`lp_value?` | The LP cost value. | <a href="#FamiliarsTrickFixedOneTimeCost/lp_value">See details</a>
`interval?` | The interval in which you have to pay the AE cost again. | <a href="#FamiliarsTrickFixedOneTimeCost/interval">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FamiliarsTrickFixedOneTimeCost/translations">See details</a>
#### <a name="FamiliarsTrickFixedOneTimeCost/ae_value"></a> `ae_value`
The AE cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickFixedOneTimeCost/lp_value"></a> `lp_value?`
The LP cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickFixedOneTimeCost/interval"></a> `interval?`
The interval in which you have to pay the AE cost again.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnitValue">DurationUnitValue</a>
#### <a name="FamiliarsTrickFixedOneTimeCost/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag
(BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FamiliarsTrickFixedOneTimeCostTranslation">FamiliarsTrickFixedOneTimeCostTranslation</a>&gt;
---
### <a name="FamiliarsTrickFixedOneTimeCostTranslation"></a> `FamiliarsTrickFixedOneTimeCostTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`per?` | The cost have to be per a specific countable entity, e.g. `8 KP per person`. | <a href="#FamiliarsTrickFixedOneTimeCostTranslation/per">See details</a>
#### <a name="FamiliarsTrickFixedOneTimeCostTranslation/per"></a> `per?`
The cost have to be per a specific countable entity, e.g. `8 KP per person`.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextOptional">ResponsiveTextOptional</a>
---
### <a name="FamiliarsTrickAllOneTimeCost"></a> `FamiliarsTrickAllOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`minimum?` | The minimum AE the familiar has to have. | <a href="#FamiliarsTrickAllOneTimeCost/minimum">See details</a>
#### <a name="FamiliarsTrickAllOneTimeCost/minimum"></a> `minimum?`
The minimum AE the familiar has to have.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="FamiliarsTrickIndefiniteOneTimeCost"></a> `FamiliarsTrickIndefiniteOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FamiliarsTrickIndefiniteOneTimeCost/translations">See details</a>
#### <a name="FamiliarsTrickIndefiniteOneTimeCost/translations"></a> `translations`
All translations for the entry, identified by IETF language tag
(BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FamiliarsTrickIndefiniteOneTimeCostTranslation">FamiliarsTrickIndefiniteOneTimeCostTranslation</a>&gt;
---
### <a name="FamiliarsTrickIndefiniteOneTimeCostTranslation"></a> `FamiliarsTrickIndefiniteOneTimeCostTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the AE cost. | <a href="#FamiliarsTrickIndefiniteOneTimeCostTranslation/description">See details</a>
#### <a name="FamiliarsTrickIndefiniteOneTimeCostTranslation/description"></a> `description`
A description of the AE cost.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="FamiliarsTrickOneTimeDuration"></a> `FamiliarsTrickOneTimeDuration`
- **Type:** Union
- **Cases:** <a href="#FamiliarsTrickOneTimeDuration'Immediate">FamiliarsTrickOneTimeDuration'Immediate</a> | <a href="#FamiliarsTrickOneTimeDuration'Fixed">FamiliarsTrickOneTimeDuration'Fixed</a> | <a href="#FamiliarsTrickOneTimeDuration'Indefinite">FamiliarsTrickOneTimeDuration'Indefinite</a>
---
### <a name="FamiliarsTrickOneTimeDuration'Immediate"></a> `FamiliarsTrickOneTimeDuration'Immediate`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeDuration'Immediate/tag">See details</a>
`immediate` | | <a href="#FamiliarsTrickOneTimeDuration'Immediate/immediate">See details</a>
#### <a name="FamiliarsTrickOneTimeDuration'Immediate/tag"></a> `tag`
- **Constant:** `"Immediate"`
#### <a name="FamiliarsTrickOneTimeDuration'Immediate/immediate"></a> `immediate`
- **Type:** <a href="#FamiliarsTrickOneTimeDuration'Immediate/immediate">Object</a>
---
### <a name="FamiliarsTrickOneTimeDuration'Immediate/immediate"></a> `FamiliarsTrickOneTimeDuration'Immediate/immediate`
- **Type:** Empty Object
---
### <a name="FamiliarsTrickOneTimeDuration'Fixed"></a> `FamiliarsTrickOneTimeDuration'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeDuration'Fixed/tag">See details</a>
`fixed` | | <a href="#FamiliarsTrickOneTimeDuration'Fixed/fixed">See details</a>
#### <a name="FamiliarsTrickOneTimeDuration'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="FamiliarsTrickOneTimeDuration'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FamiliarsTrickFixedOneTimeDuration">FamiliarsTrickFixedOneTimeDuration</a>
---
### <a name="FamiliarsTrickOneTimeDuration'Indefinite"></a> `FamiliarsTrickOneTimeDuration'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FamiliarsTrickOneTimeDuration'Indefinite/tag">See details</a>
`indefinite` | | <a href="#FamiliarsTrickOneTimeDuration'Indefinite/indefinite">See details</a>
#### <a name="FamiliarsTrickOneTimeDuration'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="FamiliarsTrickOneTimeDuration'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#FamiliarsTrickIndefiniteOneTimeDuration">FamiliarsTrickIndefiniteOneTimeDuration</a>
---
### <a name="FamiliarsTrickFixedOneTimeDuration"></a> `FamiliarsTrickFixedOneTimeDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If the duration is the maximum duration, so it may end earlier. | <a href="#FamiliarsTrickFixedOneTimeDuration/is_maximum">See details</a>
`value` | The (unitless) duration. | <a href="#FamiliarsTrickFixedOneTimeDuration/value">See details</a>
`unit` | The duration unit. | <a href="#FamiliarsTrickFixedOneTimeDuration/unit">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FamiliarsTrickFixedOneTimeDuration/translations">See details</a>
#### <a name="FamiliarsTrickFixedOneTimeDuration/is_maximum"></a> `is_maximum?`
If the duration is the maximum duration, so it may end earlier.
- **Type:** Boolean
#### <a name="FamiliarsTrickFixedOneTimeDuration/value"></a> `value`
The (unitless) duration.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickFixedOneTimeDuration/unit"></a> `unit`
The duration unit.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnit">DurationUnit</a>
#### <a name="FamiliarsTrickFixedOneTimeDuration/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FamiliarsTrickFixedOneTimeDurationTranslation">FamiliarsTrickFixedOneTimeDurationTranslation</a>&gt;
---
### <a name="FamiliarsTrickFixedOneTimeDurationTranslation"></a> `FamiliarsTrickFixedOneTimeDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement?` | A replacement string. | <a href="#FamiliarsTrickFixedOneTimeDurationTranslation/replacement">See details</a>
#### <a name="FamiliarsTrickFixedOneTimeDurationTranslation/replacement"></a> `replacement?`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="FamiliarsTrickIndefiniteOneTimeDuration"></a> `FamiliarsTrickIndefiniteOneTimeDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FamiliarsTrickIndefiniteOneTimeDuration/translations">See details</a>
#### <a name="FamiliarsTrickIndefiniteOneTimeDuration/translations"></a> `translations`
All translations for the entry, identified by IETF language tag
(BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FamiliarsTrickIndefiniteOneTimeDurationTranslation">FamiliarsTrickIndefiniteOneTimeDurationTranslation</a>&gt;
---
### <a name="FamiliarsTrickIndefiniteOneTimeDurationTranslation"></a> `FamiliarsTrickIndefiniteOneTimeDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the duration. | <a href="#FamiliarsTrickIndefiniteOneTimeDurationTranslation/description">See details</a>
#### <a name="FamiliarsTrickIndefiniteOneTimeDurationTranslation/description"></a> `description`
A description of the duration.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="FamiliarsTrickOneTimeIntervalPerformanceParameters"></a> `FamiliarsTrickOneTimeIntervalPerformanceParameters`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | | <a href="#FamiliarsTrickOneTimeIntervalPerformanceParameters/cost">See details</a>
#### <a name="FamiliarsTrickOneTimeIntervalPerformanceParameters/cost"></a> `cost`
- **Type:** <a href="#FamiliarsTrickOneTimeIntervalCost">FamiliarsTrickOneTimeIntervalCost</a>
---
### <a name="FamiliarsTrickOneTimeIntervalCost"></a> `FamiliarsTrickOneTimeIntervalCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`ae_value` | The AE cost value. | <a href="#FamiliarsTrickOneTimeIntervalCost/ae_value">See details</a>
`lp_value?` | The LP cost value. | <a href="#FamiliarsTrickOneTimeIntervalCost/lp_value">See details</a>
`interval` | The duration granted/added by paying the given AE cost. | <a href="#FamiliarsTrickOneTimeIntervalCost/interval">See details</a>
#### <a name="FamiliarsTrickOneTimeIntervalCost/ae_value"></a> `ae_value`
The AE cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickOneTimeIntervalCost/lp_value"></a> `lp_value?`
The LP cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickOneTimeIntervalCost/interval"></a> `interval`
The duration granted/added by paying the given AE cost.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnitValue">DurationUnitValue</a>
---
### <a name="FamiliarsTrickSustainedPerformanceParameters"></a> `FamiliarsTrickSustainedPerformanceParameters`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | | <a href="#FamiliarsTrickSustainedPerformanceParameters/cost">See details</a>
#### <a name="FamiliarsTrickSustainedPerformanceParameters/cost"></a> `cost`
- **Type:** <a href="#FamiliarsTrickSustainedCost">FamiliarsTrickSustainedCost</a>
---
### <a name="FamiliarsTrickSustainedCost"></a> `FamiliarsTrickSustainedCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`ae_value` | The AE cost value. | <a href="#FamiliarsTrickSustainedCost/ae_value">See details</a>
`lp_value?` | The LP cost value. | <a href="#FamiliarsTrickSustainedCost/lp_value">See details</a>
`interval?` | The interval in which you have to pay the AE cost again, if any. | <a href="#FamiliarsTrickSustainedCost/interval">See details</a>
#### <a name="FamiliarsTrickSustainedCost/ae_value"></a> `ae_value`
The AE cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickSustainedCost/lp_value"></a> `lp_value?`
The LP cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FamiliarsTrickSustainedCost/interval"></a> `interval?`
The interval in which you have to pay the AE cost again, if any.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnitValue">DurationUnitValue</a>
docs/reference/HairColor.md
-41
View File
@@ -1,41 +0,0 @@
# Hair Color
## Definitions
### <a name="HairColor"></a> Hair Color (`HairColor`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The hair color's identifier. An unique, increasing integer. | <a href="#HairColor/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#HairColor/translations">See details</a>
#### <a name="HairColor/id"></a> `id`
The hair color's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="HairColor/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#HairColorTranslation">HairColorTranslation</a>&gt;
---
### <a name="HairColorTranslation"></a> `HairColorTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The hair color. | <a href="#HairColorTranslation/name">See details</a>
#### <a name="HairColorTranslation/name"></a> `name`
The hair color.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Kirchenpraegung.md
-7
View File
@@ -1,7 +0,0 @@
# Kirchenprägung
## Definitions
### <a name="Kirchenpraegung"></a> Kirchenprägung (`Kirchenpraegung`)
- **Type:** <a href="./_Influence.md#Influence">Influence</a>
docs/reference/Lessons_Curriculum.md
-645
View File
@@ -1,645 +0,0 @@
# 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.
## Definitions
### <a name="Curriculum"></a> 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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The curriculum's identifier. An unique, increasing integer. | <a href="#Curriculum/id">See details</a>
`guideline` | The institution's guideline. | <a href="#Curriculum/guideline">See details</a>
`elective_spellworks?` | The academy's elective spellworks package. | <a href="#Curriculum/elective_spellworks">See details</a>
`restricted_spellworks?` | The academy's restricted spellworks package. | <a href="#Curriculum/restricted_spellworks">See details</a>
`lesson_packages` | A list of available lesson packages. | <a href="#Curriculum/lesson_packages">See details</a>
`src` | | <a href="#Curriculum/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Curriculum/translations">See details</a>
#### <a name="Curriculum/id"></a> `id`
The curriculum's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Curriculum/guideline"></a> `guideline`
The institution's guideline.
- **Type:** <a href="./_SimpleReferences.md#GuidelineReference">GuidelineReference</a>
#### <a name="Curriculum/elective_spellworks"></a> `elective_spellworks?`
The academy's elective spellworks package.
- **Type:** <a href="#ElectiveSpellworks">ElectiveSpellworks</a>
#### <a name="Curriculum/restricted_spellworks"></a> `restricted_spellworks?`
The academy's restricted spellworks package.
- **Type:** <a href="#RestrictedSpellworks">RestrictedSpellworks</a>
#### <a name="Curriculum/lesson_packages"></a> `lesson_packages`
A list of available lesson packages.
- **Type:** <a href="#LessonPackages">LessonPackages</a>
#### <a name="Curriculum/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Curriculum/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CurriculumTranslation">CurriculumTranslation</a>&gt;
---
### <a name="CurriculumTranslation"></a> `CurriculumTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the academy. | <a href="#CurriculumTranslation/name">See details</a>
`errata?` | | <a href="#CurriculumTranslation/errata">See details</a>
#### <a name="CurriculumTranslation/name"></a> `name`
The name of the academy.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CurriculumTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="ElectiveSpellworks"></a> `ElectiveSpellworks`
The academy's elective spellworks package.
- **Type:** Union
- **Cases:** <a href="#ElectiveSpellworks'DefinedByGameMaster">ElectiveSpellworks'DefinedByGameMaster</a> | <a href="#ElectiveSpellworks'Specific">ElectiveSpellworks'Specific</a>
---
### <a name="ElectiveSpellworks'DefinedByGameMaster"></a> `ElectiveSpellworks'DefinedByGameMaster`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ElectiveSpellworks'DefinedByGameMaster/tag">See details</a>
`defined_by_game_master` | | <a href="#ElectiveSpellworks'DefinedByGameMaster/defined_by_game_master">See details</a>
#### <a name="ElectiveSpellworks'DefinedByGameMaster/tag"></a> `tag`
- **Constant:** `"DefinedByGameMaster"`
#### <a name="ElectiveSpellworks'DefinedByGameMaster/defined_by_game_master"></a> `defined_by_game_master`
- **Type:** <a href="#ElectiveSpellworks'DefinedByGameMaster/defined_by_game_master">Object</a>
---
### <a name="ElectiveSpellworks'DefinedByGameMaster/defined_by_game_master"></a> `ElectiveSpellworks'DefinedByGameMaster/defined_by_game_master`
- **Type:** Empty Object
---
### <a name="ElectiveSpellworks'Specific"></a> `ElectiveSpellworks'Specific`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ElectiveSpellworks'Specific/tag">See details</a>
`specific` | | <a href="#ElectiveSpellworks'Specific/specific">See details</a>
#### <a name="ElectiveSpellworks'Specific/tag"></a> `tag`
- **Constant:** `"Specific"`
#### <a name="ElectiveSpellworks'Specific/specific"></a> `specific`
- **Type:** <a href="#SpecificElectiveSpellworks">SpecificElectiveSpellworks</a>
---
### <a name="SpecificElectiveSpellworks"></a> `SpecificElectiveSpellworks`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`list` | | <a href="#SpecificElectiveSpellworks/list">See details</a>
#### <a name="SpecificElectiveSpellworks/list"></a> `list`
- **Type:** List
- **Items:** <a href="#SpecificElectiveSpellworks/list[]">SpecificElectiveSpellworks/list[]</a>
- **Minimum Items:** `1`
---
### <a name="SpecificElectiveSpellworks/list[]"></a> `SpecificElectiveSpellworks/list[]`
- **Type:** <a href="#ElectiveSpellwork">ElectiveSpellwork</a>
---
### <a name="ElectiveSpellwork"></a> `ElectiveSpellwork`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ElectiveSpellwork/id">See details</a>
`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. | <a href="#ElectiveSpellwork/restriction">See details</a>
#### <a name="ElectiveSpellwork/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#SpellworkIdentifier">SpellworkIdentifier</a>
#### <a name="ElectiveSpellwork/restriction"></a> `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.
- **Type:** <a href="#ElectiveSpellworkRestriction">ElectiveSpellworkRestriction</a>
---
### <a name="ElectiveSpellworkRestriction"></a> `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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ElectiveSpellworkRestriction/tag">See details</a>
`element` | | <a href="#ElectiveSpellworkRestriction/element">See details</a>
#### <a name="ElectiveSpellworkRestriction/tag"></a> `tag`
- **Constant:** `"Element"`
#### <a name="ElectiveSpellworkRestriction/element"></a> `element`
- **Type:** <a href="#ElectiveSpellworkElementRestriction">ElectiveSpellworkElementRestriction</a>
---
### <a name="ElectiveSpellworkElementRestriction"></a> `ElectiveSpellworkElementRestriction`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ElectiveSpellworkElementRestriction/id">See details</a>
#### <a name="ElectiveSpellworkElementRestriction/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ElementIdentifier">ElementIdentifier</a>
---
### <a name="RestrictedSpellworks"></a> `RestrictedSpellworks`
The academy's restricted spellworks package.
- **Type:** List
- **Items:** <a href="#RestrictedSpellworks[]">RestrictedSpellworks[]</a>
- **Minimum Items:** `1`
---
### <a name="RestrictedSpellworks[]"></a> `RestrictedSpellworks[]`
- **Type:** <a href="#RestrictedSpellwork">RestrictedSpellwork</a>
---
### <a name="RestrictedSpellwork"></a> `RestrictedSpellwork`
The academy's restricted spellworks package.
- **Type:** Union
- **Cases:** <a href="#RestrictedSpellwork'Property">RestrictedSpellwork'Property</a> | <a href="#RestrictedSpellwork'Spellwork">RestrictedSpellwork'Spellwork</a> | <a href="#RestrictedSpellwork'DemonSummoning">RestrictedSpellwork'DemonSummoning</a> | <a href="#RestrictedSpellwork'Borbaradian">RestrictedSpellwork'Borbaradian</a> | <a href="#RestrictedSpellwork'DamageIntelligent">RestrictedSpellwork'DamageIntelligent</a>
---
### <a name="RestrictedSpellwork'Property"></a> `RestrictedSpellwork'Property`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RestrictedSpellwork'Property/tag">See details</a>
`property` | | <a href="#RestrictedSpellwork'Property/property">See details</a>
#### <a name="RestrictedSpellwork'Property/tag"></a> `tag`
- **Constant:** `"Property"`
#### <a name="RestrictedSpellwork'Property/property"></a> `property`
- **Type:** <a href="#RestrictedProperty">RestrictedProperty</a>
---
### <a name="RestrictedSpellwork'Spellwork"></a> `RestrictedSpellwork'Spellwork`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RestrictedSpellwork'Spellwork/tag">See details</a>
`spellwork` | | <a href="#RestrictedSpellwork'Spellwork/spellwork">See details</a>
#### <a name="RestrictedSpellwork'Spellwork/tag"></a> `tag`
- **Constant:** `"Spellwork"`
#### <a name="RestrictedSpellwork'Spellwork/spellwork"></a> `spellwork`
- **Type:** <a href="./_IdentifierGroup.md#SpellworkIdentifier">SpellworkIdentifier</a>
---
### <a name="RestrictedSpellwork'DemonSummoning"></a> `RestrictedSpellwork'DemonSummoning`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RestrictedSpellwork'DemonSummoning/tag">See details</a>
`demon_summoning` | | <a href="#RestrictedSpellwork'DemonSummoning/demon_summoning">See details</a>
#### <a name="RestrictedSpellwork'DemonSummoning/tag"></a> `tag`
- **Constant:** `"DemonSummoning"`
#### <a name="RestrictedSpellwork'DemonSummoning/demon_summoning"></a> `demon_summoning`
- **Type:** <a href="#RestrictedSpellwork'DemonSummoning/demon_summoning">Object</a>
---
### <a name="RestrictedSpellwork'DemonSummoning/demon_summoning"></a> `RestrictedSpellwork'DemonSummoning/demon_summoning`
- **Type:** Empty Object
---
### <a name="RestrictedSpellwork'Borbaradian"></a> `RestrictedSpellwork'Borbaradian`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RestrictedSpellwork'Borbaradian/tag">See details</a>
`borbaradian` | | <a href="#RestrictedSpellwork'Borbaradian/borbaradian">See details</a>
#### <a name="RestrictedSpellwork'Borbaradian/tag"></a> `tag`
- **Constant:** `"Borbaradian"`
#### <a name="RestrictedSpellwork'Borbaradian/borbaradian"></a> `borbaradian`
- **Type:** <a href="#RestrictedSpellwork'Borbaradian/borbaradian">Object</a>
---
### <a name="RestrictedSpellwork'Borbaradian/borbaradian"></a> `RestrictedSpellwork'Borbaradian/borbaradian`
- **Type:** Empty Object
---
### <a name="RestrictedSpellwork'DamageIntelligent"></a> `RestrictedSpellwork'DamageIntelligent`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RestrictedSpellwork'DamageIntelligent/tag">See details</a>
`damage_intelligent` | | <a href="#RestrictedSpellwork'DamageIntelligent/damage_intelligent">See details</a>
#### <a name="RestrictedSpellwork'DamageIntelligent/tag"></a> `tag`
- **Constant:** `"DamageIntelligent"`
#### <a name="RestrictedSpellwork'DamageIntelligent/damage_intelligent"></a> `damage_intelligent`
- **Type:** <a href="#RestrictedSpellwork'DamageIntelligent/damage_intelligent">Object</a>
---
### <a name="RestrictedSpellwork'DamageIntelligent/damage_intelligent"></a> `RestrictedSpellwork'DamageIntelligent/damage_intelligent`
- **Type:** Empty Object
---
### <a name="RestrictedProperty"></a> `RestrictedProperty`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The identifier of the property that spellworks are disallowed from. | <a href="#RestrictedProperty/id">See details</a>
`exclude?` | Exclude specific spellworks from the restriction. | <a href="#RestrictedProperty/exclude">See details</a>
`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. | <a href="#RestrictedProperty/maximum">See details</a>
#### <a name="RestrictedProperty/id"></a> `id`
The identifier of the property that spellworks are disallowed from.
- **Type:** <a href="./_Identifier.md#PropertyIdentifier">PropertyIdentifier</a>
#### <a name="RestrictedProperty/exclude"></a> `exclude?`
Exclude specific spellworks from the restriction.
- **Type:** List
- **Items:** <a href="#RestrictedProperty/exclude[]">RestrictedProperty/exclude[]</a>
- **Minimum Items:** `1`
#### <a name="RestrictedProperty/maximum"></a> `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
---
### <a name="RestrictedProperty/exclude[]"></a> `RestrictedProperty/exclude[]`
- **Type:** <a href="./_IdentifierGroup.md#SpellworkIdentifier">SpellworkIdentifier</a>
---
### <a name="LessonPackages"></a> `LessonPackages`
A list of available lesson packages.
- **Type:** List
- **Items:** <a href="#LessonPackages[]">LessonPackages[]</a>
- **Minimum Items:** `2`
- **Maximum Items:** `2`
---
### <a name="LessonPackages[]"></a> `LessonPackages[]`
- **Type:** <a href="#LessonPackage">LessonPackage</a>
---
### <a name="LessonPackage"></a> Lesson Package (`LessonPackage`)
- **Type:** Object
- **Minimum Properties:** `3`
Key | Description | Details
:-- | :-- | :--
`id` | The lesson package's identifier. An unique, increasing integer. | <a href="#LessonPackage/id">See details</a>
`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. | <a href="#LessonPackage/spellwork_changes">See details</a>
`skills?` | | <a href="#LessonPackage/skills">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#LessonPackage/translations">See details</a>
#### <a name="LessonPackage/id"></a> `id`
The lesson package's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="LessonPackage/spellwork_changes"></a> `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.
- **Type:** List
- **Items:** <a href="#LessonPackage/spellwork_changes[]">LessonPackage/spellwork_changes[]</a>
- **Minimum Items:** `1`
#### <a name="LessonPackage/skills"></a> `skills?`
- **Type:** List
- **Items:** <a href="#LessonPackage/skills[]">LessonPackage/skills[]</a>
#### <a name="LessonPackage/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#LessonPackageTranslation">LessonPackageTranslation</a>&gt;
---
### <a name="LessonPackage/spellwork_changes[]"></a> `LessonPackage/spellwork_changes[]`
- **Type:** <a href="#SpellworkChange">SpellworkChange</a>
---
### <a name="LessonPackage/skills[]"></a> `LessonPackage/skills[]`
- **Type:** <a href="#AbilityAdjustment">AbilityAdjustment</a>
---
### <a name="SpellworkChange"></a> `SpellworkChange`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`base` | | <a href="#SpellworkChange/base">See details</a>
`replacement` | | <a href="#SpellworkChange/replacement">See details</a>
#### <a name="SpellworkChange/base"></a> `base`
- **Type:** <a href="#SpellworkAdjustment">SpellworkAdjustment</a>
#### <a name="SpellworkChange/replacement"></a> `replacement`
- **Type:** <a href="#SpellworkAdjustment">SpellworkAdjustment</a>
---
### <a name="LessonPackageTranslation"></a> `LessonPackageTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the lesson package. | <a href="#LessonPackageTranslation/name">See details</a>
`spellwork_changes?` | 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. | <a href="#LessonPackageTranslation/spellwork_changes">See details</a>
#### <a name="LessonPackageTranslation/name"></a> `name`
The name of the lesson package.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="LessonPackageTranslation/spellwork_changes"></a> `spellwork_changes?`
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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="AbilityAdjustment"></a> `AbilityAdjustment`
- **Type:** Union
- **Cases:** <a href="#AbilityAdjustment'CombatTechnique">AbilityAdjustment'CombatTechnique</a> | <a href="#AbilityAdjustment'Skill">AbilityAdjustment'Skill</a> | <a href="#AbilityAdjustment'Spellwork">AbilityAdjustment'Spellwork</a>
---
### <a name="AbilityAdjustment'CombatTechnique"></a> `AbilityAdjustment'CombatTechnique`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AbilityAdjustment'CombatTechnique/tag">See details</a>
`combat_technique` | | <a href="#AbilityAdjustment'CombatTechnique/combat_technique">See details</a>
#### <a name="AbilityAdjustment'CombatTechnique/tag"></a> `tag`
- **Constant:** `"CombatTechnique"`
#### <a name="AbilityAdjustment'CombatTechnique/combat_technique"></a> `combat_technique`
- **Type:** <a href="#CombatTechniqueAdjustment">CombatTechniqueAdjustment</a>
---
### <a name="AbilityAdjustment'Skill"></a> `AbilityAdjustment'Skill`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AbilityAdjustment'Skill/tag">See details</a>
`skill` | | <a href="#AbilityAdjustment'Skill/skill">See details</a>
#### <a name="AbilityAdjustment'Skill/tag"></a> `tag`
- **Constant:** `"Skill"`
#### <a name="AbilityAdjustment'Skill/skill"></a> `skill`
- **Type:** <a href="#SkillAdjustment">SkillAdjustment</a>
---
### <a name="AbilityAdjustment'Spellwork"></a> `AbilityAdjustment'Spellwork`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AbilityAdjustment'Spellwork/tag">See details</a>
`spellwork` | | <a href="#AbilityAdjustment'Spellwork/spellwork">See details</a>
#### <a name="AbilityAdjustment'Spellwork/tag"></a> `tag`
- **Constant:** `"Spellwork"`
#### <a name="AbilityAdjustment'Spellwork/spellwork"></a> `spellwork`
- **Type:** <a href="#SpellworkAdjustment">SpellworkAdjustment</a>
---
### <a name="CombatTechniqueAdjustment"></a> `CombatTechniqueAdjustment`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CombatTechniqueAdjustment/id">See details</a>
`points` | The combat technique points that will be added to the current combat technique rating. | <a href="#CombatTechniqueAdjustment/points">See details</a>
#### <a name="CombatTechniqueAdjustment/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#CombatTechniqueIdentifier">CombatTechniqueIdentifier</a>
#### <a name="CombatTechniqueAdjustment/points"></a> `points`
The combat technique points that will be added to the current combat technique rating.
- **Type:** Integer
- **Minimum:** `-6`
- **Maximum:** `6`
---
### <a name="SkillAdjustment"></a> `SkillAdjustment`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill's identifier. | <a href="#SkillAdjustment/id">See details</a>
`points` | The skill points that will be added to the current skill rating. | <a href="#SkillAdjustment/points">See details</a>
#### <a name="SkillAdjustment/id"></a> `id`
The skill's identifier.
- **Type:** <a href="./_Identifier.md#SkillIdentifier">SkillIdentifier</a>
#### <a name="SkillAdjustment/points"></a> `points`
The skill points that will be added to the current skill rating.
- **Type:** Integer
- **Minimum:** `-8`
- **Maximum:** `8`
---
### <a name="SpellworkAdjustment"></a> `SpellworkAdjustment`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SpellworkAdjustment/id">See details</a>
`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. | <a href="#SpellworkAdjustment/points">See details</a>
`tradition?` | The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here. | <a href="#SpellworkAdjustment/tradition">See details</a>
#### <a name="SpellworkAdjustment/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#SpellworkIdentifier">SpellworkIdentifier</a>
#### <a name="SpellworkAdjustment/points"></a> `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.
- **Type:** Integer
- **Minimum:** `-10`
- **Maximum:** `10`
#### <a name="SpellworkAdjustment/tradition"></a> `tradition?`
The target tradition. If the target spell is not from the Guild Mage tradition, specify the tradition identifier here.
- **Type:** <a href="./_Identifier.md#MagicalTraditionIdentifier">MagicalTraditionIdentifier</a>
docs/reference/Lessons_Guideline.md
-49
View File
@@ -1,49 +0,0 @@
# Guideline
## Definitions
### <a name="Guideline"></a> Guideline (`Guideline`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The guideline's identifier. An unique, increasing integer. | <a href="#Guideline/id">See details</a>
`spellwork_changes_allowed` | Maximum number of spells that can be exchanged. | <a href="#Guideline/spellwork_changes_allowed">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Guideline/translations">See details</a>
#### <a name="Guideline/id"></a> `id`
The guideline's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Guideline/spellwork_changes_allowed"></a> `spellwork_changes_allowed`
Maximum number of spells that can be exchanged.
- **Type:** Integer
- **Minimum:** `0`
#### <a name="Guideline/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#GuidelineTranslation">GuidelineTranslation</a>&gt;
---
### <a name="GuidelineTranslation"></a> `GuidelineTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The guideline name. | <a href="#GuidelineTranslation/name">See details</a>
#### <a name="GuidelineTranslation/name"></a> `name`
The guideline name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/LiturgicalChant.md
-150
View File
@@ -1,150 +0,0 @@
# Liturgical Chant
## Definitions
### <a name="LiturgicalChant"></a> Liturgical Chant (`LiturgicalChant`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The liturgical chant's identifier. An unique, increasing integer. | <a href="#LiturgicalChant/id">See details</a>
`check` | Lists the linked three attributes used to make a skill check. | <a href="#LiturgicalChant/check">See details</a>
`check_penalty?` | In some cases, the target's Spirit or Toughness is applied as a penalty. | <a href="#LiturgicalChant/check_penalty">See details</a>
`parameters` | Measurable parameters of a liturgical chant. | <a href="#LiturgicalChant/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#LiturgicalChant/target">See details</a>
`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. | <a href="#LiturgicalChant/traditions">See details</a>
`improvement_cost` | States which column is used to improve the skill. | <a href="#LiturgicalChant/improvement_cost">See details</a>
`prerequisites?` | | <a href="#LiturgicalChant/prerequisites">See details</a>
`src` | | <a href="#LiturgicalChant/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#LiturgicalChant/translations">See details</a>
`enhancements?` | | <a href="#LiturgicalChant/enhancements">See details</a>
#### <a name="LiturgicalChant/id"></a> `id`
The liturgical chant's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="LiturgicalChant/check"></a> `check`
Lists the linked three attributes used to make a skill check.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="LiturgicalChant/check_penalty"></a> `check_penalty?`
In some cases, the target's Spirit or Toughness is applied as a penalty.
- **Type:** <a href="./_SkillCheck.md#SkillCheckPenalty">SkillCheckPenalty</a>
#### <a name="LiturgicalChant/parameters"></a> `parameters`
Measurable parameters of a liturgical chant.
- **Type:** <a href="./_ActivatableSkill.md#FastPerformanceParameters">FastPerformanceParameters</a>
#### <a name="LiturgicalChant/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="LiturgicalChant/traditions"></a> `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.
- **Type:** List
- **Items:** <a href="#LiturgicalChant/traditions[]">LiturgicalChant/traditions[]</a>
- **Minimum Items:** `1`
#### <a name="LiturgicalChant/improvement_cost"></a> `improvement_cost`
States which column is used to improve the skill.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="LiturgicalChant/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#LiturgyPrerequisites">LiturgyPrerequisites</a>
#### <a name="LiturgicalChant/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="LiturgicalChant/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#LiturgicalChantTranslation">LiturgicalChantTranslation</a>&gt;
#### <a name="LiturgicalChant/enhancements"></a> `enhancements?`
- **Type:** <a href="./_Enhancements.md#Enhancements">Enhancements</a>
---
### <a name="LiturgicalChant/traditions[]"></a> `LiturgicalChant/traditions[]`
- **Type:** <a href="./_Blessed.md#SkillTradition">SkillTradition</a>
---
### <a name="LiturgicalChantTranslation"></a> `LiturgicalChantTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the liturgical chant. | <a href="#LiturgicalChantTranslation/name">See details</a>
`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 href="#LiturgicalChantTranslation/name_compressed">See details</a>
`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. | <a href="#LiturgicalChantTranslation/effect">See details</a>
`casting_time` | | <a href="#LiturgicalChantTranslation/casting_time">See details</a>
`cost` | | <a href="#LiturgicalChantTranslation/cost">See details</a>
`range` | | <a href="#LiturgicalChantTranslation/range">See details</a>
`duration` | | <a href="#LiturgicalChantTranslation/duration">See details</a>
`target` | | <a href="#LiturgicalChantTranslation/target">See details</a>
`errata?` | | <a href="#LiturgicalChantTranslation/errata">See details</a>
#### <a name="LiturgicalChantTranslation/name"></a> `name`
The name of the liturgical chant.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="LiturgicalChantTranslation/name_compressed"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="LiturgicalChantTranslation/effect"></a> `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.
- **Type:** <a href="./_ActivatableSkillEffect.md#ActivatableSkillEffect">ActivatableSkillEffect</a>
#### <a name="LiturgicalChantTranslation/casting_time"></a> `casting_time`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="LiturgicalChantTranslation/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="LiturgicalChantTranslation/range"></a> `range`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="LiturgicalChantTranslation/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="LiturgicalChantTranslation/target"></a> `target`
- **Type:** String
#### <a name="LiturgicalChantTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Locale.md
-41
View File
@@ -1,41 +0,0 @@
# Supported locale
## Definitions
### <a name="Locale"></a> Supported locale (`Locale`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The locale's identifier. An IETF language tag (BCP47). | <a href="#Locale/id">See details</a>
`name` | Name of the language in it's language. | <a href="#Locale/name">See details</a>
`region` | Region in which the language is spoken in it's language. | <a href="#Locale/region">See details</a>
`is_missing_implementation?` | The language is not (fully) implemented and thus needs to be excluded from stable releases. | <a href="#Locale/is_missing_implementation">See details</a>
#### <a name="Locale/id"></a> `id`
The locale's identifier. An IETF language tag (BCP47).
- **Type:** String
- **Pattern:** `^[a-z]{2}-[A-Z]{2}$`
#### <a name="Locale/name"></a> `name`
Name of the language in it's language.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="Locale/region"></a> `region`
Region in which the language is spoken in it's language.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="Locale/is_missing_implementation"></a> `is_missing_implementation?`
The language is not (fully) implemented and thus needs to be excluded from stable releases.
- **Constant:** `true`
docs/reference/MetaCondition.md
-78
View File
@@ -1,78 +0,0 @@
# 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.
## Definitions
### <a name="MetaCondition"></a> 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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The meta condition's identifier. An unique, increasing integer. | <a href="#MetaCondition/id">See details</a>
`src` | | <a href="#MetaCondition/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#MetaCondition/translations">See details</a>
#### <a name="MetaCondition/id"></a> `id`
The meta condition's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="MetaCondition/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="MetaCondition/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#MetaConditionTranslation">MetaConditionTranslation</a>&gt;
---
### <a name="MetaConditionTranslation"></a> `MetaConditionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The meta condition's name. | <a href="#MetaConditionTranslation/name">See details</a>
`rules?` | Additional rules for the meta condition, if applicable. | <a href="#MetaConditionTranslation/rules">See details</a>
`effects` | The effects for level 1 to 4. | <a href="#MetaConditionTranslation/effects">See details</a>
`errata?` | | <a href="#MetaConditionTranslation/errata">See details</a>
#### <a name="MetaConditionTranslation/name"></a> `name`
The meta condition's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="MetaConditionTranslation/rules"></a> `rules?`
Additional rules for the meta condition, if applicable.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="MetaConditionTranslation/effects"></a> `effects`
The effects for level 1 to 4.
- **Type:** List
- **Items:** <a href="#MetaConditionTranslation/effects[]">MetaConditionTranslation/effects[]</a>
- **Minimum Items:** `4`
- **Maximum Items:** `4`
#### <a name="MetaConditionTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="MetaConditionTranslation/effects[]"></a> `MetaConditionTranslation/effects[]`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
docs/reference/PactCategory.md
-161
View File
@@ -1,161 +0,0 @@
# Pact Category
## Definitions
### <a name="PactCategory"></a> Pact Category (`PactCategory`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The pact category's identifier. An unique, increasing integer. | <a href="#PactCategory/id">See details</a>
`types` | Types of creatures in this category. | <a href="#PactCategory/types">See details</a>
`domains` | Domains in this category. | <a href="#PactCategory/domains">See details</a>
`src` | | <a href="#PactCategory/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PactCategory/translations">See details</a>
#### <a name="PactCategory/id"></a> `id`
The pact category's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PactCategory/types"></a> `types`
Types of creatures in this category.
- **Type:** List
- **Items:** <a href="#PactCategory/types[]">PactCategory/types[]</a>
- **Minimum Items:** `1`
#### <a name="PactCategory/domains"></a> `domains`
Domains in this category.
- **Type:** List
- **Items:** <a href="#PactCategory/domains[]">PactCategory/domains[]</a>
- **Minimum Items:** `1`
#### <a name="PactCategory/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="PactCategory/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PactCategoryTranslation">PactCategoryTranslation</a>&gt;
---
### <a name="PactCategory/types[]"></a> `PactCategory/types[]`
- **Type:** <a href="#PactType">PactType</a>
---
### <a name="PactCategory/domains[]"></a> `PactCategory/domains[]`
- **Type:** <a href="#PactDomain">PactDomain</a>
---
### <a name="PactCategoryTranslation"></a> `PactCategoryTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the pact category. | <a href="#PactCategoryTranslation/name">See details</a>
`errata?` | | <a href="#PactCategoryTranslation/errata">See details</a>
#### <a name="PactCategoryTranslation/name"></a> `name`
The name of the pact category.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PactCategoryTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="PactType"></a> `PactType`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The type's identifier. An unique, increasing integer. | <a href="#PactType/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PactType/translations">See details</a>
#### <a name="PactType/id"></a> `id`
The type's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PactType/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PactTypeTranslation">PactTypeTranslation</a>&gt;
---
### <a name="PactTypeTranslation"></a> `PactTypeTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the type. | <a href="#PactTypeTranslation/name">See details</a>
#### <a name="PactTypeTranslation/name"></a> `name`
The name of the type.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="PactDomain"></a> `PactDomain`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The domain's identifier. An unique, increasing integer. | <a href="#PactDomain/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PactDomain/translations">See details</a>
#### <a name="PactDomain/id"></a> `id`
The domain's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PactDomain/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PactDomainTranslation">PactDomainTranslation</a>&gt;
---
### <a name="PactDomainTranslation"></a> `PactDomainTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the domain. | <a href="#PactDomainTranslation/name">See details</a>
#### <a name="PactDomainTranslation/name"></a> `name`
The name of the domain.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Patron.md
-503
View File
@@ -1,503 +0,0 @@
# Patron
## Definitions
### <a name="Patron"></a> Patron (`Patron`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The patron's identifier. An unique, increasing integer. | <a href="#Patron/id">See details</a>
`category` | The patron's category. | <a href="#Patron/category">See details</a>
`skills` | The patron-specific skills. | <a href="#Patron/skills">See details</a>
`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 (difference). | <a href="#Patron/culture">See details</a>
`primary_patron_cultures?` | The list of cultures where patrons from this category can be the primary patron of. | <a href="#Patron/primary_patron_cultures">See details</a>
`powers?` | The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons. | <a href="#Patron/powers">See details</a>
`ae_cost?` | The patron-specific AE cost. Used by several animist forces for animal patrons. | <a href="#Patron/ae_cost">See details</a>
`improvement_cost?` | The patron-specific improvement cost. Used by several animist forces for animal patrons. | <a href="#Patron/improvement_cost">See details</a>
`common_advantages?` | The patron may grant common advantages that are taken into account during character creation. | <a href="#Patron/common_advantages">See details</a>
`common_disadvantages?` | The patron may grant common disadvantages that are taken into account during character creation. | <a href="#Patron/common_disadvantages">See details</a>
`common_spellworks?` | The animist may learn spellworks common for this patron. | <a href="#Patron/common_spellworks">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Patron/translations">See details</a>
#### <a name="Patron/id"></a> `id`
The patron's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Patron/category"></a> `category`
The patron's category.
- **Type:** <a href="./_SimpleReferences.md#PatronCategoryReference">PatronCategoryReference</a>
#### <a name="Patron/skills"></a> `skills`
The patron-specific skills.
- **Type:** List
- **Items:** <a href="#Patron/skills[]">Patron/skills[]</a>
- **Minimum Items:** `3`
- **Maximum Items:** `3`
#### <a name="Patron/culture"></a> `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
(difference).
- **Type:** <a href="#PatronCulture">PatronCulture</a>
#### <a name="Patron/primary_patron_cultures"></a> `primary_patron_cultures?`
The list of cultures where patrons from this category can be the primary patron of.
- **Type:** List
- **Items:** <a href="#Patron/primary_patron_cultures[]">Patron/primary_patron_cultures[]</a>
- **Unique Items:** Yes
#### <a name="Patron/powers"></a> `powers?`
The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons.
- **Type:** <a href="#AnimalPowers">AnimalPowers</a>
#### <a name="Patron/ae_cost"></a> `ae_cost?`
The patron-specific AE cost. Used by several animist forces for animal patrons.
- **Type:** Integer
- **Minimum:** `2`
- **Multiple of:** `2`
#### <a name="Patron/improvement_cost"></a> `improvement_cost?`
The patron-specific improvement cost. Used by several animist forces for animal patrons.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="Patron/common_advantages"></a> `common_advantages?`
The patron may grant common advantages that are taken into account during character creation.
*Source:* Geisterwald & Knochenklippen, p. 6-7
- **Type:** List
- **Items:** <a href="#Patron/common_advantages[]">Patron/common_advantages[]</a>
#### <a name="Patron/common_disadvantages"></a> `common_disadvantages?`
The patron may grant common disadvantages that are taken into account during character creation.
*Source:* Geisterwald & Knochenklippen, p. 6-7
- **Type:** List
- **Items:** <a href="#Patron/common_disadvantages[]">Patron/common_disadvantages[]</a>
#### <a name="Patron/common_spellworks"></a> `common_spellworks?`
The animist may learn spellworks common for this patron.
*Source:* Geisterwald & Knochenklippen, p. 6-7
- **Type:** List
- **Items:** <a href="#Patron/common_spellworks[]">Patron/common_spellworks[]</a>
#### <a name="Patron/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PatronTranslation">PatronTranslation</a>&gt;
---
### <a name="Patron/skills[]"></a> `Patron/skills[]`
- **Type:** <a href="./_SimpleReferences.md#SkillReference">SkillReference</a>
---
### <a name="Patron/primary_patron_cultures[]"></a> `Patron/primary_patron_cultures[]`
- **Type:** <a href="./_SimpleReferences.md#CultureReference">CultureReference</a>
---
### <a name="Patron/common_advantages[]"></a> `Patron/common_advantages[]`
- **Type:** <a href="./_SimpleReferences.md#AdvantageReference">AdvantageReference</a>
---
### <a name="Patron/common_disadvantages[]"></a> `Patron/common_disadvantages[]`
- **Type:** <a href="./_SimpleReferences.md#DisadvantageReference">DisadvantageReference</a>
---
### <a name="Patron/common_spellworks[]"></a> `Patron/common_spellworks[]`
- **Type:** <a href="./_SimpleReferences.md#SpellworkReference">SpellworkReference</a>
---
### <a name="PatronTranslation"></a> `PatronTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the patron. | <a href="#PatronTranslation/name">See details</a>
#### <a name="PatronTranslation/name"></a> `name`
The name of the patron.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="PatronCulture"></a> `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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`set` | | <a href="#PatronCulture/set">See details</a>
`operation` | | <a href="#PatronCulture/operation">See details</a>
#### <a name="PatronCulture/set"></a> `set`
- **Type:** List
- **Items:** <a href="#PatronCulture/set[]">PatronCulture/set[]</a>
#### <a name="PatronCulture/operation"></a> `operation`
- **Type:** <a href="#PatronCultureOperation">PatronCultureOperation</a>
---
### <a name="PatronCulture/set[]"></a> `PatronCulture/set[]`
- **Type:** <a href="./_SimpleReferences.md#CultureReference">CultureReference</a>
---
### <a name="PatronCultureOperation"></a> `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.
- **Type:** Union
- **Cases:** <a href="#PatronCultureOperation'0">PatronCultureOperation'0</a> | <a href="#PatronCultureOperation'1">PatronCultureOperation'1</a>
---
### <a name="PatronCultureOperation'0"></a> `PatronCultureOperation'0`
- **Constant:** `"Intersection"`
---
### <a name="PatronCultureOperation'1"></a> `PatronCultureOperation'1`
- **Constant:** `"Difference"`
---
### <a name="AnimalPowers"></a> `AnimalPowers`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`level1` | | <a href="#AnimalPowers/level1">See details</a>
`level2` | | <a href="#AnimalPowers/level2">See details</a>
`level3` | | <a href="#AnimalPowers/level3">See details</a>
#### <a name="AnimalPowers/level1"></a> `level1`
- **Type:** <a href="#AnimalPowersLevel1">AnimalPowersLevel1</a>
#### <a name="AnimalPowers/level2"></a> `level2`
- **Type:** <a href="#AnimalPowersLevel2">AnimalPowersLevel2</a>
#### <a name="AnimalPowers/level3"></a> `level3`
- **Type:** <a href="#AnimalPowersLevel3">AnimalPowersLevel3</a>
---
### <a name="AdvantageAnimalPower"></a> `AdvantageAnimalPower`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The advantage's identifier. | <a href="#AdvantageAnimalPower/id">See details</a>
`level?` | It grants a higher level of the advantage. | <a href="#AdvantageAnimalPower/level">See details</a>
`option?` | It grants a specific general option of the advantage. | <a href="#AdvantageAnimalPower/option">See details</a>
#### <a name="AdvantageAnimalPower/id"></a> `id`
The advantage's identifier.
- **Type:** <a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>
#### <a name="AdvantageAnimalPower/level"></a> `level?`
It grants a higher level of the advantage.
- **Type:** Integer
- **Minimum:** `2`
#### <a name="AdvantageAnimalPower/option"></a> `option?`
It grants a specific general option of the advantage.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="SkillAnimalPower"></a> `SkillAnimalPower`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill's identifier. | <a href="#SkillAnimalPower/id">See details</a>
`points` | The points that gets added to the skill's rating. | <a href="#SkillAnimalPower/points">See details</a>
#### <a name="SkillAnimalPower/id"></a> `id`
The skill's identifier.
- **Type:** <a href="./_Identifier.md#SkillIdentifier">SkillIdentifier</a>
#### <a name="SkillAnimalPower/points"></a> `points`
The points that gets added to the skill's rating.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="AnimalPowerLevel1"></a> `AnimalPowerLevel1`
- **Type:** Union
- **Cases:** <a href="#AnimalPowerLevel1'Advantage">AnimalPowerLevel1'Advantage</a> | <a href="#AnimalPowerLevel1'Skill">AnimalPowerLevel1'Skill</a>
---
### <a name="AnimalPowerLevel1'Advantage"></a> `AnimalPowerLevel1'Advantage`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalPowerLevel1'Advantage/tag">See details</a>
`advantage` | | <a href="#AnimalPowerLevel1'Advantage/advantage">See details</a>
#### <a name="AnimalPowerLevel1'Advantage/tag"></a> `tag`
- **Constant:** `"Advantage"`
#### <a name="AnimalPowerLevel1'Advantage/advantage"></a> `advantage`
- **Type:** <a href="#AdvantageAnimalPower">AdvantageAnimalPower</a>
---
### <a name="AnimalPowerLevel1'Skill"></a> `AnimalPowerLevel1'Skill`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalPowerLevel1'Skill/tag">See details</a>
`skill` | | <a href="#AnimalPowerLevel1'Skill/skill">See details</a>
#### <a name="AnimalPowerLevel1'Skill/tag"></a> `tag`
- **Constant:** `"Skill"`
#### <a name="AnimalPowerLevel1'Skill/skill"></a> `skill`
- **Type:** <a href="#SkillAnimalPower">SkillAnimalPower</a>
---
### <a name="AnimalPowersLevel1"></a> `AnimalPowersLevel1`
- **Type:** List
- **Items:** <a href="#AnimalPowersLevel1[]">AnimalPowersLevel1[]</a>
- **Minimum Items:** `1`
---
### <a name="AnimalPowersLevel1[]"></a> `AnimalPowersLevel1[]`
- **Type:** <a href="#AnimalPowerLevel1">AnimalPowerLevel1</a>
---
### <a name="CombatAnimalPower"></a> `CombatAnimalPower`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The combat value. | <a href="#CombatAnimalPower/id">See details</a>
`value` | The value that gets added to the combat value. | <a href="#CombatAnimalPower/value">See details</a>
#### <a name="CombatAnimalPower/id"></a> `id`
The combat value.
- **Type:** <a href="#CombatAnimalPowerType">CombatAnimalPowerType</a>
#### <a name="CombatAnimalPower/value"></a> `value`
The value that gets added to the combat value.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="CombatAnimalPowerType"></a> `CombatAnimalPowerType`
- **Type:** Union
- **Cases:** <a href="#CombatAnimalPowerType'0">CombatAnimalPowerType'0</a> | <a href="#CombatAnimalPowerType'1">CombatAnimalPowerType'1</a> | <a href="#CombatAnimalPowerType'2">CombatAnimalPowerType'2</a> | <a href="#CombatAnimalPowerType'3">CombatAnimalPowerType'3</a> | <a href="#CombatAnimalPowerType'4">CombatAnimalPowerType'4</a> | <a href="#CombatAnimalPowerType'5">CombatAnimalPowerType'5</a>
---
### <a name="CombatAnimalPowerType'0"></a> `CombatAnimalPowerType'0`
- **Constant:** `"Attack"`
---
### <a name="CombatAnimalPowerType'1"></a> `CombatAnimalPowerType'1`
- **Constant:** `"Parry"`
---
### <a name="CombatAnimalPowerType'2"></a> `CombatAnimalPowerType'2`
- **Constant:** `"RangedCombat"`
---
### <a name="CombatAnimalPowerType'3"></a> `CombatAnimalPowerType'3`
- **Constant:** `"Dodge"`
---
### <a name="CombatAnimalPowerType'4"></a> `CombatAnimalPowerType'4`
- **Constant:** `"DamagePoints"`
---
### <a name="CombatAnimalPowerType'5"></a> `CombatAnimalPowerType'5`
- **Constant:** `"Protection"`
---
### <a name="AnimalPowerLevel2"></a> `AnimalPowerLevel2`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalPowerLevel2/tag">See details</a>
`combat` | | <a href="#AnimalPowerLevel2/combat">See details</a>
#### <a name="AnimalPowerLevel2/tag"></a> `tag`
- **Constant:** `"Combat"`
#### <a name="AnimalPowerLevel2/combat"></a> `combat`
- **Type:** <a href="#CombatAnimalPower">CombatAnimalPower</a>
---
### <a name="AnimalPowersLevel2"></a> `AnimalPowersLevel2`
- **Type:** List
- **Items:** <a href="#AnimalPowersLevel2[]">AnimalPowersLevel2[]</a>
- **Minimum Items:** `1`
---
### <a name="AnimalPowersLevel2[]"></a> `AnimalPowersLevel2[]`
- **Type:** <a href="#AnimalPowerLevel2">AnimalPowerLevel2</a>
---
### <a name="AttributeAnimalPower"></a> `AttributeAnimalPower`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The attribute's identifier. | <a href="#AttributeAnimalPower/id">See details</a>
`value` | The value that gets added to the attribute. | <a href="#AttributeAnimalPower/value">See details</a>
#### <a name="AttributeAnimalPower/id"></a> `id`
The attribute's identifier.
- **Type:** <a href="./_Identifier.md#AttributeIdentifier">AttributeIdentifier</a>
#### <a name="AttributeAnimalPower/value"></a> `value`
The value that gets added to the attribute.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="AnimalPowerLevel3"></a> `AnimalPowerLevel3`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalPowerLevel3/tag">See details</a>
`attribute` | | <a href="#AnimalPowerLevel3/attribute">See details</a>
#### <a name="AnimalPowerLevel3/tag"></a> `tag`
- **Constant:** `"Attribute"`
#### <a name="AnimalPowerLevel3/attribute"></a> `attribute`
- **Type:** <a href="#AttributeAnimalPower">AttributeAnimalPower</a>
---
### <a name="AnimalPowersLevel3"></a> `AnimalPowersLevel3`
- **Type:** List
- **Items:** <a href="#AnimalPowersLevel3[]">AnimalPowersLevel3[]</a>
- **Minimum Items:** `1`
---
### <a name="AnimalPowersLevel3[]"></a> `AnimalPowersLevel3[]`
- **Type:** <a href="#AnimalPowerLevel3">AnimalPowerLevel3</a>
docs/reference/PatronCategory.md
-57
View File
@@ -1,57 +0,0 @@
# Patron Category
## Definitions
### <a name="PatronCategory"></a> Patron Category (`PatronCategory`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The patron category's identifier. An unique, increasing integer. | <a href="#PatronCategory/id">See details</a>
`primary_patron_cultures` | The list of cultures where patrons from this category can be the primary patron of. | <a href="#PatronCategory/primary_patron_cultures">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PatronCategory/translations">See details</a>
#### <a name="PatronCategory/id"></a> `id`
The patron category's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PatronCategory/primary_patron_cultures"></a> `primary_patron_cultures`
The list of cultures where patrons from this category can be the primary patron of.
- **Type:** List
- **Items:** <a href="#PatronCategory/primary_patron_cultures[]">PatronCategory/primary_patron_cultures[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
#### <a name="PatronCategory/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PatronCategoryTranslation">PatronCategoryTranslation</a>&gt;
---
### <a name="PatronCategory/primary_patron_cultures[]"></a> `PatronCategory/primary_patron_cultures[]`
- **Type:** <a href="./_SimpleReferences.md#CultureReference">CultureReference</a>
---
### <a name="PatronCategoryTranslation"></a> `PatronCategoryTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the patron category. | <a href="#PatronCategoryTranslation/name">See details</a>
#### <a name="PatronCategoryTranslation/name"></a> `name`
The name of the patron category.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/PersonalityTrait.md
-123
View File
@@ -1,123 +0,0 @@
# 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.
## Definitions
### <a name="PersonalityTrait"></a> 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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The personality trait's identifier. An unique, increasing integer. | <a href="#PersonalityTrait/id">See details</a>
`level` | The personality trait's level. | <a href="#PersonalityTrait/level">See details</a>
`prerequisites?` | | <a href="#PersonalityTrait/prerequisites">See details</a>
`combination_options?` | The lower-level personality trait(s) this trait can be combined with. | <a href="#PersonalityTrait/combination_options">See details</a>
`src` | | <a href="#PersonalityTrait/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PersonalityTrait/translations">See details</a>
#### <a name="PersonalityTrait/id"></a> `id`
The personality trait's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PersonalityTrait/level"></a> `level`
The personality trait's level.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `3`
#### <a name="PersonalityTrait/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#PersonalityTraitPrerequisites">PersonalityTraitPrerequisites</a>
#### <a name="PersonalityTrait/combination_options"></a> `combination_options?`
The lower-level personality trait(s) this trait can be combined with.
- **Type:** List
- **Items:** <a href="#PersonalityTrait/combination_options[]">PersonalityTrait/combination_options[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
#### <a name="PersonalityTrait/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="PersonalityTrait/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PersonalityTraitTranslation">PersonalityTraitTranslation</a>&gt;
---
### <a name="PersonalityTrait/combination_options[]"></a> `PersonalityTrait/combination_options[]`
- **Type:** <a href="./_SimpleReferences.md#PersonalityTraitReference">PersonalityTraitReference</a>
---
### <a name="PersonalityTraitTranslation"></a> `PersonalityTraitTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the personality trait. | <a href="#PersonalityTraitTranslation/name">See details</a>
`effects` | The effects of the personality trait. They should be sorted like they are in the book. | <a href="#PersonalityTraitTranslation/effects">See details</a>
`errata?` | | <a href="#PersonalityTraitTranslation/errata">See details</a>
#### <a name="PersonalityTraitTranslation/name"></a> `name`
The name of the personality trait.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PersonalityTraitTranslation/effects"></a> `effects`
The effects of the personality trait. They should be sorted like they are in the book.
- **Type:** List
- **Items:** <a href="#PersonalityTraitTranslation/effects[]">PersonalityTraitTranslation/effects[]</a>
- **Minimum Items:** `1`
#### <a name="PersonalityTraitTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="PersonalityTraitTranslation/effects[]"></a> `PersonalityTraitTranslation/effects[]`
- **Type:** <a href="#PersonalityTraitEffect">PersonalityTraitEffect</a>
---
### <a name="PersonalityTraitEffect"></a> `PersonalityTraitEffect`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`label?` | A label that is displayed and placed before the actual text. | <a href="#PersonalityTraitEffect/label">See details</a>
`text` | The effect text. | <a href="#PersonalityTraitEffect/text">See details</a>
#### <a name="PersonalityTraitEffect/label"></a> `label?`
A label that is displayed and placed before the actual text.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PersonalityTraitEffect/text"></a> `text`
The effect text.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Profession.md
-1637
View File
File diff suppressed because it is too large Load Diff
docs/reference/Property.md
-48
View File
@@ -1,48 +0,0 @@
# Property
## Definitions
### <a name="Property"></a> Property (`Property`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The property's identifier. An unique, increasing integer. | <a href="#Property/id">See details</a>
`check?` | The property check's attributes. Only the properties from the Core Rules have defined property checks. | <a href="#Property/check">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Property/translations">See details</a>
#### <a name="Property/id"></a> `id`
The property's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Property/check"></a> `check?`
The property check's attributes. Only the properties from the Core Rules have defined property checks.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="Property/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PropertyTranslation">PropertyTranslation</a>&gt;
---
### <a name="PropertyTranslation"></a> `PropertyTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The property's name. | <a href="#PropertyTranslation/name">See details</a>
#### <a name="PropertyTranslation/name"></a> `name`
The property's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Race.md
-681
View File
@@ -1,681 +0,0 @@
# Race
A playable race with stats and skills.
## Definitions
### <a name="Race"></a> Race (`Race`)
A playable race with stats and skills.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The race's identifier. An unique, increasing integer. | <a href="#Race/id">See details</a>
`ap_value` | How many Adventure Points does the race cost during character creation? | <a href="#Race/ap_value">See details</a>
`base_values` | The race’s base values. | <a href="#Race/base_values">See details</a>
`attribute_adjustments` | Describes how to raise or lower maximum attribute values during character creation. | <a href="#Race/attribute_adjustments">See details</a>
`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 href="#Race/automatic_advantages">See details</a>
`strongly_recommended_advantages?` | A list of strongly recommended advantages. | <a href="#Race/strongly_recommended_advantages">See details</a>
`strongly_recommended_disadvantages?` | A list of strongly recommended disadvantages. | <a href="#Race/strongly_recommended_disadvantages">See details</a>
`weight` | Configuration for random weight generation. | <a href="#Race/weight">See details</a>
`starting_age` | Defines the starting ages for the race. It depends on the selected experience level. | <a href="#Race/starting_age">See details</a>
`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 href="#Race/variants">See details</a>
`src` | | <a href="#Race/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Race/translations">See details</a>
#### <a name="Race/id"></a> `id`
The race's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Race/ap_value"></a> `ap_value`
How many Adventure Points does the race cost during character creation?
- **Type:** Integer
- **Minimum:** `0`
#### <a name="Race/base_values"></a> `base_values`
The race’s base values.
- **Type:** <a href="#BaseValues">BaseValues</a>
#### <a name="Race/attribute_adjustments"></a> `attribute_adjustments`
Describes how to raise or lower maximum attribute values during character creation.
- **Type:** <a href="#AttributeAdjustments">AttributeAdjustments</a>
#### <a name="Race/automatic_advantages"></a> `automatic_advantages?`
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:** <a href="#Race/automatic_advantages[]">Race/automatic_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="Race/strongly_recommended_advantages"></a> `strongly_recommended_advantages?`
A list of strongly recommended advantages.
- **Type:** List
- **Items:** <a href="#Race/strongly_recommended_advantages[]">Race/strongly_recommended_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="Race/strongly_recommended_disadvantages"></a> `strongly_recommended_disadvantages?`
A list of strongly recommended disadvantages.
- **Type:** List
- **Items:** <a href="#Race/strongly_recommended_disadvantages[]">Race/strongly_recommended_disadvantages[]</a>
- **Minimum Items:** `1`
#### <a name="Race/weight"></a> `weight`
Configuration for random weight generation.
- **Type:** <a href="#RandomWeightGeneration">RandomWeightGeneration</a>
#### <a name="Race/starting_age"></a> `starting_age`
Defines the starting ages for the race. It depends on the selected experience level.
- **Type:** List
- **Items:** <a href="#Race/starting_age[]">Race/starting_age[]</a>
- **Minimum Items:** `7`
- **Maximum Items:** `7`
#### <a name="Race/variants"></a> `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.
- **Type:** <a href="#RaceVariants">RaceVariants</a>
#### <a name="Race/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Race/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RaceTranslation">RaceTranslation</a>&gt;
---
### <a name="Race/automatic_advantages[]"></a> `Race/automatic_advantages[]`
- **Type:** <a href="./_SimpleReferences.md#AdvantageReference">AdvantageReference</a>
---
### <a name="Race/strongly_recommended_advantages[]"></a> `Race/strongly_recommended_advantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>&gt;
---
### <a name="Race/strongly_recommended_disadvantages[]"></a> `Race/strongly_recommended_disadvantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>&gt;
---
### <a name="Race/starting_age[]"></a> `Race/starting_age[]`
- **Type:** <a href="#StartingAgeConfigForExperienceLevel">StartingAgeConfigForExperienceLevel</a>
---
### <a name="BaseValues"></a> `BaseValues`
The race’s base values.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`life_points` | The race’s life point base value. | <a href="#BaseValues/life_points">See details</a>
`spirit` | The race’s Spirit base value. | <a href="#BaseValues/spirit">See details</a>
`toughness` | The race’s Toughness base value. | <a href="#BaseValues/toughness">See details</a>
`movement` | The race’s tactical movement rate. | <a href="#BaseValues/movement">See details</a>
#### <a name="BaseValues/life_points"></a> `life_points`
The race’s life point base value.
- **Type:** Integer
#### <a name="BaseValues/spirit"></a> `spirit`
The race’s Spirit base value.
- **Type:** Integer
#### <a name="BaseValues/toughness"></a> `toughness`
The race’s Toughness base value.
- **Type:** Integer
#### <a name="BaseValues/movement"></a> `movement`
The race’s tactical movement rate.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="AttributeAdjustments"></a> `AttributeAdjustments`
Describes how to raise or lower maximum attribute values during character creation.
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`fixed?` | The values by which the maximum of the respective attribute is modified. | <a href="#AttributeAdjustments/fixed">See details</a>
`selectable?` | An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options. | <a href="#AttributeAdjustments/selectable">See details</a>
#### <a name="AttributeAdjustments/fixed"></a> `fixed?`
The values by which the maximum of the respective attribute is modified.
- **Type:** List
- **Items:** <a href="#AttributeAdjustments/fixed[]">AttributeAdjustments/fixed[]</a>
- **Minimum Items:** `1`
#### <a name="AttributeAdjustments/selectable"></a> `selectable?`
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.
- **Type:** List
- **Items:** <a href="#AttributeAdjustments/selectable[]">AttributeAdjustments/selectable[]</a>
- **Minimum Items:** `1`
- **Maximum Items:** `1`
---
### <a name="AttributeAdjustments/fixed[]"></a> `AttributeAdjustments/fixed[]`
- **Type:** <a href="#FixedAttributeAdjustment">FixedAttributeAdjustment</a>
---
### <a name="AttributeAdjustments/selectable[]"></a> `AttributeAdjustments/selectable[]`
- **Type:** <a href="#SelectableAttributeAdjustment">SelectableAttributeAdjustment</a>
---
### <a name="FixedAttributeAdjustment"></a> `FixedAttributeAdjustment`
A value by which the maximum of the respective attribute is modified.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The attribute the modifier applies to. | <a href="#FixedAttributeAdjustment/id">See details</a>
`value` | The value by which the specified attribute's maximum is modified (negative values will lower the maximum). | <a href="#FixedAttributeAdjustment/value">See details</a>
#### <a name="FixedAttributeAdjustment/id"></a> `id`
The attribute the modifier applies to.
- **Type:** <a href="./_Identifier.md#AttributeIdentifier">AttributeIdentifier</a>
#### <a name="FixedAttributeAdjustment/value"></a> `value`
The value by which the specified attribute's maximum is modified
(negative values will lower the maximum).
- **Type:** Integer
---
### <a name="SelectableAttributeAdjustment"></a> `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).
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`list` | A list of attributes the player has to choose from. | <a href="#SelectableAttributeAdjustment/list">See details</a>
`value` | The value by which the selected attribute's maximum is modified (negative values will lower the maximum). | <a href="#SelectableAttributeAdjustment/value">See details</a>
#### <a name="SelectableAttributeAdjustment/list"></a> `list`
A list of attributes the player has to choose from.
- **Type:** List
- **Items:** <a href="#SelectableAttributeAdjustment/list[]">SelectableAttributeAdjustment/list[]</a>
- **Minimum Items:** `2`
#### <a name="SelectableAttributeAdjustment/value"></a> `value`
The value by which the selected attribute's maximum is modified
(negative values will lower the maximum).
- **Type:** Integer
---
### <a name="SelectableAttributeAdjustment/list[]"></a> `SelectableAttributeAdjustment/list[]`
- **Type:** <a href="./_SimpleReferences.md#AttributeReference">AttributeReference</a>
---
### <a name="RandomWeightGeneration"></a> `RandomWeightGeneration`
Configuration for random weight generation.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`base` | The base value used for random weight. The height subtrahend; in case of `Height - 110 + 2D6` it is `110`. | <a href="#RandomWeightGeneration/base">See details</a>
`random` | The dice used for random weight. | <a href="#RandomWeightGeneration/random">See details</a>
#### <a name="RandomWeightGeneration/base"></a> `base`
The base value used for random weight. The height subtrahend; in case of
`Height - 110 + 2D6` it is `110`.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="RandomWeightGeneration/random"></a> `random`
The dice used for random weight.
- **Type:** List
- **Items:** <a href="#RandomWeightGeneration/random[]">RandomWeightGeneration/random[]</a>
- **Minimum Items:** `1`
---
### <a name="RandomWeightGeneration/random[]"></a> `RandomWeightGeneration/random[]`
- **Type:** <a href="#WeightDice">WeightDice</a>
---
### <a name="WeightDice"></a> `WeightDice`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`number` | Number of dice of the same type. Example: 2 in 2D6. | <a href="#WeightDice/number">See details</a>
`sides` | Number of sides on every die. Example: 6 in 2D6. | <a href="#WeightDice/sides">See details</a>
`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. | <a href="#WeightDice/offset_strategy">See details</a>
#### <a name="WeightDice/number"></a> `number`
Number of dice of the same type. Example: 2 in 2D6.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="WeightDice/sides"></a> `sides`
Number of sides on every die. Example: 6 in 2D6.
- **Type:** <a href="./_Dice.md#DieType">DieType</a>
#### <a name="WeightDice/offset_strategy"></a> `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.
- **Type:** <a href="#WeightDiceOffsetStrategy">WeightDiceOffsetStrategy</a>
---
### <a name="WeightDiceOffsetStrategy"></a> `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.
- **Type:** Union
- **Cases:** <a href="#WeightDiceOffsetStrategy'0">WeightDiceOffsetStrategy'0</a> | <a href="#WeightDiceOffsetStrategy'1">WeightDiceOffsetStrategy'1</a> | <a href="#WeightDiceOffsetStrategy'2">WeightDiceOffsetStrategy'2</a>
---
### <a name="WeightDiceOffsetStrategy'0"></a> `WeightDiceOffsetStrategy'0`
- **Constant:** `"Add"`
---
### <a name="WeightDiceOffsetStrategy'1"></a> `WeightDiceOffsetStrategy'1`
- **Constant:** `"Subtract"`
---
### <a name="WeightDiceOffsetStrategy'2"></a> `WeightDiceOffsetStrategy'2`
- **Constant:** `"AddEvenSubtractOdd"`
---
### <a name="StartingAgeConfigForExperienceLevel"></a> `StartingAgeConfigForExperienceLevel`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The selected experience level's identifier. | <a href="#StartingAgeConfigForExperienceLevel/id">See details</a>
`base` | The base value for the selected experience level. | <a href="#StartingAgeConfigForExperienceLevel/base">See details</a>
`random` | The random value for the selected experience level. It is going to be added to the base value. | <a href="#StartingAgeConfigForExperienceLevel/random">See details</a>
#### <a name="StartingAgeConfigForExperienceLevel/id"></a> `id`
The selected experience level's identifier.
- **Type:** <a href="./_Identifier.md#ExperienceLevelIdentifier">ExperienceLevelIdentifier</a>
#### <a name="StartingAgeConfigForExperienceLevel/base"></a> `base`
The base value for the selected experience level.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="StartingAgeConfigForExperienceLevel/random"></a> `random`
The random value for the selected experience level. It is going to be added to the base value.
- **Type:** <a href="./_Dice.md#Dice">Dice</a>
---
### <a name="RaceVariants"></a> `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.
- **Type:** List
- **Items:** <a href="#RaceVariants[]">RaceVariants[]</a>
- **Minimum Items:** `1`
---
### <a name="RaceVariants[]"></a> `RaceVariants[]`
- **Type:** <a href="#RaceVariant">RaceVariant</a>
---
### <a name="RaceVariant"></a> Race Variant (`RaceVariant`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | An unique, increasing integer. | <a href="#RaceVariant/id">See details</a>
`common_cultures` | The list of common cultures. | <a href="#RaceVariant/common_cultures">See details</a>
`common_advantages?` | A list of common advantages. | <a href="#RaceVariant/common_advantages">See details</a>
`common_disadvantages?` | A list of common disadvantages. | <a href="#RaceVariant/common_disadvantages">See details</a>
`uncommon_advantages?` | A list of uncommon advantages. | <a href="#RaceVariant/uncommon_advantages">See details</a>
`uncommon_disadvantages?` | A list of uncommon disadvantages. | <a href="#RaceVariant/uncommon_disadvantages">See details</a>
`hair_color` | An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color. | <a href="#RaceVariant/hair_color">See details</a>
`eye_color` | An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color. | <a href="#RaceVariant/eye_color">See details</a>
`height` | Configuration for random height generation. | <a href="#RaceVariant/height">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#RaceVariant/translations">See details</a>
#### <a name="RaceVariant/id"></a> `id`
An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="RaceVariant/common_cultures"></a> `common_cultures`
The list of common cultures.
- **Type:** List
- **Items:** <a href="#RaceVariant/common_cultures[]">RaceVariant/common_cultures[]</a>
- **Minimum Items:** `1`
#### <a name="RaceVariant/common_advantages"></a> `common_advantages?`
A list of common advantages.
- **Type:** List
- **Items:** <a href="#RaceVariant/common_advantages[]">RaceVariant/common_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="RaceVariant/common_disadvantages"></a> `common_disadvantages?`
A list of common disadvantages.
- **Type:** List
- **Items:** <a href="#RaceVariant/common_disadvantages[]">RaceVariant/common_disadvantages[]</a>
- **Minimum Items:** `1`
#### <a name="RaceVariant/uncommon_advantages"></a> `uncommon_advantages?`
A list of uncommon advantages.
- **Type:** List
- **Items:** <a href="#RaceVariant/uncommon_advantages[]">RaceVariant/uncommon_advantages[]</a>
- **Minimum Items:** `1`
#### <a name="RaceVariant/uncommon_disadvantages"></a> `uncommon_disadvantages?`
A list of uncommon disadvantages.
- **Type:** List
- **Items:** <a href="#RaceVariant/uncommon_disadvantages[]">RaceVariant/uncommon_disadvantages[]</a>
- **Minimum Items:** `1`
#### <a name="RaceVariant/hair_color"></a> `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:** <a href="#RaceVariant/hair_color[]">RaceVariant/hair_color[]</a>
- **Minimum Items:** `20`
- **Maximum Items:** `20`
#### <a name="RaceVariant/eye_color"></a> `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:** <a href="#RaceVariant/eye_color[]">RaceVariant/eye_color[]</a>
- **Minimum Items:** `20`
- **Maximum Items:** `20`
#### <a name="RaceVariant/height"></a> `height`
Configuration for random height generation.
- **Type:** <a href="#Height">Height</a>
#### <a name="RaceVariant/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RaceVariantTranslation">RaceVariantTranslation</a>&gt;
---
### <a name="RaceVariant/common_cultures[]"></a> `RaceVariant/common_cultures[]`
- **Type:** <a href="./_SimpleReferences.md#CultureReference">CultureReference</a>
---
### <a name="RaceVariant/common_advantages[]"></a> `RaceVariant/common_advantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>&gt;
---
### <a name="RaceVariant/common_disadvantages[]"></a> `RaceVariant/common_disadvantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>&gt;
---
### <a name="RaceVariant/uncommon_advantages[]"></a> `RaceVariant/uncommon_advantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>&gt;
---
### <a name="RaceVariant/uncommon_disadvantages[]"></a> `RaceVariant/uncommon_disadvantages[]`
- **Type:** <a href="./_CommonnessRatedAdvantageDisadvantage.md#CommonnessRatedAdvantageDisadvantage">CommonnessRatedAdvantageDisadvantage</a>&lt;<a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>&gt;
---
### <a name="RaceVariant/hair_color[]"></a> `RaceVariant/hair_color[]`
- **Type:** <a href="./_SimpleReferences.md#HairColorReference">HairColorReference</a>
---
### <a name="RaceVariant/eye_color[]"></a> `RaceVariant/eye_color[]`
- **Type:** <a href="./_SimpleReferences.md#EyeColorReference">EyeColorReference</a>
---
### <a name="Height"></a> `Height`
Configuration for random height generation.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`base` | The base value used for random height. | <a href="#Height/base">See details</a>
`random` | The dice used for random height. | <a href="#Height/random">See details</a>
#### <a name="Height/base"></a> `base`
The base value used for random height.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Height/random"></a> `random`
The dice used for random height.
- **Type:** List
- **Items:** <a href="#Height/random[]">Height/random[]</a>
- **Minimum Items:** `1`
---
### <a name="Height/random[]"></a> `Height/random[]`
- **Type:** <a href="./_Dice.md#Dice">Dice</a>
---
### <a name="RaceVariantTranslation"></a> `RaceVariantTranslation`
- **Type:** Object
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. | <a href="#RaceVariantTranslation/name">See details</a>
`common_advantages?` | The respective common advantages text from the source book. | <a href="#RaceVariantTranslation/common_advantages">See details</a>
`common_disadvantages?` | The respective common disadvantages text from the source book. | <a href="#RaceVariantTranslation/common_disadvantages">See details</a>
`uncommon_advantages?` | The respective uncommon advantages text from the source book. | <a href="#RaceVariantTranslation/uncommon_advantages">See details</a>
`uncommon_disadvantages?` | The respective uncommon disadvantages text from the source book. | <a href="#RaceVariantTranslation/uncommon_disadvantages">See details</a>
#### <a name="RaceVariantTranslation/name"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceVariantTranslation/common_advantages"></a> `common_advantages?`
The respective common advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceVariantTranslation/common_disadvantages"></a> `common_disadvantages?`
The respective common disadvantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceVariantTranslation/uncommon_advantages"></a> `uncommon_advantages?`
The respective uncommon advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceVariantTranslation/uncommon_disadvantages"></a> `uncommon_disadvantages?`
The respective uncommon disadvantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="RaceTranslation"></a> `RaceTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The race's name. | <a href="#RaceTranslation/name">See details</a>
`attribute_adjustments` | The respective attribute adjustments text from the source book. | <a href="#RaceTranslation/attribute_adjustments">See details</a>
`automatic_advantages?` | The respective automatic advantages text from the source book. | <a href="#RaceTranslation/automatic_advantages">See details</a>
`strongly_recommended_advantages?` | The respective strongly recommended advantages text from the source book. | <a href="#RaceTranslation/strongly_recommended_advantages">See details</a>
`strongly_recommended_disadvantages?` | The respective strongly recommended disadvantages text from the source book. | <a href="#RaceTranslation/strongly_recommended_disadvantages">See details</a>
`errata?` | | <a href="#RaceTranslation/errata">See details</a>
#### <a name="RaceTranslation/name"></a> `name`
The race's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceTranslation/attribute_adjustments"></a> `attribute_adjustments`
The respective attribute adjustments text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceTranslation/automatic_advantages"></a> `automatic_advantages?`
The respective automatic advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceTranslation/strongly_recommended_advantages"></a> `strongly_recommended_advantages?`
The respective strongly recommended advantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceTranslation/strongly_recommended_disadvantages"></a> `strongly_recommended_disadvantages?`
The respective strongly recommended disadvantages text from the source book.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="RaceTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Region.md
-41
View File
@@ -1,41 +0,0 @@
# Region
## Definitions
### <a name="Region"></a> Region (`Region`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The region's identifier. An unique, increasing integer. | <a href="#Region/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Region/translations">See details</a>
#### <a name="Region/id"></a> `id`
The region's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Region/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RegionTranslation">RegionTranslation</a>&gt;
---
### <a name="RegionTranslation"></a> `RegionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The region name. | <a href="#RegionTranslation/name">See details</a>
#### <a name="RegionTranslation/name"></a> `name`
The region name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Ritual.md
-143
View File
@@ -1,143 +0,0 @@
# Ritual
## Definitions
### <a name="Ritual"></a> Ritual (`Ritual`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The ritual's identifier. An unique, increasing integer. | <a href="#Ritual/id">See details</a>
`check` | Lists the linked three attributes used to make a skill check. | <a href="#Ritual/check">See details</a>
`check_penalty?` | In some cases, the target's Spirit or Toughness is applied as a penalty. | <a href="#Ritual/check_penalty">See details</a>
`parameters` | Measurable parameters of a ritual. | <a href="#Ritual/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#Ritual/target">See details</a>
`property` | The associated property. | <a href="#Ritual/property">See details</a>
`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. | <a href="#Ritual/traditions">See details</a>
`improvement_cost` | States which column is used to improve the skill. | <a href="#Ritual/improvement_cost">See details</a>
`prerequisites?` | | <a href="#Ritual/prerequisites">See details</a>
`src` | | <a href="#Ritual/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Ritual/translations">See details</a>
`enhancements?` | | <a href="#Ritual/enhancements">See details</a>
#### <a name="Ritual/id"></a> `id`
The ritual's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Ritual/check"></a> `check`
Lists the linked three attributes used to make a skill check.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="Ritual/check_penalty"></a> `check_penalty?`
In some cases, the target's Spirit or Toughness is applied as a penalty.
- **Type:** <a href="./_SkillCheck.md#SkillCheckPenalty">SkillCheckPenalty</a>
#### <a name="Ritual/parameters"></a> `parameters`
Measurable parameters of a ritual.
- **Type:** <a href="./_ActivatableSkill.md#SlowPerformanceParameters">SlowPerformanceParameters</a>
#### <a name="Ritual/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="Ritual/property"></a> `property`
The associated property.
- **Type:** <a href="./_SimpleReferences.md#PropertyReference">PropertyReference</a>
#### <a name="Ritual/traditions"></a> `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:** <a href="./_Spellwork.md#Traditions">Traditions</a>
#### <a name="Ritual/improvement_cost"></a> `improvement_cost`
States which column is used to improve the skill.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="Ritual/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#SpellworkPrerequisites">SpellworkPrerequisites</a>
#### <a name="Ritual/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Ritual/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RitualTranslation">RitualTranslation</a>&gt;
#### <a name="Ritual/enhancements"></a> `enhancements?`
- **Type:** <a href="./_Enhancements.md#Enhancements">Enhancements</a>
---
### <a name="RitualTranslation"></a> `RitualTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the ritual. | <a href="#RitualTranslation/name">See details</a>
`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. | <a href="#RitualTranslation/effect">See details</a>
`casting_time` | | <a href="#RitualTranslation/casting_time">See details</a>
`cost` | | <a href="#RitualTranslation/cost">See details</a>
`range` | | <a href="#RitualTranslation/range">See details</a>
`duration` | | <a href="#RitualTranslation/duration">See details</a>
`target` | | <a href="#RitualTranslation/target">See details</a>
`errata?` | | <a href="#RitualTranslation/errata">See details</a>
#### <a name="RitualTranslation/name"></a> `name`
The name of the ritual.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="RitualTranslation/effect"></a> `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.
- **Type:** <a href="./_ActivatableSkillEffect.md#ActivatableSkillEffect">ActivatableSkillEffect</a>
#### <a name="RitualTranslation/casting_time"></a> `casting_time`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="RitualTranslation/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="RitualTranslation/range"></a> `range`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="RitualTranslation/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="RitualTranslation/target"></a> `target`
- **Type:** String
#### <a name="RitualTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Service.md
-93
View File
@@ -1,93 +0,0 @@
# Service of Summoned Creatures and Monstrosities
## Definitions
### <a name="Service"></a> Service of Summoned Creatures and Monstrosities (`Service`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The service's identifier. An unique, increasing integer. | <a href="#Service/id">See details</a>
`availability` | Defines for which creature type(s) the service is available. | <a href="#Service/availability">See details</a>
`src` | | <a href="#Service/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Service/translations">See details</a>
#### <a name="Service/id"></a> `id`
The service's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Service/availability"></a> `availability`
Defines for which creature type(s) the service is available.
- **Type:** List
- **Items:** <a href="#Service/availability[]">Service/availability[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
#### <a name="Service/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Service/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ServiceTranslation">ServiceTranslation</a>&gt;
---
### <a name="Service/availability[]"></a> `Service/availability[]`
- **Type:** <a href="#ServiceAvailability">ServiceAvailability</a>
---
### <a name="ServiceAvailability"></a> `ServiceAvailability`
- **Type:** Union
- **Cases:** <a href="#ServiceAvailability'0">ServiceAvailability'0</a> | <a href="#ServiceAvailability'1">ServiceAvailability'1</a>
---
### <a name="ServiceAvailability'0"></a> `ServiceAvailability'0`
- **Constant:** `"SummonedCreatures"`
---
### <a name="ServiceAvailability'1"></a> `ServiceAvailability'1`
- **Constant:** `"Monstrosities"`
---
### <a name="ServiceTranslation"></a> `ServiceTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the service. | <a href="#ServiceTranslation/name">See details</a>
`description` | The description of the service. | <a href="#ServiceTranslation/description">See details</a>
`errata?` | | <a href="#ServiceTranslation/errata">See details</a>
#### <a name="ServiceTranslation/name"></a> `name`
The name of the service.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ServiceTranslation/description"></a> `description`
The description of the service.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ServiceTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/SexPractice.md
-74
View File
@@ -1,74 +0,0 @@
# Sex Practice
## Definitions
### <a name="SexPractice"></a> Sex Practice (`SexPractice`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The sex practice's identifier. An unique, increasing integer. | <a href="#SexPractice/id">See details</a>
`src` | | <a href="#SexPractice/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SexPractice/translations">See details</a>
#### <a name="SexPractice/id"></a> `id`
The sex practice's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SexPractice/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="SexPractice/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SexPracticeTranslation">SexPracticeTranslation</a>&gt;
---
### <a name="SexPracticeTranslation"></a> `SexPracticeTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The sex practice's name. | <a href="#SexPracticeTranslation/name">See details</a>
`rules` | The rules of the sex practice. | <a href="#SexPracticeTranslation/rules">See details</a>
`duration` | How long a round of this sex practice takes. | <a href="#SexPracticeTranslation/duration">See details</a>
`prerequisites?` | Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites. | <a href="#SexPracticeTranslation/prerequisites">See details</a>
`failed` | Effects of a failed *Seduction* check. | <a href="#SexPracticeTranslation/failed">See details</a>
#### <a name="SexPracticeTranslation/name"></a> `name`
The sex practice's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SexPracticeTranslation/rules"></a> `rules`
The rules of the sex practice.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SexPracticeTranslation/duration"></a> `duration`
How long a round of this sex practice takes.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SexPracticeTranslation/prerequisites"></a> `prerequisites?`
Prerequisites of participants and environment. Do not specify if the sex practice has no prerequisites.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SexPracticeTranslation/failed"></a> `failed`
Effects of a failed *Seduction* check.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Skill.md
-293
View File
@@ -1,293 +0,0 @@
# Skill
## Definitions
### <a name="Skill"></a> Skill (`Skill`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill's identifier. An unique, increasing integer. | <a href="#Skill/id">See details</a>
`check` | Lists the linked three attributes used to make a skill check. | <a href="#Skill/check">See details</a>
`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. | <a href="#Skill/applications">See details</a>
`encumbrance` | Indicates whether encumbrance gives a penalty for checks with the skill. | <a href="#Skill/encumbrance">See details</a>
`improvement_cost` | States which column is used to improve the skill. | <a href="#Skill/improvement_cost">See details</a>
`group` | The skill group this skill belongs to. | <a href="#Skill/group">See details</a>
`src` | | <a href="#Skill/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Skill/translations">See details</a>
#### <a name="Skill/id"></a> `id`
The skill's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Skill/check"></a> `check`
Lists the linked three attributes used to make a skill check.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="Skill/applications"></a> `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.
- **Type:** <a href="#Applications">Applications</a>
#### <a name="Skill/encumbrance"></a> `encumbrance`
Indicates whether encumbrance gives a penalty for checks with the skill.
- **Type:** <a href="#EncumbranceInfluence">EncumbranceInfluence</a>
#### <a name="Skill/improvement_cost"></a> `improvement_cost`
States which column is used to improve the skill.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="Skill/group"></a> `group`
The skill group this skill belongs to.
- **Type:** <a href="./_SimpleReferences.md#SkillGroupReference">SkillGroupReference</a>
#### <a name="Skill/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Skill/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SkillTranslation">SkillTranslation</a>&gt;
---
### <a name="SkillTranslation"></a> `SkillTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the skill. | <a href="#SkillTranslation/name">See details</a>
`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. | <a href="#SkillTranslation/applications_input_label">See details</a>
`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. | <a href="#SkillTranslation/encumbrance_description">See details</a>
`tools?` | Mentions any tools from the equipment list that are necessary to employ the skill. | <a href="#SkillTranslation/tools">See details</a>
`quality` | Gives examples of the effects that various QL might provide. | <a href="#SkillTranslation/quality">See details</a>
`failed` | Lists examples of results for a failed check. | <a href="#SkillTranslation/failed">See details</a>
`critical` | Lists examples of results for a critical success. | <a href="#SkillTranslation/critical">See details</a>
`botch` | Lists examples of results for botches. | <a href="#SkillTranslation/botch">See details</a>
`errata?` | | <a href="#SkillTranslation/errata">See details</a>
#### <a name="SkillTranslation/name"></a> `name`
The name of the skill.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SkillTranslation/applications_input_label"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SkillTranslation/encumbrance_description"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SkillTranslation/tools"></a> `tools?`
Mentions any tools from the equipment list that are necessary to employ the skill.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SkillTranslation/quality"></a> `quality`
Gives examples of the effects that various QL might provide.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SkillTranslation/failed"></a> `failed`
Lists examples of results for a failed check.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SkillTranslation/critical"></a> `critical`
Lists examples of results for a critical success.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SkillTranslation/botch"></a> `botch`
Lists examples of results for botches.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SkillTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="ApplicationCategory"></a> `ApplicationCategory`
A category. All available entries from the specified category will be included as separate applications.
- **Type:** Union
- **Cases:** <a href="#ApplicationCategory'0">ApplicationCategory'0</a> | <a href="#ApplicationCategory'1">ApplicationCategory'1</a> | <a href="#ApplicationCategory'2">ApplicationCategory'2</a>
---
### <a name="ApplicationCategory'0"></a> `ApplicationCategory'0`
- **Constant:** `"BlessedTraditions"`
---
### <a name="ApplicationCategory'1"></a> `ApplicationCategory'1`
- **Constant:** `"Diseases"`
---
### <a name="ApplicationCategory'2"></a> `ApplicationCategory'2`
- **Constant:** `"Regions"`
---
### <a name="Applications"></a> `Applications`
The skill's applications.
- **Type:** Union
- **Cases:** <a href="#Applications'Derived">Applications'Derived</a> | <a href="#Applications'Explicit">Applications'Explicit</a>
---
### <a name="Applications'Derived"></a> `Applications'Derived`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#Applications'Derived/tag">See details</a>
`derived` | | <a href="#Applications'Derived/derived">See details</a>
#### <a name="Applications'Derived/tag"></a> `tag`
- **Constant:** `"Derived"`
#### <a name="Applications'Derived/derived"></a> `derived`
- **Type:** <a href="#ApplicationCategory">ApplicationCategory</a>
---
### <a name="Applications'Explicit"></a> `Applications'Explicit`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#Applications'Explicit/tag">See details</a>
`explicit` | | <a href="#Applications'Explicit/explicit">See details</a>
#### <a name="Applications'Explicit/tag"></a> `tag`
- **Constant:** `"Explicit"`
#### <a name="Applications'Explicit/explicit"></a> `explicit`
- **Type:** <a href="#SpecificApplications">SpecificApplications</a>
---
### <a name="SpecificApplications"></a> `SpecificApplications`
A list of explicit applications.
- **Type:** List
- **Items:** <a href="#SpecificApplications[]">SpecificApplications[]</a>
---
### <a name="SpecificApplications[]"></a> `SpecificApplications[]`
- **Type:** <a href="#Application">Application</a>
---
### <a name="Application"></a> `Application`
An explicit skill application.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill application's identifier. An unique, increasing integer. | <a href="#Application/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Application/translations">See details</a>
#### <a name="Application/id"></a> `id`
The skill application's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Application/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ApplicationTranslation">ApplicationTranslation</a>&gt;
---
### <a name="ApplicationTranslation"></a> `ApplicationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The skill application's name. | <a href="#ApplicationTranslation/name">See details</a>
#### <a name="ApplicationTranslation/name"></a> `name`
The skill application's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="EncumbranceInfluence"></a> `EncumbranceInfluence`
Indicates whether encumbrance gives a penalty for checks with the skill.
- **Type:** Union
- **Cases:** <a href="#EncumbranceInfluence'0">EncumbranceInfluence'0</a> | <a href="#EncumbranceInfluence'1">EncumbranceInfluence'1</a> | <a href="#EncumbranceInfluence'2">EncumbranceInfluence'2</a>
---
### <a name="EncumbranceInfluence'0"></a> `EncumbranceInfluence'0`
- **Constant:** `"True"`
---
### <a name="EncumbranceInfluence'1"></a> `EncumbranceInfluence'1`
- **Constant:** `"False"`
---
### <a name="EncumbranceInfluence'2"></a> `EncumbranceInfluence'2`
- **Constant:** `"Maybe"`
docs/reference/SkillGroup.md
-55
View File
@@ -1,55 +0,0 @@
# Skill Group
## Definitions
### <a name="SkillGroup"></a> Skill Group (`SkillGroup`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill group's identifier. An unique, increasing integer. | <a href="#SkillGroup/id">See details</a>
`check` | The skill group check's attributes. | <a href="#SkillGroup/check">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SkillGroup/translations">See details</a>
#### <a name="SkillGroup/id"></a> `id`
The skill group's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SkillGroup/check"></a> `check`
The skill group check's attributes.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="SkillGroup/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SkillGroupTranslation">SkillGroupTranslation</a>&gt;
---
### <a name="SkillGroupTranslation"></a> `SkillGroupTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The skill group's name. | <a href="#SkillGroupTranslation/name">See details</a>
`long_name` | The skill group's long name. | <a href="#SkillGroupTranslation/long_name">See details</a>
#### <a name="SkillGroupTranslation/name"></a> `name`
The skill group's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SkillGroupTranslation/long_name"></a> `long_name`
The skill group's long name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/SkillModificationLevel.md
-188
View File
@@ -1,188 +0,0 @@
# Skill Modification Level
## Definitions
### <a name="SkillModificationLevel"></a> Skill Modification Level (`SkillModificationLevel`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The skill modification level's identifier. | <a href="#SkillModificationLevel/id">See details</a>
`fast` | Configuration for this level for fast skills (spells, liturgical chants). | <a href="#SkillModificationLevel/fast">See details</a>
`slow` | Configuration for this level for slow skills (rituals, ceremonies). | <a href="#SkillModificationLevel/slow">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SkillModificationLevel/translations">See details</a>
#### <a name="SkillModificationLevel/id"></a> `id`
The skill modification level's identifier.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `6`
#### <a name="SkillModificationLevel/fast"></a> `fast`
Configuration for this level for fast skills (spells, liturgical chants).
- **Type:** <a href="#FastSkillModificationLevelConfig">FastSkillModificationLevelConfig</a>
#### <a name="SkillModificationLevel/slow"></a> `slow`
Configuration for this level for slow skills (rituals, ceremonies).
- **Type:** <a href="#SlowSkillModificationLevelConfig">SlowSkillModificationLevelConfig</a>
#### <a name="SkillModificationLevel/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SkillModificationLevelTranslation">SkillModificationLevelTranslation</a>&gt;
---
### <a name="FastSkillModificationLevelConfig"></a> `FastSkillModificationLevelConfig`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`casting_time` | The casting time in actions. | <a href="#FastSkillModificationLevelConfig/casting_time">See details</a>
`range` | The range in meters. | <a href="#FastSkillModificationLevelConfig/range">See details</a>
`cost` | The cost in AE/KP. | <a href="#FastSkillModificationLevelConfig/cost">See details</a>
#### <a name="FastSkillModificationLevelConfig/casting_time"></a> `casting_time`
The casting time in actions.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FastSkillModificationLevelConfig/range"></a> `range`
The range in meters.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FastSkillModificationLevelConfig/cost"></a> `cost`
The cost in AE/KP.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="SlowSkillModificationLevelConfig"></a> `SlowSkillModificationLevelConfig`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`casting_time` | The casting time. | <a href="#SlowSkillModificationLevelConfig/casting_time">See details</a>
`range` | The range in meters. | <a href="#SlowSkillModificationLevelConfig/range">See details</a>
`cost` | The cost in AE/KP. | <a href="#SlowSkillModificationLevelConfig/cost">See details</a>
#### <a name="SlowSkillModificationLevelConfig/casting_time"></a> `casting_time`
The casting time.
- **Type:** <a href="#SlowSkillCastingTime">SlowSkillCastingTime</a>
#### <a name="SlowSkillModificationLevelConfig/range"></a> `range`
The range in meters.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SlowSkillModificationLevelConfig/cost"></a> `cost`
The cost in AE/KP.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="SlowSkillCastingTime"></a> `SlowSkillCastingTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) casting time. | <a href="#SlowSkillCastingTime/value">See details</a>
`unit` | The unit for the `value`. | <a href="#SlowSkillCastingTime/unit">See details</a>
#### <a name="SlowSkillCastingTime/value"></a> `value`
The (unitless) casting time.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SlowSkillCastingTime/unit"></a> `unit`
The unit for the `value`.
- **Type:** <a href="#SlowSkillCastingTimeUnit">SlowSkillCastingTimeUnit</a>
---
### <a name="SlowSkillCastingTimeUnit"></a> `SlowSkillCastingTimeUnit`
- **Type:** Union
- **Cases:** <a href="#SlowSkillCastingTimeUnit'0">SlowSkillCastingTimeUnit'0</a> | <a href="#SlowSkillCastingTimeUnit'1">SlowSkillCastingTimeUnit'1</a>
---
### <a name="SlowSkillCastingTimeUnit'0"></a> `SlowSkillCastingTimeUnit'0`
- **Constant:** `"Minutes"`
---
### <a name="SlowSkillCastingTimeUnit'1"></a> `SlowSkillCastingTimeUnit'1`
- **Constant:** `"Hours"`
---
### <a name="SkillModificationLevelTranslation"></a> `SkillModificationLevelTranslation`
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`fast?` | Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text. | <a href="#SkillModificationLevelTranslation/fast">See details</a>
`slow?` | Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text. | <a href="#SkillModificationLevelTranslation/slow">See details</a>
#### <a name="SkillModificationLevelTranslation/fast"></a> `fast?`
Configuration for this level for fast skills (spells, liturgical chants). Values set here override the default generated text.
- **Type:** <a href="#LevelTypeConfigTranslation">LevelTypeConfigTranslation</a>
#### <a name="SkillModificationLevelTranslation/slow"></a> `slow?`
Configuration for this level for slow skills (rituals, ceremonies). Values set here override the default generated text.
- **Type:** <a href="#LevelTypeConfigTranslation">LevelTypeConfigTranslation</a>
---
### <a name="LevelTypeConfigTranslation"></a> `LevelTypeConfigTranslation`
Configuration translation of a type for a level. Values set here override the default generated text.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`range` | | <a href="#LevelTypeConfigTranslation/range">See details</a>
#### <a name="LevelTypeConfigTranslation/range"></a> `range`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/SocialStatus.md
-41
View File
@@ -1,41 +0,0 @@
# Social Status
## Definitions
### <a name="SocialStatus"></a> Social Status (`SocialStatus`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The social status' identifier. An unique, increasing integer. | <a href="#SocialStatus/id">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SocialStatus/translations">See details</a>
#### <a name="SocialStatus/id"></a> `id`
The social status' identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SocialStatus/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SocialStatusTranslation">SocialStatusTranslation</a>&gt;
---
### <a name="SocialStatusTranslation"></a> `SocialStatusTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The social status name. | <a href="#SocialStatusTranslation/name">See details</a>
#### <a name="SocialStatusTranslation/name"></a> `name`
The social status name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/Spell.md
-142
View File
@@ -1,142 +0,0 @@
# Spell
## Definitions
### <a name="Spell"></a> Spell (`Spell`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The spell's identifier. An unique, increasing integer. | <a href="#Spell/id">See details</a>
`check` | Lists the linked three attributes used to make a skill check. | <a href="#Spell/check">See details</a>
`check_penalty?` | In some cases, the target's Spirit or Toughness is applied as a penalty. | <a href="#Spell/check_penalty">See details</a>
`parameters` | Measurable parameters of a spell. | <a href="#Spell/parameters">See details</a>
`target` | The target category – the kind of creature or object – the skill affects. | <a href="#Spell/target">See details</a>
`property` | The associated property. | <a href="#Spell/property">See details</a>
`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. | <a href="#Spell/traditions">See details</a>
`improvement_cost` | States which column is used to improve the skill. | <a href="#Spell/improvement_cost">See details</a>
`prerequisites?` | | <a href="#Spell/prerequisites">See details</a>
`src` | | <a href="#Spell/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Spell/translations">See details</a>
`enhancements?` | | <a href="#Spell/enhancements">See details</a>
#### <a name="Spell/id"></a> `id`
The spell's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Spell/check"></a> `check`
Lists the linked three attributes used to make a skill check.
- **Type:** <a href="./_SkillCheck.md#SkillCheck">SkillCheck</a>
#### <a name="Spell/check_penalty"></a> `check_penalty?`
In some cases, the target's Spirit or Toughness is applied as a penalty.
- **Type:** <a href="./_SkillCheck.md#SkillCheckPenalty">SkillCheckPenalty</a>
#### <a name="Spell/parameters"></a> `parameters`
Measurable parameters of a spell.
- **Type:** <a href="./_ActivatableSkill.md#FastPerformanceParameters">FastPerformanceParameters</a>
#### <a name="Spell/target"></a> `target`
The target category – the kind of creature or object – the skill affects.
- **Type:** <a href="./_ActivatableSkillTargetCategory.md#AffectedTargetCategories">AffectedTargetCategories</a>
#### <a name="Spell/property"></a> `property`
The associated property.
- **Type:** <a href="./_SimpleReferences.md#PropertyReference">PropertyReference</a>
#### <a name="Spell/traditions"></a> `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:** <a href="./_Spellwork.md#Traditions">Traditions</a>
#### <a name="Spell/improvement_cost"></a> `improvement_cost`
States which column is used to improve the skill.
- **Type:** <a href="./_ImprovementCost.md#ImprovementCost">ImprovementCost</a>
#### <a name="Spell/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#SpellworkPrerequisites">SpellworkPrerequisites</a>
#### <a name="Spell/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Spell/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SpellTranslation">SpellTranslation</a>&gt;
#### <a name="Spell/enhancements"></a> `enhancements?`
- **Type:** <a href="./_Enhancements.md#Enhancements">Enhancements</a>
---
### <a name="SpellTranslation"></a> `SpellTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the spell. | <a href="#SpellTranslation/name">See details</a>
`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. | <a href="#SpellTranslation/effect">See details</a>
`casting_time` | | <a href="#SpellTranslation/casting_time">See details</a>
`cost` | | <a href="#SpellTranslation/cost">See details</a>
`range` | | <a href="#SpellTranslation/range">See details</a>
`duration` | | <a href="#SpellTranslation/duration">See details</a>
`target` | | <a href="#SpellTranslation/target">See details</a>
`errata?` | | <a href="#SpellTranslation/errata">See details</a>
#### <a name="SpellTranslation/name"></a> `name`
The name of the spell.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="SpellTranslation/effect"></a> `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.
- **Type:** <a href="./_ActivatableSkillEffect.md#ActivatableSkillEffect">ActivatableSkillEffect</a>
#### <a name="SpellTranslation/casting_time"></a> `casting_time`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="SpellTranslation/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="SpellTranslation/range"></a> `range`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="SpellTranslation/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkill.md#OldParameter">OldParameter</a>
#### <a name="SpellTranslation/target"></a> `target`
- **Type:** String
#### <a name="SpellTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/State.md
-58
View File
@@ -1,58 +0,0 @@
# State
## Definitions
### <a name="State"></a> State (`State`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The state's identifier. An unique, increasing integer. | <a href="#State/id">See details</a>
`src` | | <a href="#State/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#State/translations">See details</a>
#### <a name="State/id"></a> `id`
The state's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="State/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="State/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#StateTranslation">StateTranslation</a>&gt;
---
### <a name="StateTranslation"></a> `StateTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the state. | <a href="#StateTranslation/name">See details</a>
`description` | The description of the state. | <a href="#StateTranslation/description">See details</a>
`errata?` | | <a href="#StateTranslation/errata">See details</a>
#### <a name="StateTranslation/name"></a> `name`
The name of the state.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="StateTranslation/description"></a> `description`
The description of the state.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="StateTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/Talisman.md
-157
View File
@@ -1,157 +0,0 @@
# Talisman
## Definitions
### <a name="Talisman"></a> Talisman (`Talisman`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The talisman's identifier. An unique, increasing integer. | <a href="#Talisman/id">See details</a>
`tradition` | The tradition(s) the talisman belongs to. | <a href="#Talisman/tradition">See details</a>
`type?` | The talisman type, if any. | <a href="#Talisman/type">See details</a>
`ap_value?` | The AP value for the required trade secret, if possible. | <a href="#Talisman/ap_value">See details</a>
`src` | | <a href="#Talisman/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Talisman/translations">See details</a>
#### <a name="Talisman/id"></a> `id`
The talisman's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Talisman/tradition"></a> `tradition`
The tradition(s) the talisman belongs to.
- **Type:** List
- **Items:** <a href="#Talisman/tradition[]">Talisman/tradition[]</a>
- **Minimum Items:** `1`
#### <a name="Talisman/type"></a> `type?`
The talisman type, if any.
- **Type:** <a href="#TalismanType">TalismanType</a>
#### <a name="Talisman/ap_value"></a> `ap_value?`
The AP value for the required trade secret, if possible.
- **Type:** Integer
- **Minimum:** `5`
- **Multiple of:** `5`
#### <a name="Talisman/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Talisman/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#TalismanTranslation">TalismanTranslation</a>&gt;
---
### <a name="Talisman/tradition[]"></a> `Talisman/tradition[]`
- **Type:** <a href="./_SimpleReferences.md#BlessedTraditionReference">BlessedTraditionReference</a>
---
### <a name="TalismanType"></a> `TalismanType`
- **Type:** Union
- **Cases:** <a href="#TalismanType'0">TalismanType'0</a> | <a href="#TalismanType'1">TalismanType'1</a> | <a href="#TalismanType'2">TalismanType'2</a> | <a href="#TalismanType'3">TalismanType'3</a> | <a href="#TalismanType'4">TalismanType'4</a>
---
### <a name="TalismanType'0"></a> `TalismanType'0`
- **Constant:** `"MainTalisman"`
---
### <a name="TalismanType'1"></a> `TalismanType'1`
- **Constant:** `"Talisman"`
---
### <a name="TalismanType'2"></a> `TalismanType'2`
- **Constant:** `"MinorTalisman"`
---
### <a name="TalismanType'3"></a> `TalismanType'3`
- **Constant:** `"Regalia"`
---
### <a name="TalismanType'4"></a> `TalismanType'4`
- **Constant:** `"PowerfulTalisman"`
---
### <a name="TalismanTranslation"></a> `TalismanTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the talisman. | <a href="#TalismanTranslation/name">See details</a>
`effect` | The effect description. | <a href="#TalismanTranslation/effect">See details</a>
`activation?` | The activation parameters. | <a href="#TalismanTranslation/activation">See details</a>
`errata?` | | <a href="#TalismanTranslation/errata">See details</a>
#### <a name="TalismanTranslation/name"></a> `name`
The name of the talisman.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="TalismanTranslation/effect"></a> `effect`
The effect description.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="TalismanTranslation/activation"></a> `activation?`
The activation parameters.
- **Type:** <a href="#TalismanActivationTranslation">TalismanActivationTranslation</a>
#### <a name="TalismanTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="TalismanActivationTranslation"></a> `TalismanActivationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The KP cost. | <a href="#TalismanActivationTranslation/cost">See details</a>
`duration` | The duration. | <a href="#TalismanActivationTranslation/duration">See details</a>
#### <a name="TalismanActivationTranslation/cost"></a> `cost`
The KP cost.
- **Type:** Integer
- **Minimum:** `0`
#### <a name="TalismanActivationTranslation/duration"></a> `duration`
The duration.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/TargetCategory.md
-66
View File
@@ -1,66 +0,0 @@
# Target Category
## Definitions
### <a name="TargetCategory"></a> Target Category (`TargetCategory`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The target category's identifier. An unique, increasing integer. | <a href="#TargetCategory/id">See details</a>
`parent?` | A superordinate target category, if present. | <a href="#TargetCategory/parent">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#TargetCategory/translations">See details</a>
#### <a name="TargetCategory/id"></a> `id`
The target category's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="TargetCategory/parent"></a> `parent?`
A superordinate target category, if present.
- **Type:** <a href="#TargetCategoryParent">TargetCategoryParent</a>
#### <a name="TargetCategory/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#TargetCategoryTranslation">TargetCategoryTranslation</a>&gt;
---
### <a name="TargetCategoryParent"></a> `TargetCategoryParent`
A superordinate target category, if present.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The identifier of the superordinate target category. | <a href="#TargetCategoryParent/id">See details</a>
#### <a name="TargetCategoryParent/id"></a> `id`
The identifier of the superordinate target category.
- **Type:** <a href="./_Identifier.md#TargetCategoryIdentifier">TargetCategoryIdentifier</a>
---
### <a name="TargetCategoryTranslation"></a> `TargetCategoryTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The target category name. | <a href="#TargetCategoryTranslation/name">See details</a>
#### <a name="TargetCategoryTranslation/name"></a> `name`
The target category name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/UI.md
-5613
View File
File diff suppressed because it is too large Load Diff
docs/reference/_Activatable.md
-3861
View File
File diff suppressed because it is too large Load Diff
docs/reference/_ActivatableSelectOptionCategory.md
-1344
View File
File diff suppressed because it is too large Load Diff
docs/reference/_ActivatableSkill.md
-192
View File
@@ -1,192 +0,0 @@
# Activatable Skill
## Definitions
### <a name="OneTimePerformanceParameters"></a> `OneTimePerformanceParameters<CastingTime>`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`casting_time` | | <a href="#OneTimePerformanceParameters/casting_time">See details</a>
`cost` | | <a href="#OneTimePerformanceParameters/cost">See details</a>
`range` | | <a href="#OneTimePerformanceParameters/range">See details</a>
`duration` | | <a href="#OneTimePerformanceParameters/duration">See details</a>
#### <a name="OneTimePerformanceParameters/casting_time"></a> `casting_time`
- **Type:** <a href="#CastingTime">CastingTime</a>
#### <a name="OneTimePerformanceParameters/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkillCost.md#OneTimeCost">OneTimeCost</a>
#### <a name="OneTimePerformanceParameters/range"></a> `range`
- **Type:** <a href="./_ActivatableSkillRange.md#Range">Range</a>
#### <a name="OneTimePerformanceParameters/duration"></a> `duration`
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationForOneTime">DurationForOneTime</a>
---
### <a name="SustainedPerformanceParameters"></a> `SustainedPerformanceParameters<CastingTime>`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`casting_time` | | <a href="#SustainedPerformanceParameters/casting_time">See details</a>
`cost` | | <a href="#SustainedPerformanceParameters/cost">See details</a>
`range` | | <a href="#SustainedPerformanceParameters/range">See details</a>
`duration?` | | <a href="#SustainedPerformanceParameters/duration">See details</a>
#### <a name="SustainedPerformanceParameters/casting_time"></a> `casting_time`
- **Type:** <a href="#CastingTime">CastingTime</a>
#### <a name="SustainedPerformanceParameters/cost"></a> `cost`
- **Type:** <a href="./_ActivatableSkillCost.md#SustainedCost">SustainedCost</a>
#### <a name="SustainedPerformanceParameters/range"></a> `range`
- **Type:** <a href="./_ActivatableSkillRange.md#Range">Range</a>
#### <a name="SustainedPerformanceParameters/duration"></a> `duration?`
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationForSustained">DurationForSustained</a>
---
### <a name="FastPerformanceParameters"></a> `FastPerformanceParameters`
- **Type:** Union
- **Cases:** <a href="#FastPerformanceParameters'OneTime">FastPerformanceParameters'OneTime</a> | <a href="#FastPerformanceParameters'Sustained">FastPerformanceParameters'Sustained</a>
---
### <a name="FastPerformanceParameters'OneTime"></a> `FastPerformanceParameters'OneTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FastPerformanceParameters'OneTime/tag">See details</a>
`one_time` | | <a href="#FastPerformanceParameters'OneTime/one_time">See details</a>
#### <a name="FastPerformanceParameters'OneTime/tag"></a> `tag`
- **Constant:** `"OneTime"`
#### <a name="FastPerformanceParameters'OneTime/one_time"></a> `one_time`
- **Type:** <a href="#FastOneTimePerformanceParameters">FastOneTimePerformanceParameters</a>
---
### <a name="FastPerformanceParameters'Sustained"></a> `FastPerformanceParameters'Sustained`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#FastPerformanceParameters'Sustained/tag">See details</a>
`sustained` | | <a href="#FastPerformanceParameters'Sustained/sustained">See details</a>
#### <a name="FastPerformanceParameters'Sustained/tag"></a> `tag`
- **Constant:** `"Sustained"`
#### <a name="FastPerformanceParameters'Sustained/sustained"></a> `sustained`
- **Type:** <a href="#FastSustainedPerformanceParameters">FastSustainedPerformanceParameters</a>
---
### <a name="FastOneTimePerformanceParameters"></a> `FastOneTimePerformanceParameters`
- **Type:** <a href="#OneTimePerformanceParameters">OneTimePerformanceParameters</a>&lt;<a href="./_ActivatableSkillCastingTime.md#FastCastingTime">FastCastingTime</a>&gt;
---
### <a name="FastSustainedPerformanceParameters"></a> `FastSustainedPerformanceParameters`
- **Type:** <a href="#SustainedPerformanceParameters">SustainedPerformanceParameters</a>&lt;<a href="./_ActivatableSkillCastingTime.md#FastCastingTime">FastCastingTime</a>&gt;
---
### <a name="SlowPerformanceParameters"></a> `SlowPerformanceParameters`
- **Type:** Union
- **Cases:** <a href="#SlowPerformanceParameters'OneTime">SlowPerformanceParameters'OneTime</a> | <a href="#SlowPerformanceParameters'Sustained">SlowPerformanceParameters'Sustained</a>
---
### <a name="SlowPerformanceParameters'OneTime"></a> `SlowPerformanceParameters'OneTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SlowPerformanceParameters'OneTime/tag">See details</a>
`one_time` | | <a href="#SlowPerformanceParameters'OneTime/one_time">See details</a>
#### <a name="SlowPerformanceParameters'OneTime/tag"></a> `tag`
- **Constant:** `"OneTime"`
#### <a name="SlowPerformanceParameters'OneTime/one_time"></a> `one_time`
- **Type:** <a href="#SlowOneTimePerformanceParameters">SlowOneTimePerformanceParameters</a>
---
### <a name="SlowPerformanceParameters'Sustained"></a> `SlowPerformanceParameters'Sustained`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SlowPerformanceParameters'Sustained/tag">See details</a>
`sustained` | | <a href="#SlowPerformanceParameters'Sustained/sustained">See details</a>
#### <a name="SlowPerformanceParameters'Sustained/tag"></a> `tag`
- **Constant:** `"Sustained"`
#### <a name="SlowPerformanceParameters'Sustained/sustained"></a> `sustained`
- **Type:** <a href="#SlowSustainedPerformanceParameters">SlowSustainedPerformanceParameters</a>
---
### <a name="SlowOneTimePerformanceParameters"></a> `SlowOneTimePerformanceParameters`
- **Type:** <a href="#OneTimePerformanceParameters">OneTimePerformanceParameters</a>&lt;<a href="./_ActivatableSkillCastingTime.md#SlowCastingTime">SlowCastingTime</a>&gt;
---
### <a name="SlowSustainedPerformanceParameters"></a> `SlowSustainedPerformanceParameters`
- **Type:** <a href="#SustainedPerformanceParameters">SustainedPerformanceParameters</a>&lt;<a href="./_ActivatableSkillCastingTime.md#SlowCastingTime">SlowCastingTime</a>&gt;
---
### <a name="OldParameter"></a> `OldParameter`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`full` | | <a href="#OldParameter/full">See details</a>
`abbr` | | <a href="#OldParameter/abbr">See details</a>
#### <a name="OldParameter/full"></a> `full`
- **Type:** String
#### <a name="OldParameter/abbr"></a> `abbr`
- **Type:** String
docs/reference/_ActivatableSkillCastingTime.md
-188
View File
@@ -1,188 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="CastingTime"></a> `CastingTime<NonModifiable>`
- **Type:** Union
- **Cases:** <a href="#CastingTime'Modifiable">CastingTime'Modifiable</a> | <a href="#CastingTime'NonModifiable">CastingTime'NonModifiable</a>
---
### <a name="CastingTime'Modifiable"></a> `CastingTime'Modifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CastingTime'Modifiable/tag">See details</a>
`modifiable` | | <a href="#CastingTime'Modifiable/modifiable">See details</a>
#### <a name="CastingTime'Modifiable/tag"></a> `tag`
- **Constant:** `"Modifiable"`
#### <a name="CastingTime'Modifiable/modifiable"></a> `modifiable`
- **Type:** <a href="#ModifiableCastingTime">ModifiableCastingTime</a>
---
### <a name="CastingTime'NonModifiable"></a> `CastingTime'NonModifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#CastingTime'NonModifiable/tag">See details</a>
`non_modifiable` | | <a href="#CastingTime'NonModifiable/non_modifiable">See details</a>
#### <a name="CastingTime'NonModifiable/tag"></a> `tag`
- **Constant:** `"NonModifiable"`
#### <a name="CastingTime'NonModifiable/non_modifiable"></a> `non_modifiable`
- **Type:** <a href="#NonModifiable">NonModifiable</a>
---
### <a name="ModifiableCastingTime"></a> `ModifiableCastingTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`initial_modification_level` | The initial skill modification identifier/level. | <a href="#ModifiableCastingTime/initial_modification_level">See details</a>
#### <a name="ModifiableCastingTime/initial_modification_level"></a> `initial_modification_level`
The initial skill modification identifier/level.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `6`
---
### <a name="CastingTimeIncludingLovemaking"></a> `CastingTimeIncludingLovemaking<NonModifiable>`
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.
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`default?` | The default casting time definition. | <a href="#CastingTimeIncludingLovemaking/default">See details</a>
`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. | <a href="#CastingTimeIncludingLovemaking/during_lovemaking">See details</a>
#### <a name="CastingTimeIncludingLovemaking/default"></a> `default?`
The default casting time definition.
- **Type:** <a href="#CastingTime">CastingTime</a>&lt;<a href="#NonModifiable">NonModifiable</a>&gt;
#### <a name="CastingTimeIncludingLovemaking/during_lovemaking"></a> `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:** <a href="#CastingTimeDuringLovemaking">CastingTimeDuringLovemaking</a>
---
### <a name="CastingTimeDuringLovemaking"></a> `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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) casting time value. | <a href="#CastingTimeDuringLovemaking/value">See details</a>
`unit` | The unit of the `value`. | <a href="#CastingTimeDuringLovemaking/unit">See details</a>
#### <a name="CastingTimeDuringLovemaking/value"></a> `value`
The (unitless) casting time value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="CastingTimeDuringLovemaking/unit"></a> `unit`
The unit of the `value`.
- **Type:** <a href="#CastingTimeDuringLovemakingUnit">CastingTimeDuringLovemakingUnit</a>
---
### <a name="CastingTimeDuringLovemakingUnit"></a> `CastingTimeDuringLovemakingUnit`
- **Type:** Union
- **Cases:** <a href="#CastingTimeDuringLovemakingUnit'0">CastingTimeDuringLovemakingUnit'0</a> | <a href="#CastingTimeDuringLovemakingUnit'1">CastingTimeDuringLovemakingUnit'1</a>
---
### <a name="CastingTimeDuringLovemakingUnit'0"></a> `CastingTimeDuringLovemakingUnit'0`
- **Constant:** `"SeductionActions"`
---
### <a name="CastingTimeDuringLovemakingUnit'1"></a> `CastingTimeDuringLovemakingUnit'1`
- **Constant:** `"Rounds"`
---
### <a name="FastSkillNonModifiableCastingTime"></a> `FastSkillNonModifiableCastingTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`actions` | The casting time value in actions. | <a href="#FastSkillNonModifiableCastingTime/actions">See details</a>
#### <a name="FastSkillNonModifiableCastingTime/actions"></a> `actions`
The casting time value in actions.
- **Type:** Integer
- **Minimum:** `1`
---
### <a name="SlowSkillNonModifiableCastingTime"></a> `SlowSkillNonModifiableCastingTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) casting time value. | <a href="#SlowSkillNonModifiableCastingTime/value">See details</a>
`unit` | | <a href="#SlowSkillNonModifiableCastingTime/unit">See details</a>
#### <a name="SlowSkillNonModifiableCastingTime/value"></a> `value`
The (unitless) casting time value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="SlowSkillNonModifiableCastingTime/unit"></a> `unit`
- **Type:** <a href="./SkillModificationLevel.md#SlowSkillCastingTimeUnit">SlowSkillCastingTimeUnit</a>
---
### <a name="FastCastingTime"></a> `FastCastingTime`
- **Type:** <a href="#CastingTimeIncludingLovemaking">CastingTimeIncludingLovemaking</a>&lt;<a href="#FastSkillNonModifiableCastingTime">FastSkillNonModifiableCastingTime</a>&gt;
---
### <a name="SlowCastingTime"></a> `SlowCastingTime`
- **Type:** <a href="#CastingTimeIncludingLovemaking">CastingTimeIncludingLovemaking</a>&lt;<a href="#SlowSkillNonModifiableCastingTime">SlowSkillNonModifiableCastingTime</a>&gt;
docs/reference/_ActivatableSkillCheckResultBased.md
-92
View File
@@ -1,92 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="CheckResultValue"></a> `CheckResultValue`
Defines the derived (unitless) value.
- **Type:** Union
- **Cases:** <a href="#CheckResultValue'0">CheckResultValue'0</a> | <a href="#CheckResultValue'1">CheckResultValue'1</a>
---
### <a name="CheckResultValue'0"></a> `CheckResultValue'0`
- **Constant:** `"QualityLevels"`
---
### <a name="CheckResultValue'1"></a> `CheckResultValue'1`
- **Constant:** `"SkillPoints"`
---
### <a name="CheckResultArithmetic"></a> `CheckResultArithmetic`
Defines how the the `value` is set off against the check result.
- **Type:** Union
- **Cases:** <a href="#CheckResultArithmetic'0">CheckResultArithmetic'0</a> | <a href="#CheckResultArithmetic'1">CheckResultArithmetic'1</a>
---
### <a name="CheckResultArithmetic'0"></a> `CheckResultArithmetic'0`
- **Constant:** `"Multiply"`
---
### <a name="CheckResultArithmetic'1"></a> `CheckResultArithmetic'1`
- **Constant:** `"Divide"`
---
### <a name="CheckResultBasedModifier"></a> `CheckResultBasedModifier`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`arithmetic` | The arithmetic how to apply the `value` to the `base`. | <a href="#CheckResultBasedModifier/arithmetic">See details</a>
`value` | The value that is applied to the `base` using the defined `arithmetic`. | <a href="#CheckResultBasedModifier/value">See details</a>
#### <a name="CheckResultBasedModifier/arithmetic"></a> `arithmetic`
The arithmetic how to apply the `value` to the `base`.
- **Type:** <a href="#CheckResultArithmetic">CheckResultArithmetic</a>
#### <a name="CheckResultBasedModifier/value"></a> `value`
The value that is applied to the `base` using the defined `arithmetic`.
- **Type:** Integer
- **Minimum:** `2`
---
### <a name="CheckResultBased"></a> `CheckResultBased`
Defines a parameter being based on a check result.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`base` | The base value that is derived from the check result. | <a href="#CheckResultBased/base">See details</a>
`modifier?` | If defined, it modifies the base value. | <a href="#CheckResultBased/modifier">See details</a>
#### <a name="CheckResultBased/base"></a> `base`
The base value that is derived from the check result.
- **Type:** <a href="#CheckResultValue">CheckResultValue</a>
#### <a name="CheckResultBased/modifier"></a> `modifier?`
If defined, it modifies the base value.
- **Type:** <a href="#CheckResultBasedModifier">CheckResultBasedModifier</a>
docs/reference/_ActivatableSkillCost.md
-626
View File
@@ -1,626 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="OneTimeCost"></a> `OneTimeCost`
- **Type:** Union
- **Cases:** <a href="#OneTimeCost'Single">OneTimeCost'Single</a> | <a href="#OneTimeCost'Conjunction">OneTimeCost'Conjunction</a> | <a href="#OneTimeCost'Disjunction">OneTimeCost'Disjunction</a> | <a href="#OneTimeCost'Map">OneTimeCost'Map</a>
---
### <a name="OneTimeCost'Single"></a> `OneTimeCost'Single`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#OneTimeCost'Single/tag">See details</a>
`single` | | <a href="#OneTimeCost'Single/single">See details</a>
#### <a name="OneTimeCost'Single/tag"></a> `tag`
- **Constant:** `"Single"`
#### <a name="OneTimeCost'Single/single"></a> `single`
- **Type:** <a href="#SingleOneTimeCost">SingleOneTimeCost</a>
---
### <a name="OneTimeCost'Conjunction"></a> `OneTimeCost'Conjunction`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#OneTimeCost'Conjunction/tag">See details</a>
`conjunction` | | <a href="#OneTimeCost'Conjunction/conjunction">See details</a>
#### <a name="OneTimeCost'Conjunction/tag"></a> `tag`
- **Constant:** `"Conjunction"`
#### <a name="OneTimeCost'Conjunction/conjunction"></a> `conjunction`
- **Type:** <a href="#MultipleOneTimeCosts">MultipleOneTimeCosts</a>
---
### <a name="OneTimeCost'Disjunction"></a> `OneTimeCost'Disjunction`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#OneTimeCost'Disjunction/tag">See details</a>
`disjunction` | | <a href="#OneTimeCost'Disjunction/disjunction">See details</a>
#### <a name="OneTimeCost'Disjunction/tag"></a> `tag`
- **Constant:** `"Disjunction"`
#### <a name="OneTimeCost'Disjunction/disjunction"></a> `disjunction`
- **Type:** <a href="#MultipleOneTimeCosts">MultipleOneTimeCosts</a>
---
### <a name="OneTimeCost'Map"></a> `OneTimeCost'Map`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#OneTimeCost'Map/tag">See details</a>
`map` | | <a href="#OneTimeCost'Map/map">See details</a>
#### <a name="OneTimeCost'Map/tag"></a> `tag`
- **Constant:** `"Map"`
#### <a name="OneTimeCost'Map/map"></a> `map`
- **Type:** <a href="#CostMap">CostMap</a>
---
### <a name="SingleOneTimeCost"></a> `SingleOneTimeCost`
- **Type:** Union
- **Cases:** <a href="#SingleOneTimeCost'Modifiable">SingleOneTimeCost'Modifiable</a> | <a href="#SingleOneTimeCost'NonModifiable">SingleOneTimeCost'NonModifiable</a> | <a href="#SingleOneTimeCost'Indefinite">SingleOneTimeCost'Indefinite</a>
---
### <a name="SingleOneTimeCost'Modifiable"></a> `SingleOneTimeCost'Modifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SingleOneTimeCost'Modifiable/tag">See details</a>
`modifiable` | | <a href="#SingleOneTimeCost'Modifiable/modifiable">See details</a>
#### <a name="SingleOneTimeCost'Modifiable/tag"></a> `tag`
- **Constant:** `"Modifiable"`
#### <a name="SingleOneTimeCost'Modifiable/modifiable"></a> `modifiable`
- **Type:** <a href="#ModifiableOneTimeCost">ModifiableOneTimeCost</a>
---
### <a name="SingleOneTimeCost'NonModifiable"></a> `SingleOneTimeCost'NonModifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SingleOneTimeCost'NonModifiable/tag">See details</a>
`non_modifiable` | | <a href="#SingleOneTimeCost'NonModifiable/non_modifiable">See details</a>
#### <a name="SingleOneTimeCost'NonModifiable/tag"></a> `tag`
- **Constant:** `"NonModifiable"`
#### <a name="SingleOneTimeCost'NonModifiable/non_modifiable"></a> `non_modifiable`
- **Type:** <a href="#NonModifiableOneTimeCost">NonModifiableOneTimeCost</a>
---
### <a name="SingleOneTimeCost'Indefinite"></a> `SingleOneTimeCost'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SingleOneTimeCost'Indefinite/tag">See details</a>
`indefinite` | | <a href="#SingleOneTimeCost'Indefinite/indefinite">See details</a>
#### <a name="SingleOneTimeCost'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="SingleOneTimeCost'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#IndefiniteOneTimeCost">IndefiniteOneTimeCost</a>
---
### <a name="MultipleOneTimeCosts"></a> `MultipleOneTimeCosts`
- **Type:** List
- **Items:** <a href="#MultipleOneTimeCosts[]">MultipleOneTimeCosts[]</a>
- **Minimum Items:** `2`
---
### <a name="MultipleOneTimeCosts[]"></a> `MultipleOneTimeCosts[]`
- **Type:** <a href="#SingleOneTimeCost">SingleOneTimeCost</a>
---
### <a name="ModifiableOneTimeCost"></a> `ModifiableOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`initial_modification_level` | The initial skill modification identifier/level. | <a href="#ModifiableOneTimeCost/initial_modification_level">See details</a>
`permanent_value?` | The part of the cost value that has to be spent permanently. | <a href="#ModifiableOneTimeCost/permanent_value">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#ModifiableOneTimeCost/translations">See details</a>
#### <a name="ModifiableOneTimeCost/initial_modification_level"></a> `initial_modification_level`
The initial skill modification identifier/level.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `6`
#### <a name="ModifiableOneTimeCost/permanent_value"></a> `permanent_value?`
The part of the cost value that has to be spent permanently.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="ModifiableOneTimeCost/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ModifiableOneTimeCostTranslation">ModifiableOneTimeCostTranslation</a>&gt;
---
### <a name="ModifiableOneTimeCostTranslation"></a> `ModifiableOneTimeCostTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement` | A replacement string. | <a href="#ModifiableOneTimeCostTranslation/replacement">See details</a>
#### <a name="ModifiableOneTimeCostTranslation/replacement"></a> `replacement`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="NonModifiableOneTimeCost"></a> `NonModifiableOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_minimum?` | If `true`, the non-modifiable value is a minimum value. | <a href="#NonModifiableOneTimeCost/is_minimum">See details</a>
`value` | The AE cost value. | <a href="#NonModifiableOneTimeCost/value">See details</a>
`permanent_value?` | The part of the cost value that has to be spent permanently. | <a href="#NonModifiableOneTimeCost/permanent_value">See details</a>
`per?` | The cost have to be per a specific countable entity, e.g. `8 KP per person`. | <a href="#NonModifiableOneTimeCost/per">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#NonModifiableOneTimeCost/translations">See details</a>
#### <a name="NonModifiableOneTimeCost/is_minimum"></a> `is_minimum?`
If `true`, the non-modifiable value is a minimum value.
- **Type:** Boolean
#### <a name="NonModifiableOneTimeCost/value"></a> `value`
The AE cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="NonModifiableOneTimeCost/permanent_value"></a> `permanent_value?`
The part of the cost value that has to be spent permanently.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="NonModifiableOneTimeCost/per"></a> `per?`
The cost have to be per a specific countable entity, e.g. `8 KP per person`.
- **Type:** <a href="#NonModifiableOneTimeCostPerCountable">NonModifiableOneTimeCostPerCountable</a>
#### <a name="NonModifiableOneTimeCost/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag
(BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#NonModifiableOneTimeCostTranslation">NonModifiableOneTimeCostTranslation</a>&gt;
---
### <a name="NonModifiableOneTimeCostPerCountable"></a> `NonModifiableOneTimeCostPerCountable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`minimum_total?` | If defined, the minimum total AE that have to be spent casting the skill. | <a href="#NonModifiableOneTimeCostPerCountable/minimum_total">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#NonModifiableOneTimeCostPerCountable/translations">See details</a>
#### <a name="NonModifiableOneTimeCostPerCountable/minimum_total"></a> `minimum_total?`
If defined, the minimum total AE that have to be spent casting the skill.
- **Type:** Number
#### <a name="NonModifiableOneTimeCostPerCountable/translations"></a> `translations`
All translations for the entry, identified by IETF language tag
(BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#NonModifiableOneTimeCostPerCountableTranslation">NonModifiableOneTimeCostPerCountableTranslation</a>&gt;
---
### <a name="NonModifiableOneTimeCostPerCountableTranslation"></a> `NonModifiableOneTimeCostPerCountableTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`countable` | The countable entity name. | <a href="#NonModifiableOneTimeCostPerCountableTranslation/countable">See details</a>
#### <a name="NonModifiableOneTimeCostPerCountableTranslation/countable"></a> `countable`
The countable entity name.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="NonModifiableOneTimeCostTranslation"></a> `NonModifiableOneTimeCostTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`note` | A note, appended to the generated string in parenthesis. | <a href="#NonModifiableOneTimeCostTranslation/note">See details</a>
#### <a name="NonModifiableOneTimeCostTranslation/note"></a> `note`
A note, appended to the generated string in parenthesis.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextOptional">ResponsiveTextOptional</a>
---
### <a name="IndefiniteOneTimeCost"></a> `IndefiniteOneTimeCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IndefiniteOneTimeCost/translations">See details</a>
#### <a name="IndefiniteOneTimeCost/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#IndefiniteOneTimeCostTranslation">IndefiniteOneTimeCostTranslation</a>&gt;
---
### <a name="IndefiniteOneTimeCostTranslation"></a> `IndefiniteOneTimeCostTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of where the cost come from. | <a href="#IndefiniteOneTimeCostTranslation/description">See details</a>
#### <a name="IndefiniteOneTimeCostTranslation/description"></a> `description`
A description of where the cost come from.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="CostMap"></a> `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:
```yaml
options:
- value: 2
label: "cup"
- value: 4
label: "chest"
- value: 8
label: "door"
- value: 16
label: "castle gate"
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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`options` | The possible costs and associated labels. | <a href="#CostMap/options">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CostMap/translations">See details</a>
#### <a name="CostMap/options"></a> `options`
The possible costs and associated labels.
- **Type:** List
- **Items:** <a href="#CostMap/options[]">CostMap/options[]</a>
- **Minimum Items:** `2`
#### <a name="CostMap/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CostMapTranslation">CostMapTranslation</a>&gt;
---
### <a name="CostMap/options[]"></a> `CostMap/options[]`
- **Type:** <a href="#CostMapOption">CostMapOption</a>
---
### <a name="CostMapOption"></a> `CostMapOption`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The full cost value for this option. | <a href="#CostMapOption/value">See details</a>
`permanent_value?` | The part of the `value` that has to be paid permanently. | <a href="#CostMapOption/permanent_value">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CostMapOption/translations">See details</a>
#### <a name="CostMapOption/value"></a> `value`
The full cost value for this option.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="CostMapOption/permanent_value"></a> `permanent_value?`
The part of the `value` that has to be paid permanently.
- **Type:** Integer
- **Minimum:** `0`
#### <a name="CostMapOption/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CostMapOptionTranslation">CostMapOptionTranslation</a>&gt;
---
### <a name="CostMapOptionTranslation"></a> `CostMapOptionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`label` | The description of the option for cost string generation. | <a href="#CostMapOptionTranslation/label">See details</a>
`label_standalone?` | The description of the option if used standalone. Only used if different from `label`. | <a href="#CostMapOptionTranslation/label_standalone">See details</a>
#### <a name="CostMapOptionTranslation/label"></a> `label`
The description of the option for cost string generation.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CostMapOptionTranslation/label_standalone"></a> `label_standalone?`
The description of the option if used standalone. Only used if different from `label`.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="CostMapTranslation"></a> `CostMapTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`list_prepend?` | Place a string between the `for` and the grouped map option labels. | <a href="#CostMapTranslation/list_prepend">See details</a>
`list_append?` | Place a string after the grouped map option labels. | <a href="#CostMapTranslation/list_append">See details</a>
`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. | <a href="#CostMapTranslation/replacement">See details</a>
#### <a name="CostMapTranslation/list_prepend"></a> `list_prepend?`
Place a string between the `for` and the grouped map option labels.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CostMapTranslation/list_append"></a> `list_append?`
Place a string after the grouped map option labels.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CostMapTranslation/replacement"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="SustainedCost"></a> `SustainedCost`
- **Type:** Union
- **Cases:** <a href="#SustainedCost'Modifiable">SustainedCost'Modifiable</a> | <a href="#SustainedCost'NonModifiable">SustainedCost'NonModifiable</a>
---
### <a name="SustainedCost'Modifiable"></a> `SustainedCost'Modifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SustainedCost'Modifiable/tag">See details</a>
`modifiable` | | <a href="#SustainedCost'Modifiable/modifiable">See details</a>
#### <a name="SustainedCost'Modifiable/tag"></a> `tag`
- **Constant:** `"Modifiable"`
#### <a name="SustainedCost'Modifiable/modifiable"></a> `modifiable`
- **Type:** <a href="#ModifiableSustainedCost">ModifiableSustainedCost</a>
---
### <a name="SustainedCost'NonModifiable"></a> `SustainedCost'NonModifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SustainedCost'NonModifiable/tag">See details</a>
`non_modifiable` | | <a href="#SustainedCost'NonModifiable/non_modifiable">See details</a>
#### <a name="SustainedCost'NonModifiable/tag"></a> `tag`
- **Constant:** `"NonModifiable"`
#### <a name="SustainedCost'NonModifiable/non_modifiable"></a> `non_modifiable`
- **Type:** <a href="#NonModifiableSustainedCost">NonModifiableSustainedCost</a>
---
### <a name="ModifiableSustainedCost"></a> `ModifiableSustainedCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`initial_modification_level` | The initial skill modification identifier/level. | <a href="#ModifiableSustainedCost/initial_modification_level">See details</a>
`interval` | The sustain interval. | <a href="#ModifiableSustainedCost/interval">See details</a>
#### <a name="ModifiableSustainedCost/initial_modification_level"></a> `initial_modification_level`
The initial skill modification identifier/level.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `6`
#### <a name="ModifiableSustainedCost/interval"></a> `interval`
The sustain interval.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnitValue">DurationUnitValue</a>
---
### <a name="NonModifiableSustainedCost"></a> `NonModifiableSustainedCost`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_minimum?` | If `true`, the non-modifiable value is a minimum value. | <a href="#NonModifiableSustainedCost/is_minimum">See details</a>
`value` | The AE cost value. | <a href="#NonModifiableSustainedCost/value">See details</a>
`per?` | The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`. | <a href="#NonModifiableSustainedCost/per">See details</a>
`interval` | The sustain interval. | <a href="#NonModifiableSustainedCost/interval">See details</a>
#### <a name="NonModifiableSustainedCost/is_minimum"></a> `is_minimum?`
If `true`, the non-modifiable value is a minimum value.
- **Type:** Boolean
#### <a name="NonModifiableSustainedCost/value"></a> `value`
The AE cost value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="NonModifiableSustainedCost/per"></a> `per?`
The cost have to be per a specific countable entity, e.g. `8 KP per person per 5 minutes`.
- **Type:** <a href="#NonModifiableSustainedCostPerCountable">NonModifiableSustainedCostPerCountable</a>
#### <a name="NonModifiableSustainedCost/interval"></a> `interval`
The sustain interval.
- **Type:** <a href="./_ActivatableSkillDuration.md#DurationUnitValue">DurationUnitValue</a>
---
### <a name="NonModifiableSustainedCostPerCountable"></a> `NonModifiableSustainedCostPerCountable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`minimum_total?` | If defined, the minimum total AE that have to be spent casting the skill. | <a href="#NonModifiableSustainedCostPerCountable/minimum_total">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#NonModifiableSustainedCostPerCountable/translations">See details</a>
#### <a name="NonModifiableSustainedCostPerCountable/minimum_total"></a> `minimum_total?`
If defined, the minimum total AE that have to be spent casting the skill.
- **Type:** Number
#### <a name="NonModifiableSustainedCostPerCountable/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#NonModifiableSustainedCostPerCountableTranslation">NonModifiableSustainedCostPerCountableTranslation</a>&gt;
---
### <a name="NonModifiableSustainedCostPerCountableTranslation"></a> `NonModifiableSustainedCostPerCountableTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`countable` | The countable entity name. | <a href="#NonModifiableSustainedCostPerCountableTranslation/countable">See details</a>
#### <a name="NonModifiableSustainedCostPerCountableTranslation/countable"></a> `countable`
The countable entity name.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
docs/reference/_ActivatableSkillDuration.md
-429
View File
@@ -1,429 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="DurationForOneTime"></a> `DurationForOneTime`
- **Type:** Union
- **Cases:** <a href="#DurationForOneTime'Immediate">DurationForOneTime'Immediate</a> | <a href="#DurationForOneTime'Permanent">DurationForOneTime'Permanent</a> | <a href="#DurationForOneTime'Fixed">DurationForOneTime'Fixed</a> | <a href="#DurationForOneTime'CheckResultBased">DurationForOneTime'CheckResultBased</a> | <a href="#DurationForOneTime'Indefinite">DurationForOneTime'Indefinite</a>
---
### <a name="DurationForOneTime'Immediate"></a> `DurationForOneTime'Immediate`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#DurationForOneTime'Immediate/tag">See details</a>
`immediate` | | <a href="#DurationForOneTime'Immediate/immediate">See details</a>
#### <a name="DurationForOneTime'Immediate/tag"></a> `tag`
- **Constant:** `"Immediate"`
#### <a name="DurationForOneTime'Immediate/immediate"></a> `immediate`
- **Type:** <a href="#Immediate">Immediate</a>
---
### <a name="DurationForOneTime'Permanent"></a> `DurationForOneTime'Permanent`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#DurationForOneTime'Permanent/tag">See details</a>
`permanent` | | <a href="#DurationForOneTime'Permanent/permanent">See details</a>
#### <a name="DurationForOneTime'Permanent/tag"></a> `tag`
- **Constant:** `"Permanent"`
#### <a name="DurationForOneTime'Permanent/permanent"></a> `permanent`
- **Type:** <a href="#PermanentDuration">PermanentDuration</a>
---
### <a name="DurationForOneTime'Fixed"></a> `DurationForOneTime'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#DurationForOneTime'Fixed/tag">See details</a>
`fixed` | | <a href="#DurationForOneTime'Fixed/fixed">See details</a>
#### <a name="DurationForOneTime'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="DurationForOneTime'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FixedDuration">FixedDuration</a>
---
### <a name="DurationForOneTime'CheckResultBased"></a> `DurationForOneTime'CheckResultBased`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#DurationForOneTime'CheckResultBased/tag">See details</a>
`check_result_based` | | <a href="#DurationForOneTime'CheckResultBased/check_result_based">See details</a>
#### <a name="DurationForOneTime'CheckResultBased/tag"></a> `tag`
- **Constant:** `"CheckResultBased"`
#### <a name="DurationForOneTime'CheckResultBased/check_result_based"></a> `check_result_based`
- **Type:** <a href="#CheckResultBasedDuration">CheckResultBasedDuration</a>
---
### <a name="DurationForOneTime'Indefinite"></a> `DurationForOneTime'Indefinite`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#DurationForOneTime'Indefinite/tag">See details</a>
`indefinite` | | <a href="#DurationForOneTime'Indefinite/indefinite">See details</a>
#### <a name="DurationForOneTime'Indefinite/tag"></a> `tag`
- **Constant:** `"Indefinite"`
#### <a name="DurationForOneTime'Indefinite/indefinite"></a> `indefinite`
- **Type:** <a href="#IndefiniteDuration">IndefiniteDuration</a>
---
### <a name="Immediate"></a> `Immediate`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`maximum?` | Specified if the duration has a maximum time span. | <a href="#Immediate/maximum">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Immediate/translations">See details</a>
#### <a name="Immediate/maximum"></a> `maximum?`
Specified if the duration has a maximum time span.
- **Type:** <a href="#DurationUnitValue">DurationUnitValue</a>
#### <a name="Immediate/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ImmediateTranslation">ImmediateTranslation</a>&gt;
---
### <a name="ImmediateTranslation"></a> `ImmediateTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement` | A replacement string. | <a href="#ImmediateTranslation/replacement">See details</a>
#### <a name="ImmediateTranslation/replacement"></a> `replacement`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="PermanentDuration"></a> `PermanentDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PermanentDuration/translations">See details</a>
#### <a name="PermanentDuration/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#PermanentDurationTranslation">PermanentDurationTranslation</a>&gt;
---
### <a name="PermanentDurationTranslation"></a> `PermanentDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement` | A replacement string. | <a href="#PermanentDurationTranslation/replacement">See details</a>
#### <a name="PermanentDurationTranslation/replacement"></a> `replacement`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="FixedDuration"></a> `FixedDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If the duration is the maximum duration, so it may end earlier. | <a href="#FixedDuration/is_maximum">See details</a>
`value` | The (unitless) duration. | <a href="#FixedDuration/value">See details</a>
`unit` | The duration unit. | <a href="#FixedDuration/unit">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#FixedDuration/translations">See details</a>
#### <a name="FixedDuration/is_maximum"></a> `is_maximum?`
If the duration is the maximum duration, so it may end earlier.
- **Constant:** `true`
#### <a name="FixedDuration/value"></a> `value`
The (unitless) duration.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FixedDuration/unit"></a> `unit`
The duration unit.
- **Type:** <a href="#DurationUnit">DurationUnit</a>
#### <a name="FixedDuration/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#FixedDurationTranslation">FixedDurationTranslation</a>&gt;
---
### <a name="FixedDurationTranslation"></a> `FixedDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement` | A replacement string. | <a href="#FixedDurationTranslation/replacement">See details</a>
#### <a name="FixedDurationTranslation/replacement"></a> `replacement`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="CheckResultBasedDuration"></a> `CheckResultBasedDuration`
Defines the duration being based on a check result.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If the duration is the maximum duration, so it may end earlier. | <a href="#CheckResultBasedDuration/is_maximum">See details</a>
`base` | The base value that is derived from the check result. | <a href="#CheckResultBasedDuration/base">See details</a>
`modifier?` | If defined, it modifies the base value. | <a href="#CheckResultBasedDuration/modifier">See details</a>
`unit` | The duration unit. | <a href="#CheckResultBasedDuration/unit">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CheckResultBasedDuration/translations">See details</a>
#### <a name="CheckResultBasedDuration/is_maximum"></a> `is_maximum?`
If the duration is the maximum duration, so it may end earlier.
- **Constant:** `true`
#### <a name="CheckResultBasedDuration/base"></a> `base`
The base value that is derived from the check result.
- **Type:** <a href="./_ActivatableSkillCheckResultBased.md#CheckResultValue">CheckResultValue</a>
#### <a name="CheckResultBasedDuration/modifier"></a> `modifier?`
If defined, it modifies the base value.
- **Type:** <a href="./_ActivatableSkillCheckResultBased.md#CheckResultBasedModifier">CheckResultBasedModifier</a>
#### <a name="CheckResultBasedDuration/unit"></a> `unit`
The duration unit.
- **Type:** <a href="#DurationUnit">DurationUnit</a>
#### <a name="CheckResultBasedDuration/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CheckResultBasedDurationTranslation">CheckResultBasedDurationTranslation</a>&gt;
---
### <a name="CheckResultBasedDurationTranslation"></a> `CheckResultBasedDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`replacement` | A replacement string. | <a href="#CheckResultBasedDurationTranslation/replacement">See details</a>
#### <a name="CheckResultBasedDurationTranslation/replacement"></a> `replacement`
A replacement string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="IndefiniteDuration"></a> `IndefiniteDuration`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IndefiniteDuration/translations">See details</a>
#### <a name="IndefiniteDuration/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#IndefiniteDurationTranslation">IndefiniteDurationTranslation</a>&gt;
---
### <a name="IndefiniteDurationTranslation"></a> `IndefiniteDurationTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`description` | A description of the duration. | <a href="#IndefiniteDurationTranslation/description">See details</a>
#### <a name="IndefiniteDurationTranslation/description"></a> `description`
A description of the duration.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveText">ResponsiveText</a>
---
### <a name="DurationForSustained"></a> `DurationForSustained`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`maximum` | The sustained skill can be active a maximum amount of time. | <a href="#DurationForSustained/maximum">See details</a>
#### <a name="DurationForSustained/maximum"></a> `maximum`
The sustained skill can be active a maximum amount of time.
- **Type:** <a href="#DurationUnitValue">DurationUnitValue</a>
---
### <a name="DurationUnit"></a> `DurationUnit`
- **Type:** Union
- **Cases:** <a href="#DurationUnit'0">DurationUnit'0</a> | <a href="#DurationUnit'1">DurationUnit'1</a> | <a href="#DurationUnit'2">DurationUnit'2</a> | <a href="#DurationUnit'3">DurationUnit'3</a> | <a href="#DurationUnit'4">DurationUnit'4</a> | <a href="#DurationUnit'5">DurationUnit'5</a> | <a href="#DurationUnit'6">DurationUnit'6</a> | <a href="#DurationUnit'7">DurationUnit'7</a> | <a href="#DurationUnit'8">DurationUnit'8</a> | <a href="#DurationUnit'9">DurationUnit'9</a>
---
### <a name="DurationUnit'0"></a> `DurationUnit'0`
- **Constant:** `"Seconds"`
---
### <a name="DurationUnit'1"></a> `DurationUnit'1`
- **Constant:** `"Minutes"`
---
### <a name="DurationUnit'2"></a> `DurationUnit'2`
- **Constant:** `"Hours"`
---
### <a name="DurationUnit'3"></a> `DurationUnit'3`
- **Constant:** `"Days"`
---
### <a name="DurationUnit'4"></a> `DurationUnit'4`
- **Constant:** `"Weeks"`
---
### <a name="DurationUnit'5"></a> `DurationUnit'5`
- **Constant:** `"Months"`
---
### <a name="DurationUnit'6"></a> `DurationUnit'6`
- **Constant:** `"Years"`
---
### <a name="DurationUnit'7"></a> `DurationUnit'7`
- **Constant:** `"Centuries"`
---
### <a name="DurationUnit'8"></a> `DurationUnit'8`
- **Constant:** `"Actions"`
---
### <a name="DurationUnit'9"></a> `DurationUnit'9`
- **Constant:** `"CombatRounds"`
---
### <a name="DurationUnitValue"></a> `DurationUnitValue`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) duration value. | <a href="#DurationUnitValue/value">See details</a>
`unit` | The unit of the `value`. | <a href="#DurationUnitValue/unit">See details</a>
#### <a name="DurationUnitValue/value"></a> `value`
The (unitless) duration value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="DurationUnitValue/unit"></a> `unit`
The unit of the `value`.
- **Type:** <a href="#DurationUnit">DurationUnit</a>
docs/reference/_ActivatableSkillEffect.md
-157
View File
@@ -1,157 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="ActivatableSkillEffect"></a> `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.
- **Type:** Union
- **Cases:** <a href="#ActivatableSkillEffect'Plain">ActivatableSkillEffect'Plain</a> | <a href="#ActivatableSkillEffect'ForEachQualityLevel">ActivatableSkillEffect'ForEachQualityLevel</a> | <a href="#ActivatableSkillEffect'ForEachTwoQualityLevels">ActivatableSkillEffect'ForEachTwoQualityLevels</a>
---
### <a name="ActivatableSkillEffect'Plain"></a> `ActivatableSkillEffect'Plain`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ActivatableSkillEffect'Plain/tag">See details</a>
`plain` | | <a href="#ActivatableSkillEffect'Plain/plain">See details</a>
#### <a name="ActivatableSkillEffect'Plain/tag"></a> `tag`
- **Constant:** `"Plain"`
#### <a name="ActivatableSkillEffect'Plain/plain"></a> `plain`
- **Type:** <a href="#ActivatableSkillPlainEffect">ActivatableSkillPlainEffect</a>
---
### <a name="ActivatableSkillEffect'ForEachQualityLevel"></a> `ActivatableSkillEffect'ForEachQualityLevel`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ActivatableSkillEffect'ForEachQualityLevel/tag">See details</a>
`for_each_quality_level` | | <a href="#ActivatableSkillEffect'ForEachQualityLevel/for_each_quality_level">See details</a>
#### <a name="ActivatableSkillEffect'ForEachQualityLevel/tag"></a> `tag`
- **Constant:** `"ForEachQualityLevel"`
#### <a name="ActivatableSkillEffect'ForEachQualityLevel/for_each_quality_level"></a> `for_each_quality_level`
- **Type:** <a href="#ActivatableSkillEffectForEachQualityLevel">ActivatableSkillEffectForEachQualityLevel</a>
---
### <a name="ActivatableSkillEffect'ForEachTwoQualityLevels"></a> `ActivatableSkillEffect'ForEachTwoQualityLevels`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#ActivatableSkillEffect'ForEachTwoQualityLevels/tag">See details</a>
`for_each_two_quality_levels` | | <a href="#ActivatableSkillEffect'ForEachTwoQualityLevels/for_each_two_quality_levels">See details</a>
#### <a name="ActivatableSkillEffect'ForEachTwoQualityLevels/tag"></a> `tag`
- **Constant:** `"ForEachTwoQualityLevels"`
#### <a name="ActivatableSkillEffect'ForEachTwoQualityLevels/for_each_two_quality_levels"></a> `for_each_two_quality_levels`
- **Type:** <a href="#ActivatableSkillEffectForEachTwoQualityLevels">ActivatableSkillEffectForEachTwoQualityLevels</a>
---
### <a name="ActivatableSkillPlainEffect"></a> `ActivatableSkillPlainEffect`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`text` | The effect description. | <a href="#ActivatableSkillPlainEffect/text">See details</a>
#### <a name="ActivatableSkillPlainEffect/text"></a> `text`
The effect description.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
---
### <a name="ActivatableSkillEffectForEachQualityLevel"></a> `ActivatableSkillEffectForEachQualityLevel`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`text_before` | The effect description before the list of effects for each quality level. | <a href="#ActivatableSkillEffectForEachQualityLevel/text_before">See details</a>
`quality_levels` | The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. | <a href="#ActivatableSkillEffectForEachQualityLevel/quality_levels">See details</a>
`text_after?` | The effect description after the list of effects for each quality level. | <a href="#ActivatableSkillEffectForEachQualityLevel/text_after">See details</a>
#### <a name="ActivatableSkillEffectForEachQualityLevel/text_before"></a> `text_before`
The effect description before the list of effects for each quality level.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ActivatableSkillEffectForEachQualityLevel/quality_levels"></a> `quality_levels`
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:** <a href="#ActivatableSkillEffectForEachQualityLevel/quality_levels[]">ActivatableSkillEffectForEachQualityLevel/quality_levels[]</a>
#### <a name="ActivatableSkillEffectForEachQualityLevel/text_after"></a> `text_after?`
The effect description after the list of effects for each quality level.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
---
### <a name="ActivatableSkillEffectForEachQualityLevel/quality_levels[]"></a> `ActivatableSkillEffectForEachQualityLevel/quality_levels[]`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
---
### <a name="ActivatableSkillEffectForEachTwoQualityLevels"></a> `ActivatableSkillEffectForEachTwoQualityLevels`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`text_before` | The effect description before the list of effects for each quality level. | <a href="#ActivatableSkillEffectForEachTwoQualityLevels/text_before">See details</a>
`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. | <a href="#ActivatableSkillEffectForEachTwoQualityLevels/quality_levels">See details</a>
`text_after?` | The effect description after the list of effects for each quality level. | <a href="#ActivatableSkillEffectForEachTwoQualityLevels/text_after">See details</a>
#### <a name="ActivatableSkillEffectForEachTwoQualityLevels/text_before"></a> `text_before`
The effect description before the list of effects for each quality level.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ActivatableSkillEffectForEachTwoQualityLevels/quality_levels"></a> `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.
- **Type:** List
- **Items:** <a href="#ActivatableSkillEffectForEachTwoQualityLevels/quality_levels[]">ActivatableSkillEffectForEachTwoQualityLevels/quality_levels[]</a>
#### <a name="ActivatableSkillEffectForEachTwoQualityLevels/text_after"></a> `text_after?`
The effect description after the list of effects for each quality level.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
---
### <a name="ActivatableSkillEffectForEachTwoQualityLevels/quality_levels[]"></a> `ActivatableSkillEffectForEachTwoQualityLevels/quality_levels[]`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
docs/reference/_ActivatableSkillRange.md
-345
View File
@@ -1,345 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Range"></a> `Range`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | | <a href="#Range/value">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Range/translations">See details</a>
#### <a name="Range/value"></a> `value`
- **Type:** <a href="#RangeValue">RangeValue</a>
#### <a name="Range/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#RangeTranslation">RangeTranslation</a>&gt;
---
### <a name="RangeValue"></a> `RangeValue`
- **Type:** Union
- **Cases:** <a href="#RangeValue'Modifiable">RangeValue'Modifiable</a> | <a href="#RangeValue'Sight">RangeValue'Sight</a> | <a href="#RangeValue'Self">RangeValue'Self</a> | <a href="#RangeValue'Global">RangeValue'Global</a> | <a href="#RangeValue'Touch">RangeValue'Touch</a> | <a href="#RangeValue'Fixed">RangeValue'Fixed</a> | <a href="#RangeValue'CheckResultBased">RangeValue'CheckResultBased</a>
---
### <a name="RangeValue'Modifiable"></a> `RangeValue'Modifiable`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Modifiable/tag">See details</a>
`modifiable` | | <a href="#RangeValue'Modifiable/modifiable">See details</a>
#### <a name="RangeValue'Modifiable/tag"></a> `tag`
- **Constant:** `"Modifiable"`
#### <a name="RangeValue'Modifiable/modifiable"></a> `modifiable`
- **Type:** <a href="#ModifiableRange">ModifiableRange</a>
---
### <a name="RangeValue'Sight"></a> `RangeValue'Sight`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Sight/tag">See details</a>
`sight` | | <a href="#RangeValue'Sight/sight">See details</a>
#### <a name="RangeValue'Sight/tag"></a> `tag`
- **Constant:** `"Sight"`
#### <a name="RangeValue'Sight/sight"></a> `sight`
- **Type:** <a href="#RangeValue'Sight/sight">Object</a>
---
### <a name="RangeValue'Sight/sight"></a> `RangeValue'Sight/sight`
- **Type:** Empty Object
---
### <a name="RangeValue'Self"></a> `RangeValue'Self`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Self/tag">See details</a>
`self` | | <a href="#RangeValue'Self/self">See details</a>
#### <a name="RangeValue'Self/tag"></a> `tag`
- **Constant:** `"Self"`
#### <a name="RangeValue'Self/self"></a> `self`
- **Type:** <a href="#RangeValue'Self/self">Object</a>
---
### <a name="RangeValue'Self/self"></a> `RangeValue'Self/self`
- **Type:** Empty Object
---
### <a name="RangeValue'Global"></a> `RangeValue'Global`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Global/tag">See details</a>
`global` | | <a href="#RangeValue'Global/global">See details</a>
#### <a name="RangeValue'Global/tag"></a> `tag`
- **Constant:** `"Global"`
#### <a name="RangeValue'Global/global"></a> `global`
- **Type:** <a href="#RangeValue'Global/global">Object</a>
---
### <a name="RangeValue'Global/global"></a> `RangeValue'Global/global`
- **Type:** Empty Object
---
### <a name="RangeValue'Touch"></a> `RangeValue'Touch`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Touch/tag">See details</a>
`touch` | | <a href="#RangeValue'Touch/touch">See details</a>
#### <a name="RangeValue'Touch/tag"></a> `tag`
- **Constant:** `"Touch"`
#### <a name="RangeValue'Touch/touch"></a> `touch`
- **Type:** <a href="#RangeValue'Touch/touch">Object</a>
---
### <a name="RangeValue'Touch/touch"></a> `RangeValue'Touch/touch`
- **Type:** Empty Object
---
### <a name="RangeValue'Fixed"></a> `RangeValue'Fixed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'Fixed/tag">See details</a>
`fixed` | | <a href="#RangeValue'Fixed/fixed">See details</a>
#### <a name="RangeValue'Fixed/tag"></a> `tag`
- **Constant:** `"Fixed"`
#### <a name="RangeValue'Fixed/fixed"></a> `fixed`
- **Type:** <a href="#FixedRange">FixedRange</a>
---
### <a name="RangeValue'CheckResultBased"></a> `RangeValue'CheckResultBased`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#RangeValue'CheckResultBased/tag">See details</a>
`check_result_based` | | <a href="#RangeValue'CheckResultBased/check_result_based">See details</a>
#### <a name="RangeValue'CheckResultBased/tag"></a> `tag`
- **Constant:** `"CheckResultBased"`
#### <a name="RangeValue'CheckResultBased/check_result_based"></a> `check_result_based`
- **Type:** <a href="#CheckResultBasedRange">CheckResultBasedRange</a>
---
### <a name="ModifiableRange"></a> `ModifiableRange`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If `true`, the range is a maximum range. | <a href="#ModifiableRange/is_maximum">See details</a>
`initial_modification_level` | The initial skill modification identifier/level. | <a href="#ModifiableRange/initial_modification_level">See details</a>
`is_radius?` | If `true`, the range is a radius. | <a href="#ModifiableRange/is_radius">See details</a>
#### <a name="ModifiableRange/is_maximum"></a> `is_maximum?`
If `true`, the range is a maximum range.
- **Constant:** `true`
#### <a name="ModifiableRange/initial_modification_level"></a> `initial_modification_level`
The initial skill modification identifier/level.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `6`
#### <a name="ModifiableRange/is_radius"></a> `is_radius?`
If `true`, the range is a radius.
- **Constant:** `true`
---
### <a name="FixedRange"></a> `FixedRange`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If `true`, the range is a maximum range. | <a href="#FixedRange/is_maximum">See details</a>
`value` | The (unitless) range value. | <a href="#FixedRange/value">See details</a>
`unit` | The unit of the `value`. | <a href="#FixedRange/unit">See details</a>
`is_radius?` | If `true`, the range is a radius. | <a href="#FixedRange/is_radius">See details</a>
#### <a name="FixedRange/is_maximum"></a> `is_maximum?`
If `true`, the range is a maximum range.
- **Constant:** `true`
#### <a name="FixedRange/value"></a> `value`
The (unitless) range value.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="FixedRange/unit"></a> `unit`
The unit of the `value`.
- **Type:** <a href="#RangeUnit">RangeUnit</a>
#### <a name="FixedRange/is_radius"></a> `is_radius?`
If `true`, the range is a radius.
- **Constant:** `true`
---
### <a name="CheckResultBasedRange"></a> `CheckResultBasedRange`
Defines the range being based on a check result.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`is_maximum?` | If the range is the maximum range. | <a href="#CheckResultBasedRange/is_maximum">See details</a>
`base` | The base value that is derived from the check result. | <a href="#CheckResultBasedRange/base">See details</a>
`modifier?` | If defined, it modifies the base value. | <a href="#CheckResultBasedRange/modifier">See details</a>
`unit` | The duration unit. | <a href="#CheckResultBasedRange/unit">See details</a>
`is_radius?` | If `true`, the range is a radius. | <a href="#CheckResultBasedRange/is_radius">See details</a>
#### <a name="CheckResultBasedRange/is_maximum"></a> `is_maximum?`
If the range is the maximum range.
- **Constant:** `true`
#### <a name="CheckResultBasedRange/base"></a> `base`
The base value that is derived from the check result.
- **Type:** <a href="./_ActivatableSkillCheckResultBased.md#CheckResultValue">CheckResultValue</a>
#### <a name="CheckResultBasedRange/modifier"></a> `modifier?`
If defined, it modifies the base value.
- **Type:** <a href="./_ActivatableSkillCheckResultBased.md#CheckResultBasedModifier">CheckResultBasedModifier</a>
#### <a name="CheckResultBasedRange/unit"></a> `unit`
The duration unit.
- **Type:** <a href="#RangeUnit">RangeUnit</a>
#### <a name="CheckResultBasedRange/is_radius"></a> `is_radius?`
If `true`, the range is a radius.
- **Constant:** `true`
---
### <a name="RangeTranslation"></a> `RangeTranslation`
- **Type:** Object
- **Minimum Properties:** `1`
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 href="#RangeTranslation/note">See details</a>
`replacement?` | A replacement string. If `note` is provided, it is appended to the replaced string. | <a href="#RangeTranslation/replacement">See details</a>
#### <a name="RangeTranslation/note"></a> `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.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextOptional">ResponsiveTextOptional</a>
#### <a name="RangeTranslation/replacement"></a> `replacement?`
A replacement string. If `note` is provided, it is appended to the replaced string.
- **Type:** <a href="./_ResponsiveText.md#ResponsiveTextReplace">ResponsiveTextReplace</a>
---
### <a name="RangeUnit"></a> `RangeUnit`
- **Type:** Union
- **Cases:** <a href="#RangeUnit'0">RangeUnit'0</a> | <a href="#RangeUnit'1">RangeUnit'1</a>
---
### <a name="RangeUnit'0"></a> `RangeUnit'0`
- **Constant:** `"Steps"`
---
### <a name="RangeUnit'1"></a> `RangeUnit'1`
- **Constant:** `"Miles"`
docs/reference/_ActivatableSkillTargetCategory.md
-181
View File
@@ -1,181 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="AffectedTargetCategories"></a> `AffectedTargetCategories`
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.
- **Type:** List
- **Items:** <a href="#AffectedTargetCategories[]">AffectedTargetCategories[]</a>
---
### <a name="AffectedTargetCategories[]"></a> `AffectedTargetCategories[]`
- **Type:** <a href="#SpecificAffectedTargetCategory">SpecificAffectedTargetCategory</a>
---
### <a name="SpecificAffectedTargetCategory"></a> `SpecificAffectedTargetCategory`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SpecificAffectedTargetCategory/id">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SpecificAffectedTargetCategory/translations">See details</a>
#### <a name="SpecificAffectedTargetCategory/id"></a> `id`
- **Type:** <a href="#SpecificAffectedTargetCategoryIdentifier">SpecificAffectedTargetCategoryIdentifier</a>
#### <a name="SpecificAffectedTargetCategory/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SpecificAffectedTargetCategoryTranslation">SpecificAffectedTargetCategoryTranslation</a>&gt;
---
### <a name="SpecificAffectedTargetCategoryTranslation"></a> `SpecificAffectedTargetCategoryTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`note` | A note, appended to the generated string in parenthesis. | <a href="#SpecificAffectedTargetCategoryTranslation/note">See details</a>
#### <a name="SpecificAffectedTargetCategoryTranslation/note"></a> `note`
A note, appended to the generated string in parenthesis.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier"></a> `SpecificAffectedTargetCategoryIdentifier`
- **Type:** Union
- **Cases:** <a href="#SpecificAffectedTargetCategoryIdentifier'Self">SpecificAffectedTargetCategoryIdentifier'Self</a> | <a href="#SpecificAffectedTargetCategoryIdentifier'Zone">SpecificAffectedTargetCategoryIdentifier'Zone</a> | <a href="#SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies">SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies</a> | <a href="#SpecificAffectedTargetCategoryIdentifier'Cantrips">SpecificAffectedTargetCategoryIdentifier'Cantrips</a> | <a href="#SpecificAffectedTargetCategoryIdentifier'Predefined">SpecificAffectedTargetCategoryIdentifier'Predefined</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Self"></a> `SpecificAffectedTargetCategoryIdentifier'Self`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Self/tag">See details</a>
`self` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Self/self">See details</a>
#### <a name="SpecificAffectedTargetCategoryIdentifier'Self/tag"></a> `tag`
- **Constant:** `"Self"`
#### <a name="SpecificAffectedTargetCategoryIdentifier'Self/self"></a> `self`
- **Type:** <a href="#SpecificAffectedTargetCategoryIdentifier'Self/self">Object</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Self/self"></a> `SpecificAffectedTargetCategoryIdentifier'Self/self`
- **Type:** Empty Object
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Zone"></a> `SpecificAffectedTargetCategoryIdentifier'Zone`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Zone/tag">See details</a>
`zone` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Zone/zone">See details</a>
#### <a name="SpecificAffectedTargetCategoryIdentifier'Zone/tag"></a> `tag`
- **Constant:** `"Zone"`
#### <a name="SpecificAffectedTargetCategoryIdentifier'Zone/zone"></a> `zone`
- **Type:** <a href="#SpecificAffectedTargetCategoryIdentifier'Zone/zone">Object</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Zone/zone"></a> `SpecificAffectedTargetCategoryIdentifier'Zone/zone`
- **Type:** Empty Object
---
### <a name="SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies"></a> `SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/tag">See details</a>
`liturgical_chants_and_ceremonies` | | <a href="#SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/liturgical_chants_and_ceremonies">See details</a>
#### <a name="SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/tag"></a> `tag`
- **Constant:** `"LiturgicalChantsAndCeremonies"`
#### <a name="SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/liturgical_chants_and_ceremonies"></a> `liturgical_chants_and_ceremonies`
- **Type:** <a href="#SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/liturgical_chants_and_ceremonies">Object</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/liturgical_chants_and_ceremonies"></a> `SpecificAffectedTargetCategoryIdentifier'LiturgicalChantsAndCeremonies/liturgical_chants_and_ceremonies`
- **Type:** Empty Object
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Cantrips"></a> `SpecificAffectedTargetCategoryIdentifier'Cantrips`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Cantrips/tag">See details</a>
`cantrips` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Cantrips/cantrips">See details</a>
#### <a name="SpecificAffectedTargetCategoryIdentifier'Cantrips/tag"></a> `tag`
- **Constant:** `"Cantrips"`
#### <a name="SpecificAffectedTargetCategoryIdentifier'Cantrips/cantrips"></a> `cantrips`
- **Type:** <a href="#SpecificAffectedTargetCategoryIdentifier'Cantrips/cantrips">Object</a>
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Cantrips/cantrips"></a> `SpecificAffectedTargetCategoryIdentifier'Cantrips/cantrips`
- **Type:** Empty Object
---
### <a name="SpecificAffectedTargetCategoryIdentifier'Predefined"></a> `SpecificAffectedTargetCategoryIdentifier'Predefined`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Predefined/tag">See details</a>
`predefined` | | <a href="#SpecificAffectedTargetCategoryIdentifier'Predefined/predefined">See details</a>
#### <a name="SpecificAffectedTargetCategoryIdentifier'Predefined/tag"></a> `tag`
- **Constant:** `"Predefined"`
#### <a name="SpecificAffectedTargetCategoryIdentifier'Predefined/predefined"></a> `predefined`
- **Type:** <a href="./_SimpleReferences.md#TargetCategoryReference">TargetCategoryReference</a>
docs/reference/_AlternativeNames.md
-24
View File
@@ -1,24 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="AlternativeName"></a> `AlternativeName`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | An alternative name of the disease. | <a href="#AlternativeName/name">See details</a>
`region?` | The region where this alternative name is used. | <a href="#AlternativeName/region">See details</a>
#### <a name="AlternativeName/name"></a> `name`
An alternative name of the disease.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AlternativeName/region"></a> `region?`
The region where this alternative name is used.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/_ArcaneTradition.md
-46
View File
@@ -1,46 +0,0 @@
# Arcane Tradition
## Definitions
### <a name="ArcaneTradition"></a> Arcane Tradition (`ArcaneTradition`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The arcane tradition's identifier. An unique, increasing integer. | <a href="#ArcaneTradition/id">See details</a>
`prerequisites` | | <a href="#ArcaneTradition/prerequisites">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#ArcaneTradition/translations">See details</a>
#### <a name="ArcaneTradition/id"></a> `id`
The arcane tradition's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="ArcaneTradition/prerequisites"></a> `prerequisites`
- **Type:** <a href="./_Prerequisite.md#ArcaneTraditionPrerequisites">ArcaneTraditionPrerequisites</a>
#### <a name="ArcaneTradition/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ArcaneTraditionTranslation">ArcaneTraditionTranslation</a>&gt;
---
### <a name="ArcaneTraditionTranslation"></a> `ArcaneTraditionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The arcane tradition's name. | <a href="#ArcaneTraditionTranslation/name">See details</a>
#### <a name="ArcaneTraditionTranslation/name"></a> `name`
The arcane tradition's name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/_Blessed.md
-78
View File
@@ -1,78 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="SkillTradition"></a> `SkillTradition`
- **Type:** Union
- **Cases:** <a href="#SkillTradition'GeneralAspect">SkillTradition'GeneralAspect</a> | <a href="#SkillTradition'Tradition">SkillTradition'Tradition</a>
---
### <a name="SkillTradition'GeneralAspect"></a> `SkillTradition'GeneralAspect`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SkillTradition'GeneralAspect/tag">See details</a>
`general_aspect` | | <a href="#SkillTradition'GeneralAspect/general_aspect">See details</a>
#### <a name="SkillTradition'GeneralAspect/tag"></a> `tag`
- **Constant:** `"GeneralAspect"`
#### <a name="SkillTradition'GeneralAspect/general_aspect"></a> `general_aspect`
- **Type:** <a href="./_SimpleReferences.md#AspectReference">AspectReference</a>
---
### <a name="SkillTradition'Tradition"></a> `SkillTradition'Tradition`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#SkillTradition'Tradition/tag">See details</a>
`tradition` | | <a href="#SkillTradition'Tradition/tradition">See details</a>
#### <a name="SkillTradition'Tradition/tag"></a> `tag`
- **Constant:** `"Tradition"`
#### <a name="SkillTradition'Tradition/tradition"></a> `tradition`
- **Type:** <a href="#SkillTraditionWithAspects">SkillTraditionWithAspects</a>
---
### <a name="SkillTraditionWithAspects"></a> `SkillTraditionWithAspects`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tradition` | The blessed tradition. | <a href="#SkillTraditionWithAspects/tradition">See details</a>
`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. | <a href="#SkillTraditionWithAspects/aspects">See details</a>
#### <a name="SkillTraditionWithAspects/tradition"></a> `tradition`
The blessed tradition.
- **Type:** <a href="./_SimpleReferences.md#BlessedTraditionReference">BlessedTraditionReference</a>
#### <a name="SkillTraditionWithAspects/aspects"></a> `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.
- **Type:** List
- **Items:** <a href="#SkillTraditionWithAspects/aspects[]">SkillTraditionWithAspects/aspects[]</a>
- **Minimum Items:** `1`
- **Maximum Items:** `2`
---
### <a name="SkillTraditionWithAspects/aspects[]"></a> `SkillTraditionWithAspects/aspects[]`
- **Type:** <a href="./_SimpleReferences.md#AspectReference">AspectReference</a>
docs/reference/_CommonnessRatedAdvantageDisadvantage.md
-19
View File
@@ -1,19 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="CommonnessRatedAdvantageDisadvantage"></a> Commonness-rated Advantage/Disadvantage (`CommonnessRatedAdvantageDisadvantage<Identifier>`)
Reference to a commonness-rated advantage or disadvantage. Commonness-rating terms used in the source books are strongly recommended, common, uncommon, suggested and unsuitable.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The advantage's or disadvantage's identifier. | <a href="#CommonnessRatedAdvantageDisadvantage/id">See details</a>
#### <a name="CommonnessRatedAdvantageDisadvantage/id"></a> `id`
The advantage's or disadvantage's identifier.
- **Type:** <a href="#Identifier">Identifier</a>
docs/reference/_Dice.md
-52
View File
@@ -1,52 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Dice"></a> Dice (`Dice`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`number` | Number of dice of the same type. Example: 2 in 2D6. | <a href="#Dice/number">See details</a>
`sides` | Number of sides on every die. Example: 6 in 2D6. | <a href="#Dice/sides">See details</a>
#### <a name="Dice/number"></a> `number`
Number of dice of the same type. Example: 2 in 2D6.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Dice/sides"></a> `sides`
Number of sides on every die. Example: 6 in 2D6.
- **Type:** <a href="#DieType">DieType</a>
---
### <a name="DieType"></a> `DieType`
Number of sides on every dice. Example: 6 in 2D6.
- **Type:** Union
- **Cases:** <a href="#DieType'0">DieType'0</a> | <a href="#DieType'1">DieType'1</a> | <a href="#DieType'2">DieType'2</a>
---
### <a name="DieType'0"></a> `DieType'0`
- **Constant:** `3`
---
### <a name="DieType'1"></a> `DieType'1`
- **Constant:** `6`
---
### <a name="DieType'2"></a> `DieType'2`
- **Constant:** `20`
docs/reference/_DiseasePoison.md
-201
View File
@@ -1,201 +0,0 @@
# Disease (shared)
This file defines some shared types for different diseases and poisons.
## Definitions
### <a name="Resistance"></a> `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.
- **Type:** Union
- **Cases:** <a href="#Resistance'0">Resistance'0</a> | <a href="#Resistance'1">Resistance'1</a> | <a href="#Resistance'2">Resistance'2</a>
---
### <a name="Resistance'0"></a> `Resistance'0`
- **Constant:** `"Spirit"`
---
### <a name="Resistance'1"></a> `Resistance'1`
- **Constant:** `"Toughness"`
---
### <a name="Resistance'2"></a> `Resistance'2`
- **Constant:** `"LowerOfSpiritAndToughness"`
---
### <a name="Cause"></a> `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.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`chance?` | The chance to get infected by this cause, in percent. | <a href="#Cause/chance">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Cause/translations">See details</a>
#### <a name="Cause/chance"></a> `chance?`
The chance to get infected by this cause, in percent.
- **Type:** Integer
- **Minimum:** `5`
- **Maximum:** `100`
- **Multiple of:** `5`
#### <a name="Cause/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#CauseTranslation">CauseTranslation</a>&gt;
---
### <a name="CauseTranslation"></a> `CauseTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the cause. | <a href="#CauseTranslation/name">See details</a>
`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. | <a href="#CauseTranslation/chance">See details</a>
`note?` | An additional note about this cause. | <a href="#CauseTranslation/note">See details</a>
#### <a name="CauseTranslation/name"></a> `name`
The name of the cause.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="CauseTranslation/chance"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="CauseTranslation/note"></a> `note?`
An additional note about this cause.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="DiseaseTranslation"></a> `DiseaseTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the disease. | <a href="#DiseaseTranslation/name">See details</a>
`alternative_names?` | A list of alternative names. | <a href="#DiseaseTranslation/alternative_names">See details</a>
`progress` | The disease’s progress, in detail. | <a href="#DiseaseTranslation/progress">See details</a>
`incubation_time` | After infection, how much time passes before symptoms appear? | <a href="#DiseaseTranslation/incubation_time">See details</a>
`damage` | The damage caused by the disease. If the disease check fails, apply the lessened effects. | <a href="#DiseaseTranslation/damage">See details</a>
`duration` | The duration of the disease. If the disease check fails, use the lessened duration. | <a href="#DiseaseTranslation/duration">See details</a>
`special?` | Special information about the disease. | <a href="#DiseaseTranslation/special">See details</a>
`treatment` | Methods known to lessen the disease’s progress or relieve symptoms. | <a href="#DiseaseTranslation/treatment">See details</a>
`cure` | Known remedies for the disease. | <a href="#DiseaseTranslation/cure">See details</a>
`errata?` | | <a href="#DiseaseTranslation/errata">See details</a>
#### <a name="DiseaseTranslation/name"></a> `name`
The name of the disease.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="DiseaseTranslation/alternative_names"></a> `alternative_names?`
A list of alternative names.
- **Type:** List
- **Items:** <a href="#DiseaseTranslation/alternative_names[]">DiseaseTranslation/alternative_names[]</a>
- **Minimum Items:** `1`
#### <a name="DiseaseTranslation/progress"></a> `progress`
The disease’s progress, in detail.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="DiseaseTranslation/incubation_time"></a> `incubation_time`
After infection, how much time passes before symptoms appear?
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="DiseaseTranslation/damage"></a> `damage`
The damage caused by the disease. If the disease check fails, apply the lessened effects.
- **Type:** <a href="#Reduceable">Reduceable</a>&lt;<a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>&gt;
#### <a name="DiseaseTranslation/duration"></a> `duration`
The duration of the disease. If the disease check fails, use the lessened duration.
- **Type:** <a href="#Reduceable">Reduceable</a>&lt;<a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>&gt;
#### <a name="DiseaseTranslation/special"></a> `special?`
Special information about the disease.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="DiseaseTranslation/treatment"></a> `treatment`
Methods known to lessen the disease’s progress or relieve symptoms.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="DiseaseTranslation/cure"></a> `cure`
Known remedies for the disease.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="DiseaseTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="DiseaseTranslation/alternative_names[]"></a> `DiseaseTranslation/alternative_names[]`
- **Type:** <a href="./_AlternativeNames.md#AlternativeName">AlternativeName</a>
---
### <a name="Reduceable"></a> `Reduceable<Content>`
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).
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`default` | The default value. In the source, it's the text before the slash. | <a href="#Reduceable/default">See details</a>
`reduced?` | The reduced value. In the source, it's the text after the slash. Some entries may not have a reduced value. | <a href="#Reduceable/reduced">See details</a>
#### <a name="Reduceable/default"></a> `default`
The default value. In the source, it's the text before the slash.
- **Type:** <a href="#Content">Content</a>
#### <a name="Reduceable/reduced"></a> `reduced?`
The reduced value. In the source, it's the text after the slash. Some entries may not have a reduced value.
- **Type:** <a href="#Content">Content</a>
docs/reference/_Enhancements.md
-101
View File
@@ -1,101 +0,0 @@
# Enhancements
## Definitions
### <a name="Enhancements"></a> `Enhancements`
A list of enhancements.
- **Type:** List
- **Items:** <a href="#Enhancements[]">Enhancements[]</a>
- **Minimum Items:** `3`
- **Maximum Items:** `5`
---
### <a name="Enhancements[]"></a> `Enhancements[]`
- **Type:** <a href="#Enhancement">Enhancement</a>
---
### <a name="Enhancement"></a> Enhancement (`Enhancement`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The enhancement's identifier. An unique, increasing integer. | <a href="#Enhancement/id">See details</a>
`skill_rating` | The skill rating required to learn this enhancement. | <a href="#Enhancement/skill_rating">See details</a>
`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. | <a href="#Enhancement/adventure_points_modifier">See details</a>
`prerequisites?` | | <a href="#Enhancement/prerequisites">See details</a>
`src?` | Only defined if different than the associated skill. | <a href="#Enhancement/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Enhancement/translations">See details</a>
#### <a name="Enhancement/id"></a> `id`
The enhancement's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Enhancement/skill_rating"></a> `skill_rating`
The skill rating required to learn this enhancement.
- **Type:** Integer
- **Minimum:** `8`
- **Maximum:** `16`
#### <a name="Enhancement/adventure_points_modifier"></a> `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.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Enhancement/prerequisites"></a> `prerequisites?`
- **Type:** <a href="./_Prerequisite.md#EnhancementPrerequisites">EnhancementPrerequisites</a>
#### <a name="Enhancement/src"></a> `src?`
Only defined if different than the associated skill.
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Enhancement/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#EnhancementTranslation">EnhancementTranslation</a>&gt;
---
### <a name="EnhancementTranslation"></a> `EnhancementTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the enhancement. | <a href="#EnhancementTranslation/name">See details</a>
`effect` | The effect description. | <a href="#EnhancementTranslation/effect">See details</a>
`errata?` | | <a href="#EnhancementTranslation/errata">See details</a>
#### <a name="EnhancementTranslation/name"></a> `name`
The name of the enhancement.
- **Type:** String
- **Minimum Length:** `1`
#### <a name="EnhancementTranslation/effect"></a> `effect`
The effect description.
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
#### <a name="EnhancementTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
docs/reference/_I18n.md
-83
View File
@@ -1,83 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="PluralizationCategories"></a> `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.
From the third link:
> The minimal pairs are those that are required for correct grammar. So
> because 0 and 1 don't have to form a minimal pair (it is ok—even though
> often not optimal—to say '0 people') , 0 doesn't establish a separate
> category. However, implementations are encouraged to provide the ability to
> have special plural messages for 0 in particular, so that more natural
> language can be used:
>
> — None of your friends are online.
>
> rather than
>
> — You have 0 friends online.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`zero?` | | <a href="#PluralizationCategories/zero">See details</a>
`one?` | | <a href="#PluralizationCategories/one">See details</a>
`two?` | | <a href="#PluralizationCategories/two">See details</a>
`few?` | | <a href="#PluralizationCategories/few">See details</a>
`many?` | | <a href="#PluralizationCategories/many">See details</a>
`other` | | <a href="#PluralizationCategories/other">See details</a>
#### <a name="PluralizationCategories/zero"></a> `zero?`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PluralizationCategories/one"></a> `one?`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PluralizationCategories/two"></a> `two?`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PluralizationCategories/few"></a> `few?`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PluralizationCategories/many"></a> `many?`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="PluralizationCategories/other"></a> `other`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="VaryBySystem"></a> `VaryBySystem`
The item can be different for each operating system.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`mac` | | <a href="#VaryBySystem/mac">See details</a>
`windows` | | <a href="#VaryBySystem/windows">See details</a>
`linux` | | <a href="#VaryBySystem/linux">See details</a>
#### <a name="VaryBySystem/mac"></a> `mac`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="VaryBySystem/windows"></a> `windows`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="VaryBySystem/linux"></a> `linux`
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/_Identifier.md
-3146
View File
File diff suppressed because it is too large Load Diff
docs/reference/_IdentifierGroup.md
-1475
View File
File diff suppressed because one or more lines are too long
docs/reference/_ImprovementCost.md
-32
View File
@@ -1,32 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="ImprovementCost"></a> Improvement Cost (`ImprovementCost`)
- **Type:** Union
- **Cases:** <a href="#ImprovementCost'0">ImprovementCost'0</a> | <a href="#ImprovementCost'1">ImprovementCost'1</a> | <a href="#ImprovementCost'2">ImprovementCost'2</a> | <a href="#ImprovementCost'3">ImprovementCost'3</a>
---
### <a name="ImprovementCost'0"></a> `ImprovementCost'0`
- **Constant:** `"A"`
---
### <a name="ImprovementCost'1"></a> `ImprovementCost'1`
- **Constant:** `"B"`
---
### <a name="ImprovementCost'2"></a> `ImprovementCost'2`
- **Constant:** `"C"`
---
### <a name="ImprovementCost'3"></a> `ImprovementCost'3`
- **Constant:** `"D"`
docs/reference/_Influence.md
-94
View File
@@ -1,94 +0,0 @@
# Influence
## Definitions
### <a name="Influence"></a> Influence (`Influence`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The influence's identifier. An unique, increasing integer. | <a href="#Influence/id">See details</a>
`prerequisites` | | <a href="#Influence/prerequisites">See details</a>
`src` | | <a href="#Influence/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Influence/translations">See details</a>
#### <a name="Influence/id"></a> `id`
The influence's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Influence/prerequisites"></a> `prerequisites`
- **Type:** <a href="./_Prerequisite.md#InfluencePrerequisites">InfluencePrerequisites</a>
#### <a name="Influence/src"></a> `src`
- **Type:** <a href="./source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Influence/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#InfluenceTranslation">InfluenceTranslation</a>&gt;
---
### <a name="InfluenceTranslation"></a> `InfluenceTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The influence name. | <a href="#InfluenceTranslation/name">See details</a>
`effects` | The effects of the influence. They should be sorted like they are in the book. | <a href="#InfluenceTranslation/effects">See details</a>
`errata?` | | <a href="#InfluenceTranslation/errata">See details</a>
#### <a name="InfluenceTranslation/name"></a> `name`
The influence name.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="InfluenceTranslation/effects"></a> `effects`
The effects of the influence. They should be sorted like they are in the book.
- **Type:** List
- **Items:** <a href="#InfluenceTranslation/effects[]">InfluenceTranslation/effects[]</a>
- **Minimum Items:** `1`
#### <a name="InfluenceTranslation/errata"></a> `errata?`
- **Type:** <a href="./source/_Erratum.md#Errata">Errata</a>
---
### <a name="InfluenceTranslation/effects[]"></a> `InfluenceTranslation/effects[]`
- **Type:** <a href="#InfluenceEffect">InfluenceEffect</a>
---
### <a name="InfluenceEffect"></a> `InfluenceEffect`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`label?` | An optional label that is displayed and placed before the actual text. | <a href="#InfluenceEffect/label">See details</a>
`text` | The effect text. | <a href="#InfluenceEffect/text">See details</a>
#### <a name="InfluenceEffect/label"></a> `label?`
An optional label that is displayed and placed before the actual text.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="InfluenceEffect/text"></a> `text`
The effect text.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/_LocaleMap.md
-18
View File
@@ -1,18 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="LocaleMap"></a> `LocaleMap<T>`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** Dictionary
- **Property Values:** <a href="#LocaleMap[key]">LocaleMap[key]</a>
- **Pattern:** `^[a-z]{2}-[A-Z]{2}$`
- **Minimum Properties:** `1`
---
### <a name="LocaleMap[key]"></a> `LocaleMap[key]`
- **Type:** <a href="#T">T</a>
docs/reference/_NonEmptyString.md
-15
View File
@@ -1,15 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="NonEmptyString"></a> `NonEmptyString`
- **Type:** String
- **Minimum Length:** `1`
---
### <a name="NonEmptyMarkdown"></a> `NonEmptyMarkdown`
- **Type:** Markdown-formatted text
- **Minimum Length:** `1`
docs/reference/_Prerequisite.md
-261
View File
@@ -1,261 +0,0 @@
# Prerequisites
## Definitions
### <a name="PrerequisiteGroup"></a> `PrerequisiteGroup<T>`
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
Key | Description | Details
:-- | :-- | :--
`list` | | <a href="#PrerequisiteGroup/list">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#PrerequisiteGroup/translations">See details</a>
#### <a name="PrerequisiteGroup/list"></a> `list`
- **Type:** List
- **Items:** <a href="#PrerequisiteGroup/list[]">PrerequisiteGroup/list[]</a>
- **Minimum Items:** `2`
#### <a name="PrerequisiteGroup/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="./_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>&gt;
---
### <a name="PrerequisiteGroup/list[]"></a> `PrerequisiteGroup/list[]`
- **Type:** <a href="#T">T</a>
---
### <a name="PrerequisitesDisjunction"></a> `PrerequisitesDisjunction<T>`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`list` | | <a href="#PrerequisitesDisjunction/list">See details</a>
`display_option?` | | <a href="#PrerequisitesDisjunction/display_option">See details</a>
#### <a name="PrerequisitesDisjunction/list"></a> `list`
- **Type:** List
- **Items:** <a href="#PrerequisitesDisjunction/list[]">PrerequisitesDisjunction/list[]</a>
- **Minimum Items:** `2`
#### <a name="PrerequisitesDisjunction/display_option"></a> `display_option?`
- **Type:** <a href="./prerequisites/DisplayOption.md#DisplayOption">DisplayOption</a>
---
### <a name="PrerequisitesDisjunction/list[]"></a> `PrerequisitesDisjunction/list[]`
- **Type:** <a href="#T">T</a>
---
### <a name="PrerequisitesElement"></a> `PrerequisitesElement<T>`
- **Type:** Union
- **Cases:** <a href="#PrerequisitesElement'Single">PrerequisitesElement'Single</a> | <a href="#PrerequisitesElement'Disjunction">PrerequisitesElement'Disjunction</a> | <a href="#PrerequisitesElement'Group">PrerequisitesElement'Group</a>
---
### <a name="PrerequisitesElement'Single"></a> `PrerequisitesElement'Single`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#PrerequisitesElement'Single/tag">See details</a>
`single` | | <a href="#PrerequisitesElement'Single/single">See details</a>
#### <a name="PrerequisitesElement'Single/tag"></a> `tag`
- **Constant:** `"Single"`
#### <a name="PrerequisitesElement'Single/single"></a> `single`
- **Type:** <a href="#T">T</a>
---
### <a name="PrerequisitesElement'Disjunction"></a> `PrerequisitesElement'Disjunction`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#PrerequisitesElement'Disjunction/tag">See details</a>
`disjunction` | | <a href="#PrerequisitesElement'Disjunction/disjunction">See details</a>
#### <a name="PrerequisitesElement'Disjunction/tag"></a> `tag`
- **Constant:** `"Disjunction"`
#### <a name="PrerequisitesElement'Disjunction/disjunction"></a> `disjunction`
- **Type:** <a href="#PrerequisitesDisjunction">PrerequisitesDisjunction</a>&lt;<a href="#T">T</a>&gt;
---
### <a name="PrerequisitesElement'Group"></a> `PrerequisitesElement'Group`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#PrerequisitesElement'Group/tag">See details</a>
`group` | | <a href="#PrerequisitesElement'Group/group">See details</a>
#### <a name="PrerequisitesElement'Group/tag"></a> `tag`
- **Constant:** `"Group"`
#### <a name="PrerequisitesElement'Group/group"></a> `group`
- **Type:** <a href="#PrerequisiteGroup">PrerequisiteGroup</a>&lt;<a href="#T">T</a>&gt;
---
### <a name="PlainPrerequisites"></a> `PlainPrerequisites<T>`
- **Type:** List
- **Items:** <a href="#PlainPrerequisites[]">PlainPrerequisites[]</a>
- **Minimum Items:** `1`
---
### <a name="PlainPrerequisites[]"></a> `PlainPrerequisites[]`
- **Type:** <a href="#PrerequisitesElement">PrerequisitesElement</a>&lt;<a href="#T">T</a>&gt;
---
### <a name="PrerequisiteForLevel"></a> `PrerequisiteForLevel<T>`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`level` | | <a href="#PrerequisiteForLevel/level">See details</a>
`prerequisite` | | <a href="#PrerequisiteForLevel/prerequisite">See details</a>
#### <a name="PrerequisiteForLevel/level"></a> `level`
- **Type:** Integer
- **Minimum:** `1`
#### <a name="PrerequisiteForLevel/prerequisite"></a> `prerequisite`
- **Type:** <a href="#PrerequisitesElement">PrerequisitesElement</a>&lt;<a href="#T">T</a>&gt;
---
### <a name="PrerequisitesForLevels"></a> `PrerequisitesForLevels<T>`
- **Type:** List
- **Items:** <a href="#PrerequisitesForLevels[]">PrerequisitesForLevels[]</a>
- **Minimum Items:** `1`
---
### <a name="PrerequisitesForLevels[]"></a> `PrerequisitesForLevels[]`
- **Type:** <a href="#PrerequisiteForLevel">PrerequisiteForLevel</a>&lt;<a href="#T">T</a>&gt;
---
### <a name="DerivedCharacteristicPrerequisites"></a> `DerivedCharacteristicPrerequisites`
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#DerivedCharacteristicPrerequisiteGroup">DerivedCharacteristicPrerequisiteGroup</a>&gt;
---
### <a name="PublicationPrerequisites"></a> `PublicationPrerequisites`
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#PublicationPrerequisiteGroup">PublicationPrerequisiteGroup</a>&gt;
---
### <a name="PlainGeneralPrerequisites"></a> Plain General Prerequisites (`PlainGeneralPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#GeneralPrerequisiteGroup">GeneralPrerequisiteGroup</a>&gt;
---
### <a name="GeneralPrerequisites"></a> General Prerequisites (`GeneralPrerequisites`)
- **Type:** <a href="#PrerequisitesForLevels">PrerequisitesForLevels</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#GeneralPrerequisiteGroup">GeneralPrerequisiteGroup</a>&gt;
---
### <a name="ProfessionPrerequisites"></a> Profession Prerequisites (`ProfessionPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#ProfessionPrerequisiteGroup">ProfessionPrerequisiteGroup</a>&gt;
---
### <a name="AdvantageDisadvantagePrerequisites"></a> Advantage/Disadvantage Prerequisites (`AdvantageDisadvantagePrerequisites`)
- **Type:** <a href="#PrerequisitesForLevels">PrerequisitesForLevels</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#AdvantageDisadvantagePrerequisiteGroup">AdvantageDisadvantagePrerequisiteGroup</a>&gt;
---
### <a name="ArcaneTraditionPrerequisites"></a> Arcane Tradition Prerequisites (`ArcaneTraditionPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#ArcaneTraditionPrerequisiteGroup">ArcaneTraditionPrerequisiteGroup</a>&gt;
---
### <a name="PersonalityTraitPrerequisites"></a> Personality Trait Prerequisites (`PersonalityTraitPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#PersonalityTraitPrerequisiteGroup">PersonalityTraitPrerequisiteGroup</a>&gt;
---
### <a name="SpellworkPrerequisites"></a> Spellwork Prerequisites (`SpellworkPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#SpellworkPrerequisiteGroup">SpellworkPrerequisiteGroup</a>&gt;
---
### <a name="LiturgyPrerequisites"></a> Liturgy Prerequisites (`LiturgyPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#LiturgyPrerequisiteGroup">LiturgyPrerequisiteGroup</a>&gt;
---
### <a name="InfluencePrerequisites"></a> Influence Prerequisites (`InfluencePrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#InfluencePrerequisiteGroup">InfluencePrerequisiteGroup</a>&gt;
---
### <a name="LanguagePrerequisites"></a> Language Prerequisites (`LanguagePrerequisites`)
- **Type:** <a href="#PrerequisitesForLevels">PrerequisitesForLevels</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#LanguagePrerequisiteGroup">LanguagePrerequisiteGroup</a>&gt;
---
### <a name="AnimistPowerPrerequisites"></a> Animist Power Prerequisites (`AnimistPowerPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#AnimistPowerPrerequisiteGroup">AnimistPowerPrerequisiteGroup</a>&gt;
---
### <a name="GeodeRitualPrerequisites"></a> Geode Ritual Prerequisites (`GeodeRitualPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#GeodeRitualPrerequisiteGroup">GeodeRitualPrerequisiteGroup</a>&gt;
---
### <a name="EnhancementPrerequisites"></a> Enhancement Prerequisites (`EnhancementPrerequisites`)
- **Type:** <a href="#PlainPrerequisites">PlainPrerequisites</a>&lt;<a href="./prerequisites/PrerequisiteGroups.md#EnhancementPrerequisiteGroup">EnhancementPrerequisiteGroup</a>&gt;
docs/reference/_ResponsiveText.md
-80
View File
@@ -1,80 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="ResponsiveText"></a> `ResponsiveText`
A text from the source that can be also displayed in small areas using a compressed version.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`full` | The full text from the source. | <a href="#ResponsiveText/full">See details</a>
`compressed` | A compressed text for use in small areas (e.g. on character sheet). | <a href="#ResponsiveText/compressed">See details</a>
#### <a name="ResponsiveText/full"></a> `full`
The full text from the source.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ResponsiveText/compressed"></a> `compressed`
A compressed text for use in small areas (e.g. on character sheet).
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="ResponsiveTextReplace"></a> `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.
- **Type:** Object
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. | <a href="#ResponsiveTextReplace/full">See details</a>
`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 href="#ResponsiveTextReplace/compressed">See details</a>
#### <a name="ResponsiveTextReplace/full"></a> `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.
- **Type:** String
- **Minimum Length:** `1`
- **Pattern:** `\$1`
#### <a name="ResponsiveTextReplace/compressed"></a> `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.
- **Type:** String
- **Minimum Length:** `1`
- **Pattern:** `\$1`
---
### <a name="ResponsiveTextOptional"></a> `ResponsiveTextOptional`
A text from the source that can be also displayed in small areas using a compressed version, if available.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`full` | The full text from the source. | <a href="#ResponsiveTextOptional/full">See details</a>
`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 href="#ResponsiveTextOptional/compressed">See details</a>
#### <a name="ResponsiveTextOptional/full"></a> `full`
The full text from the source.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ResponsiveTextOptional/compressed"></a> `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.
- **Type:** <a href="./_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/_Sex.md
-20
View File
@@ -1,20 +0,0 @@
# Binary Sex
## Definitions
### <a name="BinarySex"></a> Binary Sex (`BinarySex`)
- **Type:** Union
- **Cases:** <a href="#BinarySex'0">BinarySex'0</a> | <a href="#BinarySex'1">BinarySex'1</a>
---
### <a name="BinarySex'0"></a> `BinarySex'0`
- **Constant:** `"Male"`
---
### <a name="BinarySex'1"></a> `BinarySex'1`
- **Constant:** `"Female"`
docs/reference/_SimpleReferences.md
-617
View File
@@ -1,617 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="FocusRuleSubjectReference"></a> `FocusRuleSubjectReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#FocusRuleSubjectReference/id">See details</a>
#### <a name="FocusRuleSubjectReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#SubjectIdentifier">SubjectIdentifier</a>
---
### <a name="RaceReference"></a> `RaceReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#RaceReference/id">See details</a>
#### <a name="RaceReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#RaceIdentifier">RaceIdentifier</a>
---
### <a name="CultureReference"></a> `CultureReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CultureReference/id">See details</a>
#### <a name="CultureReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#CultureIdentifier">CultureIdentifier</a>
---
### <a name="ProfessionReference"></a> `ProfessionReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ProfessionReference/id">See details</a>
#### <a name="ProfessionReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ProfessionIdentifier">ProfessionIdentifier</a>
---
### <a name="ProfessionVariantReference"></a> `ProfessionVariantReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ProfessionVariantReference/id">See details</a>
#### <a name="ProfessionVariantReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ProfessionVariantIdentifier">ProfessionVariantIdentifier</a>
---
### <a name="AttributeReference"></a> `AttributeReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AttributeReference/id">See details</a>
#### <a name="AttributeReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#AttributeIdentifier">AttributeIdentifier</a>
---
### <a name="SkillReference"></a> `SkillReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SkillReference/id">See details</a>
#### <a name="SkillReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#SkillIdentifier">SkillIdentifier</a>
---
### <a name="SkillGroupReference"></a> `SkillGroupReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SkillGroupReference/id">See details</a>
#### <a name="SkillGroupReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#SkillGroupIdentifier">SkillGroupIdentifier</a>
---
### <a name="CombatTechniqueReference"></a> `CombatTechniqueReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CombatTechniqueReference/id">See details</a>
#### <a name="CombatTechniqueReference/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#CombatTechniqueIdentifier">CombatTechniqueIdentifier</a>
---
### <a name="CloseCombatTechniqueReference"></a> `CloseCombatTechniqueReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CloseCombatTechniqueReference/id">See details</a>
#### <a name="CloseCombatTechniqueReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#CloseCombatTechniqueIdentifier">CloseCombatTechniqueIdentifier</a>
---
### <a name="RangedCombatTechniqueReference"></a> `RangedCombatTechniqueReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#RangedCombatTechniqueReference/id">See details</a>
#### <a name="RangedCombatTechniqueReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#RangedCombatTechniqueIdentifier">RangedCombatTechniqueIdentifier</a>
---
### <a name="MagicalTraditionReference"></a> `MagicalTraditionReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#MagicalTraditionReference/id">See details</a>
#### <a name="MagicalTraditionReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#MagicalTraditionIdentifier">MagicalTraditionIdentifier</a>
---
### <a name="CantripReference"></a> `CantripReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CantripReference/id">See details</a>
#### <a name="CantripReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#CantripIdentifier">CantripIdentifier</a>
---
### <a name="SpellReference"></a> `SpellReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SpellReference/id">See details</a>
#### <a name="SpellReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#SpellIdentifier">SpellIdentifier</a>
---
### <a name="RitualReference"></a> `RitualReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#RitualReference/id">See details</a>
#### <a name="RitualReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#RitualIdentifier">RitualIdentifier</a>
---
### <a name="SpellworkReference"></a> `SpellworkReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SpellworkReference/id">See details</a>
#### <a name="SpellworkReference/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#SpellworkIdentifier">SpellworkIdentifier</a>
---
### <a name="PropertyReference"></a> `PropertyReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PropertyReference/id">See details</a>
#### <a name="PropertyReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PropertyIdentifier">PropertyIdentifier</a>
---
### <a name="BlessedTraditionReference"></a> `BlessedTraditionReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#BlessedTraditionReference/id">See details</a>
#### <a name="BlessedTraditionReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#BlessedTraditionIdentifier">BlessedTraditionIdentifier</a>
---
### <a name="BlessingReference"></a> `BlessingReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#BlessingReference/id">See details</a>
#### <a name="BlessingReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#BlessingIdentifier">BlessingIdentifier</a>
---
### <a name="LiturgicalChantReference"></a> `LiturgicalChantReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#LiturgicalChantReference/id">See details</a>
#### <a name="LiturgicalChantReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#LiturgicalChantIdentifier">LiturgicalChantIdentifier</a>
---
### <a name="CeremonyReference"></a> `CeremonyReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CeremonyReference/id">See details</a>
#### <a name="CeremonyReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#CeremonyIdentifier">CeremonyIdentifier</a>
---
### <a name="AspectReference"></a> `AspectReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AspectReference/id">See details</a>
#### <a name="AspectReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#AspectIdentifier">AspectIdentifier</a>
---
### <a name="AdvantageReference"></a> `AdvantageReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AdvantageReference/id">See details</a>
#### <a name="AdvantageReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#AdvantageIdentifier">AdvantageIdentifier</a>
---
### <a name="DisadvantageReference"></a> `DisadvantageReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#DisadvantageReference/id">See details</a>
#### <a name="DisadvantageReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#DisadvantageIdentifier">DisadvantageIdentifier</a>
---
### <a name="AdvancedSpecialAbilityReference"></a> `AdvancedSpecialAbilityReference<Identifier>`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AdvancedSpecialAbilityReference/id">See details</a>
#### <a name="AdvancedSpecialAbilityReference/id"></a> `id`
- **Type:** <a href="#Identifier">Identifier</a>
---
### <a name="LanguageReference"></a> `LanguageReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#LanguageReference/id">See details</a>
#### <a name="LanguageReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#LanguageIdentifier">LanguageIdentifier</a>
---
### <a name="ScriptReference"></a> `ScriptReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ScriptReference/id">See details</a>
#### <a name="ScriptReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ScriptIdentifier">ScriptIdentifier</a>
---
### <a name="SocialStatusReference"></a> `SocialStatusReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#SocialStatusReference/id">See details</a>
#### <a name="SocialStatusReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#SocialStatusIdentifier">SocialStatusIdentifier</a>
---
### <a name="CurriculumReference"></a> `CurriculumReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#CurriculumReference/id">See details</a>
#### <a name="CurriculumReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#CurriculumIdentifier">CurriculumIdentifier</a>
---
### <a name="GuidelineReference"></a> `GuidelineReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#GuidelineReference/id">See details</a>
#### <a name="GuidelineReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#GuidelineIdentifier">GuidelineIdentifier</a>
---
### <a name="AnimalTypeReference"></a> `AnimalTypeReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AnimalTypeReference/id">See details</a>
#### <a name="AnimalTypeReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#AnimalTypeIdentifier">AnimalTypeIdentifier</a>
---
### <a name="TargetCategoryReference"></a> `TargetCategoryReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#TargetCategoryReference/id">See details</a>
#### <a name="TargetCategoryReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#TargetCategoryIdentifier">TargetCategoryIdentifier</a>
---
### <a name="PatronCategoryReference"></a> `PatronCategoryReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PatronCategoryReference/id">See details</a>
#### <a name="PatronCategoryReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PatronCategoryIdentifier">PatronCategoryIdentifier</a>
---
### <a name="PersonalityTraitReference"></a> `PersonalityTraitReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PersonalityTraitReference/id">See details</a>
#### <a name="PersonalityTraitReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PersonalityTraitIdentifier">PersonalityTraitIdentifier</a>
---
### <a name="HairColorReference"></a> `HairColorReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#HairColorReference/id">See details</a>
#### <a name="HairColorReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#HairColorIdentifier">HairColorIdentifier</a>
---
### <a name="EyeColorReference"></a> `EyeColorReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#EyeColorReference/id">See details</a>
#### <a name="EyeColorReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#EyeColorIdentifier">EyeColorIdentifier</a>
---
### <a name="PactCategoryReference"></a> `PactCategoryReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PactCategoryReference/id">See details</a>
#### <a name="PactCategoryReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PactCategoryIdentifier">PactCategoryIdentifier</a>
---
### <a name="PactDomainReference"></a> `PactDomainReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PactDomainReference/id">See details</a>
#### <a name="PactDomainReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PactDomainIdentifier">PactDomainIdentifier</a>
---
### <a name="PatronReference"></a> `PatronReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#PatronReference/id">See details</a>
#### <a name="PatronReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#PatronIdentifier">PatronIdentifier</a>
---
### <a name="AnimistTribeReference"></a> `AnimistTribeReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#AnimistTribeReference/id">See details</a>
#### <a name="AnimistTribeReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#AnimistTribeIdentifier">AnimistTribeIdentifier</a>
---
### <a name="ElementReference"></a> `ElementReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ElementReference/id">See details</a>
#### <a name="ElementReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ElementIdentifier">ElementIdentifier</a>
---
### <a name="WeaponReference"></a> `WeaponReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#WeaponReference/id">See details</a>
#### <a name="WeaponReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#WeaponIdentifier">WeaponIdentifier</a>
---
### <a name="ArmorReference"></a> `ArmorReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#ArmorReference/id">See details</a>
#### <a name="ArmorReference/id"></a> `id`
- **Type:** <a href="./_Identifier.md#ArmorIdentifier">ArmorIdentifier</a>
---
### <a name="TraditionReference"></a> `TraditionReference`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | | <a href="#TraditionReference/id">See details</a>
#### <a name="TraditionReference/id"></a> `id`
- **Type:** <a href="./_IdentifierGroup.md#TraditionIdentifier">TraditionIdentifier</a>
docs/reference/_SkillCheck.md
-61
View File
@@ -1,61 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="SkillCheck"></a> Skill Check (`SkillCheck`)
The attributes' identifiers of the skill check.
- **Type:** List
- **Items:** <a href="#SkillCheck[]">SkillCheck[]</a>
---
### <a name="SkillCheck[]"></a> `SkillCheck[]`
- **Type:** <a href="./_SimpleReferences.md#AttributeReference">AttributeReference</a>
---
### <a name="SkillCheckPenalty"></a> Skill Check Penalty (`SkillCheckPenalty`)
A specific value that represents a penalty for the associated skill check.
- **Type:** Union
- **Cases:** <a href="#SkillCheckPenalty'0">SkillCheckPenalty'0</a> | <a href="#SkillCheckPenalty'1">SkillCheckPenalty'1</a> | <a href="#SkillCheckPenalty'2">SkillCheckPenalty'2</a> | <a href="#SkillCheckPenalty'3">SkillCheckPenalty'3</a> | <a href="#SkillCheckPenalty'4">SkillCheckPenalty'4</a> | <a href="#SkillCheckPenalty'5">SkillCheckPenalty'5</a>
---
### <a name="SkillCheckPenalty'0"></a> `SkillCheckPenalty'0`
- **Constant:** `"Spirit"`
---
### <a name="SkillCheckPenalty'1"></a> `SkillCheckPenalty'1`
- **Constant:** `"HalfOfSpirit"`
---
### <a name="SkillCheckPenalty'2"></a> `SkillCheckPenalty'2`
- **Constant:** `"Toughness"`
---
### <a name="SkillCheckPenalty'3"></a> `SkillCheckPenalty'3`
- **Constant:** `"HigherOfSpiritAndToughness"`
---
### <a name="SkillCheckPenalty'4"></a> `SkillCheckPenalty'4`
- **Constant:** `"SummoningDifficulty"`
---
### <a name="SkillCheckPenalty'5"></a> `SkillCheckPenalty'5`
- **Constant:** `"CreationDifficulty"`
docs/reference/_Spellwork.md
-70
View File
@@ -1,70 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Traditions"></a> `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:** <a href="#Traditions'General">Traditions'General</a> | <a href="#Traditions'Specific">Traditions'Specific</a>
---
### <a name="Traditions'General"></a> `Traditions'General`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#Traditions'General/tag">See details</a>
`general` | | <a href="#Traditions'General/general">See details</a>
#### <a name="Traditions'General/tag"></a> `tag`
- **Constant:** `"General"`
#### <a name="Traditions'General/general"></a> `general`
- **Type:** <a href="#Traditions'General/general">Object</a>
---
### <a name="Traditions'General/general"></a> `Traditions'General/general`
- **Type:** Empty Object
---
### <a name="Traditions'Specific"></a> `Traditions'Specific`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#Traditions'Specific/tag">See details</a>
`specific` | | <a href="#Traditions'Specific/specific">See details</a>
#### <a name="Traditions'Specific/tag"></a> `tag`
- **Constant:** `"Specific"`
#### <a name="Traditions'Specific/specific"></a> `specific`
- **Type:** <a href="#SpecificTraditions">SpecificTraditions</a>
---
### <a name="SpecificTraditions"></a> `SpecificTraditions`
A list of specific traditions.
- **Type:** List
- **Items:** <a href="#SpecificTraditions[]">SpecificTraditions[]</a>
- **Minimum Items:** `1`
---
### <a name="SpecificTraditions[]"></a> `SpecificTraditions[]`
- **Type:** <a href="./_Identifier.md#MagicalTraditionIdentifier">MagicalTraditionIdentifier</a>
docs/reference/equipment/EquipmentPackage.md
-86
View File
@@ -1,86 +0,0 @@
# Equipment Package
## Definitions
### <a name="EquipmentPackage"></a> Equipment Package (`EquipmentPackage`)
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The equipment package's identifier. An unique, increasing integer. | <a href="#EquipmentPackage/id">See details</a>
`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. | <a href="#EquipmentPackage/items">See details</a>
`src` | | <a href="#EquipmentPackage/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#EquipmentPackage/translations">See details</a>
#### <a name="EquipmentPackage/id"></a> `id`
The equipment package's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="EquipmentPackage/items"></a> `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.
- **Type:** List
- **Items:** <a href="#EquipmentPackage/items[]">EquipmentPackage/items[]</a>
- **Minimum Items:** `2`
#### <a name="EquipmentPackage/src"></a> `src`
- **Type:** <a href="../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="EquipmentPackage/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#EquipmentPackageTranslation">EquipmentPackageTranslation</a>&gt;
---
### <a name="EquipmentPackage/items[]"></a> `EquipmentPackage/items[]`
- **Type:** <a href="#EquipmentPackageItem">EquipmentPackageItem</a>
---
### <a name="EquipmentPackageItem"></a> `EquipmentPackageItem`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The item's identifier. | <a href="#EquipmentPackageItem/id">See details</a>
`number?` | The number of how often the item is included in the package. | <a href="#EquipmentPackageItem/number">See details</a>
#### <a name="EquipmentPackageItem/id"></a> `id`
The item's identifier.
- **Type:** <a href="../_IdentifierGroup.md#EquipmentIdentifier">EquipmentIdentifier</a>
#### <a name="EquipmentPackageItem/number"></a> `number?`
The number of how often the item is included in the package.
- **Type:** Integer
- **Default:** `1`
- **Minimum:** `2`
---
### <a name="EquipmentPackageTranslation"></a> `EquipmentPackageTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the equipment package. | <a href="#EquipmentPackageTranslation/name">See details</a>
#### <a name="EquipmentPackageTranslation/name"></a> `name`
The name of the equipment package.
- **Type:** <a href="../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
docs/reference/equipment/item/Ammunition.md
-57
View File
@@ -1,57 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Ammunition"></a> `Ammunition`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#Ammunition/cost">See details</a>
`src` | | <a href="#Ammunition/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Ammunition/translations">See details</a>
#### <a name="Ammunition/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="Ammunition/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Ammunition/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#AmmunitionTranslation">AmmunitionTranslation</a>&gt;
---
### <a name="AmmunitionTranslation"></a> `AmmunitionTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#AmmunitionTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#AmmunitionTranslation/secondary_name">See details</a>
`errata?` | | <a href="#AmmunitionTranslation/errata">See details</a>
#### <a name="AmmunitionTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AmmunitionTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="AmmunitionTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
docs/reference/equipment/item/Animal.md
-29
View File
@@ -1,29 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Animal"></a> `Animal`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#Animal/cost">See details</a>
`src` | | <a href="#Animal/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Animal/translations">See details</a>
#### <a name="Animal/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="Animal/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Animal/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
docs/reference/equipment/item/AnimalCare.md
-141
View File
@@ -1,141 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="AnimalCare"></a> `AnimalCare`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`type` | Values depending on whether the animal care is feed. | <a href="#AnimalCare/type">See details</a>
`src` | | <a href="#AnimalCare/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#AnimalCare/translations">See details</a>
#### <a name="AnimalCare/type"></a> `type`
Values depending on whether the animal care is feed.
- **Type:** <a href="#AnimalCareType">AnimalCareType</a>
#### <a name="AnimalCare/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="AnimalCare/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
---
### <a name="AnimalCareType"></a> `AnimalCareType`
Values depending on whether the animal care is feed.
- **Type:** Union
- **Cases:** <a href="#AnimalCareType'General">AnimalCareType'General</a> | <a href="#AnimalCareType'Feed">AnimalCareType'Feed</a>
---
### <a name="AnimalCareType'General"></a> `AnimalCareType'General`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalCareType'General/tag">See details</a>
`general` | | <a href="#AnimalCareType'General/general">See details</a>
#### <a name="AnimalCareType'General/tag"></a> `tag`
- **Constant:** `"General"`
#### <a name="AnimalCareType'General/general"></a> `general`
- **Type:** <a href="#GeneralAnimalCare">GeneralAnimalCare</a>
---
### <a name="AnimalCareType'Feed"></a> `AnimalCareType'Feed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalCareType'Feed/tag">See details</a>
`feed` | | <a href="#AnimalCareType'Feed/feed">See details</a>
#### <a name="AnimalCareType'Feed/tag"></a> `tag`
- **Constant:** `"Feed"`
#### <a name="AnimalCareType'Feed/feed"></a> `feed`
- **Type:** <a href="#AnimalFeed">AnimalFeed</a>
---
### <a name="GeneralAnimalCare"></a> `GeneralAnimalCare`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#GeneralAnimalCare/cost">See details</a>
`weight` | The weight in kg. | <a href="#GeneralAnimalCare/weight">See details</a>
#### <a name="GeneralAnimalCare/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="GeneralAnimalCare/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
---
### <a name="AnimalFeed"></a> `AnimalFeed`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#AnimalFeed/cost">See details</a>
#### <a name="AnimalFeed/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="#AnimalFeedCost">AnimalFeedCost</a>
---
### <a name="AnimalFeedCost"></a> `AnimalFeedCost`
- **Type:** Union
- **Cases:** <a href="#AnimalFeedCost'PerWeek">AnimalFeedCost'PerWeek</a>
---
### <a name="AnimalFeedCost'PerWeek"></a> `AnimalFeedCost'PerWeek`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#AnimalFeedCost'PerWeek/tag">See details</a>
`per_week` | | <a href="#AnimalFeedCost'PerWeek/per_week">See details</a>
#### <a name="AnimalFeedCost'PerWeek/tag"></a> `tag`
- **Constant:** `"PerWeek"`
#### <a name="AnimalFeedCost'PerWeek/per_week"></a> `per_week`
- **Type:** <a href="./_Item.md#FixedCost">FixedCost</a>
docs/reference/equipment/item/Armor.md
-407
View File
@@ -1,407 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Armor"></a> `Armor`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#Armor/cost">See details</a>
`weight` | The weight in kg. | <a href="#Armor/weight">See details</a>
`complexity` | The complexity of crafting the item. | <a href="#Armor/complexity">See details</a>
`protection` | The PRO value. | <a href="#Armor/protection">See details</a>
`encumbrance` | The ENC value. | <a href="#Armor/encumbrance">See details</a>
`has_additional_penalties` | Does the armor have additional penalties (MOV -1, INI -1)? | <a href="#Armor/has_additional_penalties">See details</a>
`armor_type` | The armor type. | <a href="#Armor/armor_type">See details</a>
`hit_zone?` | Specify if armor is only available for a specific hit zone. | <a href="#Armor/hit_zone">See details</a>
`src` | | <a href="#Armor/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Armor/translations">See details</a>
#### <a name="Armor/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="Armor/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="Armor/complexity"></a> `complexity`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="Armor/protection"></a> `protection`
The PRO value.
- **Type:** <a href="#Protection">Protection</a>
#### <a name="Armor/encumbrance"></a> `encumbrance`
The ENC value.
- **Type:** <a href="#Encumbrance">Encumbrance</a>
#### <a name="Armor/has_additional_penalties"></a> `has_additional_penalties`
Does the armor have additional penalties (MOV -1, INI -1)?
- **Type:** <a href="#HasAdditionalPenalties">HasAdditionalPenalties</a>
#### <a name="Armor/armor_type"></a> `armor_type`
The armor type.
- **Type:** <a href="#ArmorTypeReference">ArmorTypeReference</a>
#### <a name="Armor/hit_zone"></a> `hit_zone?`
Specify if armor is only available for a specific hit zone.
- **Type:** <a href="#HitZone">HitZone</a>
#### <a name="Armor/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Armor/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ArmorTranslation">ArmorTranslation</a>&gt;
---
### <a name="ArmorTranslation"></a> `ArmorTranslation`
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#ArmorTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#ArmorTranslation/secondary_name">See details</a>
`note?` | Note text. | <a href="#ArmorTranslation/note">See details</a>
`rules?` | Special rules text. | <a href="#ArmorTranslation/rules">See details</a>
`advantage?` | The armor advantage text. | <a href="#ArmorTranslation/advantage">See details</a>
`disadvantage?` | The armor disadvantage text. | <a href="#ArmorTranslation/disadvantage">See details</a>
`errata?` | | <a href="#ArmorTranslation/errata">See details</a>
#### <a name="ArmorTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ArmorTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ArmorTranslation/note"></a> `note?`
Note text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ArmorTranslation/rules"></a> `rules?`
Special rules text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ArmorTranslation/advantage"></a> `advantage?`
The armor advantage text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ArmorTranslation/disadvantage"></a> `disadvantage?`
The armor disadvantage text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ArmorTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
---
### <a name="SecondaryArmor"></a> `SecondaryArmor`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`protection` | The PRO value. | <a href="#SecondaryArmor/protection">See details</a>
`encumbrance` | The ENC value. | <a href="#SecondaryArmor/encumbrance">See details</a>
`has_additional_penalties` | Does the armor have additional penalties (MOV -1, INI -1)? | <a href="#SecondaryArmor/has_additional_penalties">See details</a>
`armor_type` | The armor type. | <a href="#SecondaryArmor/armor_type">See details</a>
`hit_zone?` | Specify if armor is only available for a specific hit zone. | <a href="#SecondaryArmor/hit_zone">See details</a>
`translations?` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#SecondaryArmor/translations">See details</a>
#### <a name="SecondaryArmor/protection"></a> `protection`
The PRO value.
- **Type:** <a href="#Protection">Protection</a>
#### <a name="SecondaryArmor/encumbrance"></a> `encumbrance`
The ENC value.
- **Type:** <a href="#Encumbrance">Encumbrance</a>
#### <a name="SecondaryArmor/has_additional_penalties"></a> `has_additional_penalties`
Does the armor have additional penalties (MOV -1, INI -1)?
- **Type:** <a href="#HasAdditionalPenalties">HasAdditionalPenalties</a>
#### <a name="SecondaryArmor/armor_type"></a> `armor_type`
The armor type.
- **Type:** <a href="#ArmorTypeReference">ArmorTypeReference</a>
#### <a name="SecondaryArmor/hit_zone"></a> `hit_zone?`
Specify if armor is only available for a specific hit zone.
- **Type:** <a href="#HitZone">HitZone</a>
#### <a name="SecondaryArmor/translations"></a> `translations?`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#SecondaryArmorTranslation">SecondaryArmorTranslation</a>&gt;
---
### <a name="SecondaryArmorTranslation"></a> `SecondaryArmorTranslation`
- **Type:** Object
- **Minimum Properties:** `1`
Key | Description | Details
:-- | :-- | :--
`advantage?` | The armor advantage text. | <a href="#SecondaryArmorTranslation/advantage">See details</a>
`disadvantage?` | The armor disadvantage text. | <a href="#SecondaryArmorTranslation/disadvantage">See details</a>
#### <a name="SecondaryArmorTranslation/advantage"></a> `advantage?`
The armor advantage text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="SecondaryArmorTranslation/disadvantage"></a> `disadvantage?`
The armor disadvantage text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
---
### <a name="Protection"></a> `Protection`
The PRO value.
- **Type:** Integer
- **Minimum:** `0`
---
### <a name="Encumbrance"></a> `Encumbrance`
The ENC value.
- **Type:** Integer
- **Minimum:** `0`
---
### <a name="HasAdditionalPenalties"></a> `HasAdditionalPenalties`
Does the armor have additional penalties (MOV -1, INI -1)?
- **Type:** Boolean
---
### <a name="ArmorTypeReference"></a> Armor Type (`ArmorTypeReference`)
The armor type.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The armor type's identifier. | <a href="#ArmorTypeReference/id">See details</a>
#### <a name="ArmorTypeReference/id"></a> `id`
The armor type's identifier.
- **Type:** Integer
- **Minimum:** `1`
- **Maximum:** `10`
---
### <a name="HitZone"></a> Hit Zone (`HitZone`)
Specify if armor is only available for a specific hit zone.
- **Type:** Union
- **Cases:** <a href="#HitZone'Head">HitZone'Head</a> | <a href="#HitZone'Torso">HitZone'Torso</a> | <a href="#HitZone'Arms">HitZone'Arms</a> | <a href="#HitZone'Legs">HitZone'Legs</a>
---
### <a name="HitZone'Head"></a> `HitZone'Head`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#HitZone'Head/tag">See details</a>
`head` | | <a href="#HitZone'Head/head">See details</a>
#### <a name="HitZone'Head/tag"></a> `tag`
- **Constant:** `"Head"`
#### <a name="HitZone'Head/head"></a> `head`
- **Type:** <a href="#HeadHitZone">HeadHitZone</a>
---
### <a name="HitZone'Torso"></a> `HitZone'Torso`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#HitZone'Torso/tag">See details</a>
`torso` | | <a href="#HitZone'Torso/torso">See details</a>
#### <a name="HitZone'Torso/tag"></a> `tag`
- **Constant:** `"Torso"`
#### <a name="HitZone'Torso/torso"></a> `torso`
- **Type:** <a href="#HitZone'Torso/torso">Object</a>
---
### <a name="HitZone'Torso/torso"></a> `HitZone'Torso/torso`
- **Type:** Empty Object
---
### <a name="HitZone'Arms"></a> `HitZone'Arms`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#HitZone'Arms/tag">See details</a>
`arms` | | <a href="#HitZone'Arms/arms">See details</a>
#### <a name="HitZone'Arms/tag"></a> `tag`
- **Constant:** `"Arms"`
#### <a name="HitZone'Arms/arms"></a> `arms`
- **Type:** <a href="#HitZone'Arms/arms">Object</a>
---
### <a name="HitZone'Arms/arms"></a> `HitZone'Arms/arms`
- **Type:** Empty Object
---
### <a name="HitZone'Legs"></a> `HitZone'Legs`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#HitZone'Legs/tag">See details</a>
`legs` | | <a href="#HitZone'Legs/legs">See details</a>
#### <a name="HitZone'Legs/tag"></a> `tag`
- **Constant:** `"Legs"`
#### <a name="HitZone'Legs/legs"></a> `legs`
- **Type:** <a href="#HitZone'Legs/legs">Object</a>
---
### <a name="HitZone'Legs/legs"></a> `HitZone'Legs/legs`
- **Type:** Empty Object
---
### <a name="HeadHitZone"></a> `HeadHitZone`
- **Type:** Object
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. | <a href="#HeadHitZone/combination_possibilities">See details</a>
#### <a name="HeadHitZone/combination_possibilities"></a> `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.
- **Type:** <a href="#HeadHitZoneCombinationPossibilities">HeadHitZoneCombinationPossibilities</a>
---
### <a name="HeadHitZoneCombinationPossibilities"></a> `HeadHitZoneCombinationPossibilities`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`armors` | A list of armors that can be combined with this armor. | <a href="#HeadHitZoneCombinationPossibilities/armors">See details</a>
`protection?` | The PRO value that is added to the PRO value of the other armor instead of adding the normale PRO value. | <a href="#HeadHitZoneCombinationPossibilities/protection">See details</a>
#### <a name="HeadHitZoneCombinationPossibilities/armors"></a> `armors`
A list of armors that can be combined with this armor.
- **Type:** List
- **Items:** <a href="#HeadHitZoneCombinationPossibilities/armors[]">HeadHitZoneCombinationPossibilities/armors[]</a>
- **Minimum Items:** `1`
#### <a name="HeadHitZoneCombinationPossibilities/protection"></a> `protection?`
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`
---
### <a name="HeadHitZoneCombinationPossibilities/armors[]"></a> `HeadHitZoneCombinationPossibilities/armors[]`
- **Type:** <a href="../../_SimpleReferences.md#ArmorReference">ArmorReference</a>
docs/reference/equipment/item/BandageOrRemedy.md
-57
View File
@@ -1,57 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="BandageOrRemedy"></a> `BandageOrRemedy`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#BandageOrRemedy/cost">See details</a>
`weight` | The weight in kg. | <a href="#BandageOrRemedy/weight">See details</a>
`complexity?` | The complexity of crafting the item. | <a href="#BandageOrRemedy/complexity">See details</a>
`structure_points?` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#BandageOrRemedy/structure_points">See details</a>
`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. | <a href="#BandageOrRemedy/combat_use">See details</a>
`src` | | <a href="#BandageOrRemedy/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#BandageOrRemedy/translations">See details</a>
#### <a name="BandageOrRemedy/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="BandageOrRemedy/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="BandageOrRemedy/complexity"></a> `complexity?`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="BandageOrRemedy/structure_points"></a> `structure_points?`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="BandageOrRemedy/combat_use"></a> `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.
- **Type:** <a href="./_Item.md#CombatUse">CombatUse</a>
#### <a name="BandageOrRemedy/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="BandageOrRemedy/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
docs/reference/equipment/item/Book.md
-106
View File
@@ -1,106 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Book"></a> `Book`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#Book/cost">See details</a>
`weight` | The weight in kg. | <a href="#Book/weight">See details</a>
`complexity` | The complexity of crafting the item. | <a href="#Book/complexity">See details</a>
`structure_points` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#Book/structure_points">See details</a>
`src` | | <a href="#Book/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Book/translations">See details</a>
#### <a name="Book/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="Book/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="Book/complexity"></a> `complexity`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="Book/structure_points"></a> `structure_points`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="Book/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Book/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#BookTranslation">BookTranslation</a>&gt;
---
### <a name="BookTranslation"></a> `BookTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#BookTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#BookTranslation/secondary_name">See details</a>
`language` | The language the book is written in. | <a href="#BookTranslation/language">See details</a>
`script` | The script that was used for the book. | <a href="#BookTranslation/script">See details</a>
`note?` | Note text. | <a href="#BookTranslation/note">See details</a>
`rules?` | Special rules text. | <a href="#BookTranslation/rules">See details</a>
`errata?` | | <a href="#BookTranslation/errata">See details</a>
#### <a name="BookTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="BookTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="BookTranslation/language"></a> `language`
The language the book is written in.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="BookTranslation/script"></a> `script`
The script that was used for the book.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="BookTranslation/note"></a> `note?`
Note text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="BookTranslation/rules"></a> `rules?`
Special rules text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="BookTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
docs/reference/equipment/item/CeremonialItem.md
-64
View File
@@ -1,64 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="CeremonialItem"></a> `CeremonialItem`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#CeremonialItem/cost">See details</a>
`weight` | The weight in kg. | <a href="#CeremonialItem/weight">See details</a>
`complexity?` | The complexity of crafting the item. | <a href="#CeremonialItem/complexity">See details</a>
`structure_points` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#CeremonialItem/structure_points">See details</a>
`associated_tradition` | The deity associated with the equipment item. | <a href="#CeremonialItem/associated_tradition">See details</a>
`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. | <a href="#CeremonialItem/combat_use">See details</a>
`src` | | <a href="#CeremonialItem/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#CeremonialItem/translations">See details</a>
#### <a name="CeremonialItem/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="CeremonialItem/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="CeremonialItem/complexity"></a> `complexity?`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="CeremonialItem/structure_points"></a> `structure_points`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="CeremonialItem/associated_tradition"></a> `associated_tradition`
The deity associated with the equipment item.
- **Type:** <a href="../../_SimpleReferences.md#BlessedTraditionReference">BlessedTraditionReference</a>
#### <a name="CeremonialItem/combat_use"></a> `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.
- **Type:** <a href="./_Item.md#CombatUse">CombatUse</a>
#### <a name="CeremonialItem/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="CeremonialItem/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
docs/reference/equipment/item/Clothes.md
-7
View File
@@ -1,7 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Clothes"></a> `Clothes`
- **Type:** <a href="./_Item.md#DefaultItem">DefaultItem</a>
docs/reference/equipment/item/Container.md
-7
View File
@@ -1,7 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Container"></a> `Container`
- **Type:** <a href="./_Item.md#DefaultItem">DefaultItem</a>
docs/reference/equipment/item/Elixir.md
-131
View File
@@ -1,131 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Elixir"></a> `Elixir`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`id` | The elixir's identifier. An unique, increasing integer. | <a href="#Elixir/id">See details</a>
`cost_per_ingredient_level` | The cost per ingredient level in silverthalers. | <a href="#Elixir/cost_per_ingredient_level">See details</a>
`laboratory` | The laboratory level needed to brew the elixir. | <a href="#Elixir/laboratory">See details</a>
`brewing_difficulty` | The brewing difficulty, which represents the challenge of creating an elixir. | <a href="#Elixir/brewing_difficulty">See details</a>
`trade_secret` | AP value and prerequisites of the elixir recipe’s trade secret. | <a href="#Elixir/trade_secret">See details</a>
`src` | | <a href="#Elixir/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Elixir/translations">See details</a>
#### <a name="Elixir/id"></a> `id`
The elixir's identifier. An unique, increasing integer.
- **Type:** Integer
- **Minimum:** `1`
#### <a name="Elixir/cost_per_ingredient_level"></a> `cost_per_ingredient_level`
The cost per ingredient level in silverthalers.
- **Type:** Number
#### <a name="Elixir/laboratory"></a> `laboratory`
The laboratory level needed to brew the elixir.
- **Type:** <a href="./_Herbary.md#LaboratoryLevel">LaboratoryLevel</a>
#### <a name="Elixir/brewing_difficulty"></a> `brewing_difficulty`
The brewing difficulty, which represents the challenge of creating an elixir.
- **Type:** Integer
#### <a name="Elixir/trade_secret"></a> `trade_secret`
AP value and prerequisites of the elixir recipe’s trade secret.
- **Type:** <a href="./_Herbary.md#RecipeTradeSecret">RecipeTradeSecret</a>
#### <a name="Elixir/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Elixir/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#ElixirTranslation">ElixirTranslation</a>&gt;
---
### <a name="ElixirTranslation"></a> `ElixirTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the elixir. | <a href="#ElixirTranslation/name">See details</a>
`alternative_names?` | A list of alternative names. | <a href="#ElixirTranslation/alternative_names">See details</a>
`typical_ingredients` | A list of typical ingredients. | <a href="#ElixirTranslation/typical_ingredients">See details</a>
`brewing_process_prerequisites?` | Prerequsites for the brewing process, if any. | <a href="#ElixirTranslation/brewing_process_prerequisites">See details</a>
`quality_levels` | The list of effects for each quality level. The first element represents QL 1, the second element QL 2, and so on. | <a href="#ElixirTranslation/quality_levels">See details</a>
`errata?` | | <a href="#ElixirTranslation/errata">See details</a>
#### <a name="ElixirTranslation/name"></a> `name`
The name of the elixir.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="ElixirTranslation/alternative_names"></a> `alternative_names?`
A list of alternative names.
- **Type:** List
- **Items:** <a href="#ElixirTranslation/alternative_names[]">ElixirTranslation/alternative_names[]</a>
- **Minimum Items:** `1`
#### <a name="ElixirTranslation/typical_ingredients"></a> `typical_ingredients`
A list of typical ingredients.
- **Type:** List
- **Items:** <a href="#ElixirTranslation/typical_ingredients[]">ElixirTranslation/typical_ingredients[]</a>
- **Minimum Items:** `1`
- **Unique Items:** Yes
#### <a name="ElixirTranslation/brewing_process_prerequisites"></a> `brewing_process_prerequisites?`
Prerequsites for the brewing process, if any.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="ElixirTranslation/quality_levels"></a> `quality_levels`
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:** <a href="#ElixirTranslation/quality_levels[]">ElixirTranslation/quality_levels[]</a>
#### <a name="ElixirTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
---
### <a name="ElixirTranslation/alternative_names[]"></a> `ElixirTranslation/alternative_names[]`
- **Type:** <a href="../../_AlternativeNames.md#AlternativeName">AlternativeName</a>
---
### <a name="ElixirTranslation/typical_ingredients[]"></a> `ElixirTranslation/typical_ingredients[]`
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
---
### <a name="ElixirTranslation/quality_levels[]"></a> `ElixirTranslation/quality_levels[]`
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
docs/reference/equipment/item/EquipmentOfBlessedOnes.md
-50
View File
@@ -1,50 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="EquipmentOfBlessedOnes"></a> `EquipmentOfBlessedOnes`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#EquipmentOfBlessedOnes/cost">See details</a>
`structure_points` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#EquipmentOfBlessedOnes/structure_points">See details</a>
`associated_tradition` | The deity associated with the equipment item. | <a href="#EquipmentOfBlessedOnes/associated_tradition">See details</a>
`src` | | <a href="#EquipmentOfBlessedOnes/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#EquipmentOfBlessedOnes/translations">See details</a>
#### <a name="EquipmentOfBlessedOnes/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="EquipmentOfBlessedOnes/structure_points"></a> `structure_points`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="EquipmentOfBlessedOnes/associated_tradition"></a> `associated_tradition`
The deity associated with the equipment item.
- **Type:** List
- **Items:** <a href="#EquipmentOfBlessedOnes/associated_tradition[]">EquipmentOfBlessedOnes/associated_tradition[]</a>
#### <a name="EquipmentOfBlessedOnes/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="EquipmentOfBlessedOnes/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
---
### <a name="EquipmentOfBlessedOnes/associated_tradition[]"></a> `EquipmentOfBlessedOnes/associated_tradition[]`
- **Type:** <a href="../../_SimpleReferences.md#BlessedTraditionReference">BlessedTraditionReference</a>
docs/reference/equipment/item/GemOrPreciousStone.md
-78
View File
@@ -1,78 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="GemOrPreciousStone"></a> `GemOrPreciousStone`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers per 10 karat. | <a href="#GemOrPreciousStone/cost">See details</a>
`src` | | <a href="#GemOrPreciousStone/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#GemOrPreciousStone/translations">See details</a>
#### <a name="GemOrPreciousStone/cost"></a> `cost`
The cost in silverthalers per 10 karat.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="GemOrPreciousStone/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="GemOrPreciousStone/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#GemOrPreciousStoneTranslation">GemOrPreciousStoneTranslation</a>&gt;
---
### <a name="GemOrPreciousStoneTranslation"></a> `GemOrPreciousStoneTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#GemOrPreciousStoneTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#GemOrPreciousStoneTranslation/secondary_name">See details</a>
`color` | The color of the gem or stone. | <a href="#GemOrPreciousStoneTranslation/color">See details</a>
`note?` | Note text. | <a href="#GemOrPreciousStoneTranslation/note">See details</a>
`rules?` | Special rules text. | <a href="#GemOrPreciousStoneTranslation/rules">See details</a>
`errata?` | | <a href="#GemOrPreciousStoneTranslation/errata">See details</a>
#### <a name="GemOrPreciousStoneTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="GemOrPreciousStoneTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="GemOrPreciousStoneTranslation/color"></a> `color`
The color of the gem or stone.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="GemOrPreciousStoneTranslation/note"></a> `note?`
Note text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="GemOrPreciousStoneTranslation/rules"></a> `rules?`
Special rules text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="GemOrPreciousStoneTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
docs/reference/equipment/item/IlluminationLightSource.md
-145
View File
@@ -1,145 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="IlluminationLightSource"></a> `IlluminationLightSource`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#IlluminationLightSource/cost">See details</a>
`weight` | The weight in kg. | <a href="#IlluminationLightSource/weight">See details</a>
`complexity?` | The complexity of crafting the item. | <a href="#IlluminationLightSource/complexity">See details</a>
`structure_points` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#IlluminationLightSource/structure_points">See details</a>
`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. | <a href="#IlluminationLightSource/burning_time">See details</a>
`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. | <a href="#IlluminationLightSource/combat_use">See details</a>
`src` | | <a href="#IlluminationLightSource/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#IlluminationLightSource/translations">See details</a>
#### <a name="IlluminationLightSource/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="IlluminationLightSource/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="IlluminationLightSource/complexity"></a> `complexity?`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="IlluminationLightSource/structure_points"></a> `structure_points`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="IlluminationLightSource/burning_time"></a> `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.
- **Type:** <a href="#BurningTime">BurningTime</a>
#### <a name="IlluminationLightSource/combat_use"></a> `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.
- **Type:** <a href="./_Item.md#CombatUse">CombatUse</a>
#### <a name="IlluminationLightSource/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="IlluminationLightSource/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
---
### <a name="BurningTime"></a> `BurningTime`
- **Type:** Union
- **Cases:** <a href="#BurningTime'Unlimited">BurningTime'Unlimited</a> | <a href="#BurningTime'Limited">BurningTime'Limited</a>
---
### <a name="BurningTime'Unlimited"></a> `BurningTime'Unlimited`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BurningTime'Unlimited/tag">See details</a>
`unlimited` | | <a href="#BurningTime'Unlimited/unlimited">See details</a>
#### <a name="BurningTime'Unlimited/tag"></a> `tag`
- **Constant:** `"Unlimited"`
#### <a name="BurningTime'Unlimited/unlimited"></a> `unlimited`
- **Type:** <a href="#BurningTime'Unlimited/unlimited">Object</a>
---
### <a name="BurningTime'Unlimited/unlimited"></a> `BurningTime'Unlimited/unlimited`
- **Type:** Empty Object
---
### <a name="BurningTime'Limited"></a> `BurningTime'Limited`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`tag` | | <a href="#BurningTime'Limited/tag">See details</a>
`limited` | | <a href="#BurningTime'Limited/limited">See details</a>
#### <a name="BurningTime'Limited/tag"></a> `tag`
- **Constant:** `"Limited"`
#### <a name="BurningTime'Limited/limited"></a> `limited`
- **Type:** <a href="#LimitedBurningTime">LimitedBurningTime</a>
---
### <a name="LimitedBurningTime"></a> `LimitedBurningTime`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`value` | The (unitless) time value. | <a href="#LimitedBurningTime/value">See details</a>
`unit` | The time unit. | <a href="#LimitedBurningTime/unit">See details</a>
#### <a name="LimitedBurningTime/value"></a> `value`
The (unitless) time value.
- **Type:** Number
- **Exclusive Minimum:** `0`
#### <a name="LimitedBurningTime/unit"></a> `unit`
The time unit.
- **Type:** <a href="#LimitedBurningTimeUnit">LimitedBurningTimeUnit</a>
---
### <a name="LimitedBurningTimeUnit"></a> `LimitedBurningTimeUnit`
- **Constant:** `"Hours"`
docs/reference/equipment/item/IlluminationRefillsOrSupplies.md
-7
View File
@@ -1,7 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="IlluminationRefillsOrSupplies"></a> `IlluminationRefillsOrSupplies`
- **Type:** <a href="./_Item.md#DefaultItem">DefaultItem</a>
docs/reference/equipment/item/Jewelry.md
-118
View File
@@ -1,118 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Jewelry"></a> `Jewelry`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#Jewelry/cost">See details</a>
`weight` | The weight in kg. | <a href="#Jewelry/weight">See details</a>
`complexity` | The complexity of crafting the item. | <a href="#Jewelry/complexity">See details</a>
`structure_points` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#Jewelry/structure_points">See details</a>
`src` | | <a href="#Jewelry/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#Jewelry/translations">See details</a>
#### <a name="Jewelry/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="#JewelryMaterialDifference">JewelryMaterialDifference</a>&lt;<a href="./_Item.md#Cost">Cost</a>&gt;
#### <a name="Jewelry/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="#JewelryMaterialDifference">JewelryMaterialDifference</a>&lt;<a href="./_Item.md#Weight">Weight</a>&gt;
#### <a name="Jewelry/complexity"></a> `complexity`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="Jewelry/structure_points"></a> `structure_points`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="Jewelry/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="Jewelry/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#JewelryTranslation">JewelryTranslation</a>&gt;
---
### <a name="JewelryMaterialDifference"></a> `JewelryMaterialDifference<T>`
Jewelry has different cost based on the material.
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`bronze` | | <a href="#JewelryMaterialDifference/bronze">See details</a>
`silver` | | <a href="#JewelryMaterialDifference/silver">See details</a>
`gold` | | <a href="#JewelryMaterialDifference/gold">See details</a>
#### <a name="JewelryMaterialDifference/bronze"></a> `bronze`
- **Type:** <a href="#T">T</a>
#### <a name="JewelryMaterialDifference/silver"></a> `silver`
- **Type:** <a href="#T">T</a>
#### <a name="JewelryMaterialDifference/gold"></a> `gold`
- **Type:** <a href="#T">T</a>
---
### <a name="JewelryTranslation"></a> `JewelryTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#JewelryTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#JewelryTranslation/secondary_name">See details</a>
`note?` | Note text. | <a href="#JewelryTranslation/note">See details</a>
`rules?` | Special rules text. | <a href="#JewelryTranslation/rules">See details</a>
`errata?` | | <a href="#JewelryTranslation/errata">See details</a>
#### <a name="JewelryTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="JewelryTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="JewelryTranslation/note"></a> `note?`
Note text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="JewelryTranslation/rules"></a> `rules?`
Special rules text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="JewelryTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
docs/reference/equipment/item/Liebesspielzeug.md
-7
View File
@@ -1,7 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="Liebesspielzeug"></a> `Liebesspielzeug`
- **Type:** <a href="./_Item.md#DefaultItem">DefaultItem</a>
docs/reference/equipment/item/LuxuryGood.md
-57
View File
@@ -1,57 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="LuxuryGood"></a> `LuxuryGood`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#LuxuryGood/cost">See details</a>
`weight` | The weight in kg. | <a href="#LuxuryGood/weight">See details</a>
`complexity?` | The complexity of crafting the item. | <a href="#LuxuryGood/complexity">See details</a>
`structure_points?` | The structure points of the item. Use an array if the item consists of multiple components that have individual structure points. | <a href="#LuxuryGood/structure_points">See details</a>
`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. | <a href="#LuxuryGood/combat_use">See details</a>
`src` | | <a href="#LuxuryGood/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#LuxuryGood/translations">See details</a>
#### <a name="LuxuryGood/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="LuxuryGood/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="LuxuryGood/complexity"></a> `complexity?`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="LuxuryGood/structure_points"></a> `structure_points?`
The structure points of the item. Use an array if the item consists of multiple components that have individual structure points.
- **Type:** <a href="./_Item.md#StructurePoints">StructurePoints</a>
#### <a name="LuxuryGood/combat_use"></a> `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.
- **Type:** <a href="./_Item.md#CombatUse">CombatUse</a>
#### <a name="LuxuryGood/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="LuxuryGood/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
docs/reference/equipment/item/MagicalArtifact.md
-71
View File
@@ -1,71 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="MagicalArtifact"></a> `MagicalArtifact`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#MagicalArtifact/cost">See details</a>
`src` | | <a href="#MagicalArtifact/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#MagicalArtifact/translations">See details</a>
#### <a name="MagicalArtifact/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="MagicalArtifact/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="MagicalArtifact/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="#MagicalArtifactTranslation">MagicalArtifactTranslation</a>&gt;
---
### <a name="MagicalArtifactTranslation"></a> `MagicalArtifactTranslation`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`name` | The name of the item. | <a href="#MagicalArtifactTranslation/name">See details</a>
`secondary_name?` | An auxiliary name or label of the item, if available. | <a href="#MagicalArtifactTranslation/secondary_name">See details</a>
`note?` | Note text. | <a href="#MagicalArtifactTranslation/note">See details</a>
`rules?` | Special rules text. | <a href="#MagicalArtifactTranslation/rules">See details</a>
`errata?` | | <a href="#MagicalArtifactTranslation/errata">See details</a>
#### <a name="MagicalArtifactTranslation/name"></a> `name`
The name of the item.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="MagicalArtifactTranslation/secondary_name"></a> `secondary_name?`
An auxiliary name or label of the item, if available.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyString">NonEmptyString</a>
#### <a name="MagicalArtifactTranslation/note"></a> `note?`
Note text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="MagicalArtifactTranslation/rules"></a> `rules?`
Special rules text.
- **Type:** <a href="../../_NonEmptyString.md#NonEmptyMarkdown">NonEmptyMarkdown</a>
#### <a name="MagicalArtifactTranslation/errata"></a> `errata?`
- **Type:** <a href="../../source/_Erratum.md#Errata">Errata</a>
docs/reference/equipment/item/MusicalInstrument.md
-50
View File
@@ -1,50 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="MusicalInstrument"></a> `MusicalInstrument`
- **Type:** Object
Key | Description | Details
:-- | :-- | :--
`cost` | The cost in silverthalers. | <a href="#MusicalInstrument/cost">See details</a>
`weight` | The weight in kg. | <a href="#MusicalInstrument/weight">See details</a>
`complexity?` | The complexity of crafting the item. | <a href="#MusicalInstrument/complexity">See details</a>
`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. | <a href="#MusicalInstrument/combat_use">See details</a>
`src` | | <a href="#MusicalInstrument/src">See details</a>
`translations` | All translations for the entry, identified by IETF language tag (BCP47). | <a href="#MusicalInstrument/translations">See details</a>
#### <a name="MusicalInstrument/cost"></a> `cost`
The cost in silverthalers.
- **Type:** <a href="./_Item.md#Cost">Cost</a>
#### <a name="MusicalInstrument/weight"></a> `weight`
The weight in kg.
- **Type:** <a href="./_Item.md#Weight">Weight</a>
#### <a name="MusicalInstrument/complexity"></a> `complexity?`
The complexity of crafting the item.
- **Type:** <a href="./_Item.md#Complexity">Complexity</a>
#### <a name="MusicalInstrument/combat_use"></a> `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.
- **Type:** <a href="./_Item.md#CombatUse">CombatUse</a>
#### <a name="MusicalInstrument/src"></a> `src`
- **Type:** <a href="../../source/_PublicationRef.md#PublicationRefs">PublicationRefs</a>
#### <a name="MusicalInstrument/translations"></a> `translations`
All translations for the entry, identified by IETF language tag (BCP47).
- **Type:** <a href="../../_LocaleMap.md#LocaleMap">LocaleMap</a>&lt;<a href="./_Item.md#DefaultItemTranslation">DefaultItemTranslation</a>&gt;
docs/reference/equipment/item/OrienteeringAid.md
-7
View File
@@ -1,7 +0,0 @@
# [TITLE MISSING]
## Definitions
### <a name="OrienteeringAid"></a> `OrienteeringAid`
- **Type:** <a href="./_Item.md#DefaultItem">DefaultItem</a>

Some files were not shown because too many files have changed in this diff Show More