50 KiB
[TITLE MISSING]
Definitions
SelectOptionCategory
- Type: Union
- Cases: SelectOptionCategory'Blessings | SelectOptionCategory'Cantrips | SelectOptionCategory'TradeSecrets | SelectOptionCategory'Scripts | SelectOptionCategory'AnimalShapes | SelectOptionCategory'ArcaneBardTraditions | SelectOptionCategory'ArcaneDancerTraditions | SelectOptionCategory'SexPractices | SelectOptionCategory'Races | SelectOptionCategory'Cultures | SelectOptionCategory'RacesAndCultures | SelectOptionCategory'BlessedTraditions | SelectOptionCategory'Elements | SelectOptionCategory'Properties | SelectOptionCategory'Aspects | SelectOptionCategory'Diseases | SelectOptionCategory'Poisons | SelectOptionCategory'Languages | SelectOptionCategory'Skills | SelectOptionCategory'CombatTechniques | SelectOptionCategory'TargetCategories
SelectOptionCategory'Blessings
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
blessings |
See details |
tag
- Constant:
"Blessings"
blessings
- Type: Object
SelectOptionCategory'Blessings/blessings
- Type: Empty Object
SelectOptionCategory'Cantrips
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
cantrips |
See details |
tag
- Constant:
"Cantrips"
cantrips
- Type: Object
SelectOptionCategory'Cantrips/cantrips
- Type: Empty Object
SelectOptionCategory'TradeSecrets
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
trade_secrets |
See details |
tag
- Constant:
"TradeSecrets"
trade_secrets
- Type: Object
SelectOptionCategory'TradeSecrets/trade_secrets
- Type: Empty Object
SelectOptionCategory'Scripts
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
scripts |
See details |
tag
- Constant:
"Scripts"
scripts
- Type: Object
SelectOptionCategory'Scripts/scripts
- Type: Empty Object
SelectOptionCategory'AnimalShapes
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
animal_shapes |
See details |
tag
- Constant:
"AnimalShapes"
animal_shapes
- Type: Object
SelectOptionCategory'AnimalShapes/animal_shapes
- Type: Empty Object
SelectOptionCategory'ArcaneBardTraditions
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
arcane_bard_traditions |
See details |
tag
- Constant:
"ArcaneBardTraditions"
arcane_bard_traditions
- Type: Object
SelectOptionCategory'ArcaneBardTraditions/arcane_bard_traditions
- Type: Empty Object
SelectOptionCategory'ArcaneDancerTraditions
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
arcane_dancer_traditions |
See details |
tag
- Constant:
"ArcaneDancerTraditions"
arcane_dancer_traditions
- Type: Object
SelectOptionCategory'ArcaneDancerTraditions/arcane_dancer_traditions
- Type: Empty Object
SelectOptionCategory'SexPractices
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
sex_practices |
See details |
tag
- Constant:
"SexPractices"
sex_practices
- Type: Object
SelectOptionCategory'SexPractices/sex_practices
- Type: Empty Object
SelectOptionCategory'Races
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
races |
See details |
tag
- Constant:
"Races"
races
- Type: Object
SelectOptionCategory'Races/races
- Type: Empty Object
SelectOptionCategory'Cultures
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
cultures |
See details |
tag
- Constant:
"Cultures"
cultures
- Type: Object
SelectOptionCategory'Cultures/cultures
- Type: Empty Object
SelectOptionCategory'RacesAndCultures
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
races_and_cultures |
See details |
tag
- Constant:
"RacesAndCultures"
races_and_cultures
- Type: Object
SelectOptionCategory'RacesAndCultures/races_and_cultures
- Type: Empty Object
SelectOptionCategory'BlessedTraditions
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
blessed_traditions |
See details |
tag
- Constant:
"BlessedTraditions"
blessed_traditions
SelectOptionCategory'Elements
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
elements |
See details |
tag
- Constant:
"Elements"
elements
SelectOptionCategory'Properties
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
properties |
See details |
tag
- Constant:
"Properties"
properties
SelectOptionCategory'Aspects
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
aspects |
See details |
tag
- Constant:
"Aspects"
aspects
SelectOptionCategory'Diseases
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
diseases |
See details |
tag
- Constant:
"Diseases"
diseases
SelectOptionCategory'Poisons
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
poisons |
See details |
tag
- Constant:
"Poisons"
poisons
SelectOptionCategory'Languages
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
languages |
See details |
tag
- Constant:
"Languages"
languages
SelectOptionCategory'Skills
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
skills |
See details |
tag
- Constant:
"Skills"
skills
SelectOptionCategory'CombatTechniques
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
combat_techniques |
See details |
tag
- Constant:
"CombatTechniques"
combat_techniques
SelectOptionCategory'TargetCategories
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
target_categories |
See details |
tag
- Constant:
"TargetCategories"
target_categories
BlessedTraditionsSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
require_principles? |
Should the principles (code) of the tradition be required to select the respective tradition? | See details |
require_principles?
Should the principles (code) of the tradition be required to select the respective tradition?
- Constant:
true
ElementsSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
specific? |
Only include entries with the listed identifiers. | See details |
specific?
Only include entries with the listed identifiers.
- Type: List
- Items: ElementsSelectOptionCategory/specific[]
- Minimum Items:
1 - Unique Items: Yes
ElementsSelectOptionCategory/specific[]
- Type: ElementReference
PropertiesSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
require_knowledge? |
Does each property require it's corresponding property knowledge? | See details |
require_minimum_spellworks_on? |
Require a minimum number of spellworks of the respective property to be on a minimum skill rating. | See details |
require_knowledge?
Does each property require it's corresponding property knowledge?
- Constant:
true
require_minimum_spellworks_on?
Require a minimum number of spellworks of the respective property to be on a minimum skill rating.
AspectSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
require_knowledge? |
Does each aspect require it's corresponding aspect knowledge? | See details |
use_master_of_suffix_as_name? |
The generated name should be the Master of (Aspect) suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list. | See details |
require_minimum_liturgies_on? |
Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating. | See details |
require_knowledge?
Does each aspect require it's corresponding aspect knowledge?
- Constant:
true
use_master_of_suffix_as_name?
The generated name should be the Master of (Aspect) suffix for this aspect instead of the aspect's name. If an aspect does not provide a suffix (such as the General aspect), it is automatically excluded from the list.
- Constant:
true
require_minimum_liturgies_on?
Require a minimum number of liturgies of the respective aspect to be on a minimum skill rating.
RequiredMinimumSkillsToBeOnSkillRating
Require a minimum number of spellworks/liturgies of the respective property/aspect to be on a minimum skill rating.
- Type: Object
| Key | Description | Details |
|---|---|---|
number |
The minimum number of liturgies that need to be on the defined minimum skill rating. | See details |
rating |
The minimum skill rating the defined minimum number of liturgies need to be on. | See details |
number
The minimum number of liturgies that need to be on the defined minimum skill rating.
- Type: Integer
- Minimum:
1
rating
The minimum skill rating the defined minimum number of liturgies need to be on.
- Type: Integer
- Minimum:
1
DiseasesPoisonsSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
use_half_level_as_ap_value? |
Only convert half the disease/poison level into the AP value. | See details |
use_half_level_as_ap_value?
Only convert half the disease/poison level into the AP value.
- Constant:
true
LanguagesSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
prerequisites? |
Generate prerequisites for each entry of the category. | See details |
prerequisites?
Generate prerequisites for each entry of the category.
- Type: List
- Items: LanguagesSelectOptionCategory/prerequisites[]
- Minimum Items:
1
LanguagesSelectOptionCategory/prerequisites[]
LanguagesSelectOptionCategoryPrerequisite
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
select_option |
See details |
tag
- Constant:
"SelectOption"
select_option
- Type: OptionPrerequisite
SkillsSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
categories |
A list of skill categories. | See details |
ap_value? |
Generate AP values for each entry. | See details |
categories
A list of skill categories.
- Type: List
- Items: SkillsSelectOptionCategory/categories[]
- Minimum Items:
1
ap_value?
Generate AP values for each entry.
SkillsSelectOptionCategory/categories[]
SkillsSelectOptionCategoryCategory
- Type: Union
- Cases: SkillsSelectOptionCategoryCategory'Skills | SkillsSelectOptionCategoryCategory'Spells | SkillsSelectOptionCategoryCategory'Rituals | SkillsSelectOptionCategoryCategory'LiturgicalChants | SkillsSelectOptionCategoryCategory'Ceremonies
SkillsSelectOptionCategoryCategory'Skills
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
skills |
See details |
tag
- Constant:
"Skills"
skills
SkillsSelectOptionCategoryCategory'Spells
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
spells |
See details |
tag
- Constant:
"Spells"
spells
SkillsSelectOptionCategoryCategory'Rituals
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
rituals |
See details |
tag
- Constant:
"Rituals"
rituals
SkillsSelectOptionCategoryCategory'LiturgicalChants
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
liturgical_chants |
See details |
tag
- Constant:
"LiturgicalChants"
liturgical_chants
SkillsSelectOptionCategoryCategory'Ceremonies
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
ceremonies |
See details |
tag
- Constant:
"Ceremonies"
ceremonies
SkillSelectOptionCategoryCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
groups? |
Only include entries of the specified groups. | See details |
specific? |
Only include (Intersection) or exclude (Difference) specific skills. |
See details |
skill_applications? |
Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. | See details |
skill_uses? |
Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry. | See details |
prerequisites? |
Generate prerequisites for each entry of the category. | See details |
ap_value? |
Generate AP values for each entry. | See details |
groups?
Only include entries of the specified groups.
- Type: List
- Items: SkillSelectOptionCategoryCategory/groups[]
- Minimum Items:
1
specific?
Only include (Intersection) or exclude (Difference) specific skills.
skill_applications?
Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry.
- Type: List
- Items: SkillSelectOptionCategoryCategory/skill_applications[]
- Minimum Items:
1
skill_uses?
Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier, the skill it belongs to is derived from the select option automatically. A translation can be left out if its name equals the name of the origin entry.
- Type: List
- Items: SkillSelectOptionCategoryCategory/skill_uses[]
- Minimum Items:
1
prerequisites?
Generate prerequisites for each entry of the category.
- Type: List
- Items: SkillSelectOptionCategoryCategory/prerequisites[]
- Minimum Items:
1
ap_value?
Generate AP values for each entry.
SkillSelectOptionCategoryCategory/groups[]
- Type: SkillGroupReference
SkillSelectOptionCategoryCategory/skill_applications[]
- Type: SkillApplicationOrUse
SkillSelectOptionCategoryCategory/skill_uses[]
- Type: SkillApplicationOrUse
SkillSelectOptionCategoryCategory/prerequisites[]
CombatTechniquesSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
categories |
A list of combat technique categories. | See details |
ap_value? |
Generate AP values for each entry. | See details |
categories
A list of combat technique categories.
- Type: List
- Items: CombatTechniquesSelectOptionCategory/categories[]
- Minimum Items:
1
ap_value?
Generate AP values for each entry.
CombatTechniquesSelectOptionCategory/categories[]
CombatTechniquesSelectOptionCategoryCategory
- Type: Union
- Cases: CombatTechniquesSelectOptionCategoryCategory'CloseCombatTechniques | CombatTechniquesSelectOptionCategoryCategory'RangedCombatTechniques
CombatTechniquesSelectOptionCategoryCategory'CloseCombatTechniques
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
close_combat_techniques |
See details |
tag
- Constant:
"CloseCombatTechniques"
close_combat_techniques
CombatTechniquesSelectOptionCategoryCategory'RangedCombatTechniques
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
ranged_combat_techniques |
See details |
tag
- Constant:
"RangedCombatTechniques"
ranged_combat_techniques
SkillApplicationOrUse
- Type: Object
| Key | Description | Details |
|---|---|---|
id |
The application's or use's identifier. An entry-unique, increasing integer. | See details |
translations? |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
id
The application's or use's identifier. An entry-unique, increasing integer.
- Type: Integer
- Minimum:
1
translations?
All translations for the entry, identified by IETF language tag (BCP47).
SkillApplicationOrUseTranslation
- Type: Object
| Key | Description | Details |
|---|---|---|
name |
The name of the application or use if different from the activatable entry's name. | See details |
name
The name of the application or use if different from the activatable entry's name.
- Type: String
- Minimum Length:
1
GenericSkillsSelectOptionCategoryCategory<Ref>
- Type: Object
| Key | Description | Details |
|---|---|---|
specific? |
Only include (Intersection) or exclude (Difference) specific entries. |
See details |
prerequisites? |
Generate prerequisites for each entry of the category. | See details |
specific?
Only include (Intersection) or exclude (Difference) specific entries.
prerequisites?
Generate prerequisites for each entry of the category.
- Type: List
- Items: GenericSkillsSelectOptionCategoryCategory/prerequisites[]
- Minimum Items:
1
GenericSkillsSelectOptionCategoryCategory/prerequisites[]
SpecificFromSkillSelectOptionCategoryCategory<Ref>
- Type: Object
| Key | Description | Details |
|---|---|---|
operation |
See details | |
list |
The list of specific entries. | See details |
operation
list
The list of specific entries.
- Type: List
- Items: SpecificFromSkillSelectOptionCategoryCategory/list[]
- Minimum Items:
1 - Unique Items: Yes
SpecificFromSkillSelectOptionCategoryCategory/list[]
- Type: Ref
SpecificFromSkillSelectOptionCategoryCategoryOperation
Only include (Intersection) or exclude (Difference) specific entries.
- Type: Union
- Cases: SpecificFromSkillSelectOptionCategoryCategoryOperation'0 | SpecificFromSkillSelectOptionCategoryCategoryOperation'1
SpecificFromSkillSelectOptionCategoryCategoryOperation'0
- Constant:
"Intersection"
SpecificFromSkillSelectOptionCategoryCategoryOperation'1
- Constant:
"Difference"
SkillSelectOptionCategoryPrerequisite
- Type: Union
- Cases: SkillSelectOptionCategoryPrerequisite'Self | SkillSelectOptionCategoryPrerequisite'SelectOption
SkillSelectOptionCategoryPrerequisite'Self
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
self |
See details |
tag
- Constant:
"Self"
self
- Type: SelfPrerequisite
SkillSelectOptionCategoryPrerequisite'SelectOption
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
select_option |
See details |
tag
- Constant:
"SelectOption"
select_option
- Type: OptionPrerequisite
SelfPrerequisite
- Type: Object
| Key | Description | Details |
|---|---|---|
value |
The entry requires itself on a certain Skill Rating. | See details |
value
The entry requires itself on a certain Skill Rating.
- Type: Integer
- Minimum:
1
OptionPrerequisite
The entry requires or prohibits itself as a select option of another entry.
- Type: Object
| Key | Description | Details |
|---|---|---|
id |
The target entry's identifier. | See details |
active |
Is the select option required (true) or prohibited (false)? |
See details |
level? |
The required level, if any. | See details |
id
The target entry's identifier.
- Type: ActivatableIdentifier
active
Is the select option required (true) or prohibited (false)?
- Type: Boolean
level?
The required level, if any.
- Type: Integer
- Minimum:
2
SelectOptionsAdventurePointsValue<Identifier>
Generate AP values for each entry.
- Type: Union
- Cases: SelectOptionsAdventurePointsValue'DerivedFromImprovementCost | SelectOptionsAdventurePointsValue'Fixed
SelectOptionsAdventurePointsValue'DerivedFromImprovementCost
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
derived_from_improvement_cost |
See details |
tag
- Constant:
"DerivedFromImprovementCost"
derived_from_improvement_cost
SelectOptionsAdventurePointsValue'Fixed
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
fixed |
See details |
tag
- Constant:
"Fixed"
fixed
SelectOptionsDeriveAdventurePointsValueFromImprovementCost
Derive the cost from the improvement cost of each entry.
Calculation: AP Value = Improvement Cost × multiplier + offset
- Type: Object
| Key | Description | Details |
|---|---|---|
multiplier? |
This number is multiplied with the improvement cost of the entry (A = 1 to D = 4). | See details |
offset? |
This number is added to the multiplied improvement cost of the entry. | See details |
multiplier?
This number is multiplied with the improvement cost of the entry (A = 1 to D = 4).
- Type: Integer
- Default:
1 - Minimum:
2
offset?
This number is added to the multiplied improvement cost of the entry.
- Type: Integer
- Default:
0
SelectOptionsFixedAdventurePointsValue<Identifier>
- Type: Object
| Key | Description | Details |
|---|---|---|
map |
A mapping of skill identifiers to their specific AP values. | See details |
default |
The default value of an entry. Used as a fallback if no value is found in list. |
See details |
map
A mapping of skill identifiers to their specific AP values.
- Type: List
- Items: SelectOptionsFixedAdventurePointsValue/map[]
default
The default value of an entry. Used as a fallback if no value is found in list.
- Type: Integer
- Minimum:
1
SelectOptionsFixedAdventurePointsValue/map[]
SelectOptionsFixedAdventurePointsValueMapping<Identifier>
- Type: Object
| Key | Description | Details |
|---|---|---|
id |
The entry's identifier. | See details |
ap_value |
The AP value for the specified entry. | See details |
id
The entry's identifier.
- Type: Identifier
ap_value
The AP value for the specified entry.
- Type: Integer
- Minimum:
1
TargetCategoriesSelectOptionCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
list |
A list of combat technique categories. | See details |
list
A list of combat technique categories.
- Type: List
- Items: TargetCategoriesSelectOptionCategory/list[]
- Minimum Items:
1
TargetCategoriesSelectOptionCategory/list[]
- Type: SpecificTargetCategory
SpecificTargetCategory
- Type: Object
| Key | Description | Details |
|---|---|---|
id |
The target category’s identifier. | See details |
volume? |
The volume for this specific selection. | See details |
id
The target category’s identifier.
- Type: TargetCategoryIdentifier
volume?
The volume for this specific selection.
- Type: Integer
- Minimum:
0