optolith/database-schema
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f865a340588fbc0a1d0c42b078b92412ea7dfc61
database-schema/docs/reference/_Activatable.md
T

136 KiB
Raw Blame History

Activatable

General type specifications used by multiple activatable entries.

Definitions

Id

The activatable entry's identifier. An unique, increasing integer.

  • Type: Integer
  • Minimum: 0

Name

The name of the activatable entry.

  • Type: String
  • Minimum Length: 1

NameInLibrary

The full name of the entry as stated in the sources. Only use when name needs to be different from full name for text generation purposes.

  • Type: String
  • Minimum Length: 1

Levels

Number of available levels.

  • Type: Integer
  • Minimum: 2

Maximum

The number stating how often you can buy the entry. The default depends on the entry type:

  • Advantage: 1 in all cases (as specified in the Core Rules)
  • Disadvantage: 1 in all cases (as specified in the Core Rules)
  • Special Abilities: 1 if no options can be selected, otherwise the number of possible options

The maximum is only set if it differs from the defaults specified above.

  • Type: Integer
  • Minimum: 1

SelectOptions

Definitions for possible options for the activatable entry. They can either be derived from entry categories or be defined explicitly. Both can happen as well, but if there is an explicitly defined select option and a derived select option has the same identifier (which may only happen if skill or combat technique identifiers are used for explicit select options), the explicit definition overwrites the derived option.

Note that this is only a full definition of options for simple logic that can be made explicit using the more detailed configuration for both derived categories and explicit options. There are quite a few entries whose option logic cannot be fully represented here, so that it needs to be implemented manually.

  • Type: Object
  • Minimum Properties: 1
Key Description Details
derived? An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then. See details
explicit? A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the src property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page. See details

derived?

An entry category with optional further configuration. All available entries from the specified categories will be included as separate select options. You can also specify a set of groups that should only be included. Groups not mentioned will be excluded then.

explicit?

A list of explicit select options. If the identifier has a specific type, its entry is the base of this select option, where values defined here override values from the base. Define the src property if the options are not derived from the rules text of the advantage/disadvantage/special ability but instead are listed in a separate block and/or on a separate page.

SelectOptions/explicit[]

ExplicitSelectOption

ExplicitSelectOption'General

  • Type: Object
Key Description Details
tag See details
general See details

tag

  • Constant: "General"

general

ExplicitSelectOption'Skill

  • Type: Object
Key Description Details
tag See details
skill See details

tag

  • Constant: "Skill"

skill

ExplicitSelectOption'CombatTechnique

  • Type: Object
Key Description Details
tag See details
combat_technique See details

tag

  • Constant: "CombatTechnique"

combat_technique

ExplicitGeneralSelectOption

  • Type: Object
Key Description Details
id The option's identifier. An unique, increasing integer. See details
profession_only? Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user. 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 and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. 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 and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. See details
prerequisites? See details
binding_cost? Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. See details
ap_value? Specific AP cost for the select option. See details
src? See details
translations All translations for the entry, identified by IETF language tag (BCP47). See details

id

The option's identifier. An unique, increasing integer.

  • Type: Integer
  • Minimum: 1

profession_only?

Sometimes, professions use specific text selections that are not contained in described lists. This ensures you can use them for professions only. They are not going to be displayed as options to the user.

  • Constant: true

skill_applications?

Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.

skill_uses?

Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.

prerequisites?

binding_cost?

Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.

  • Type: Integer
  • Minimum: 0

ap_value?

Specific AP cost for the select option.

  • Type: Integer
  • Minimum: 1

src?

translations

All translations for the entry, identified by IETF language tag (BCP47).

ExplicitGeneralSelectOptionTranslation

  • Type: Object
Key Description Details
name The name of the select option. See details
name_in_profession? The name of the select option when displayed in a generated profession text. See details
description? The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available. See details
errata? See details

name

The name of the select option.

  • Type: String
  • Minimum Length: 1

name_in_profession?

The name of the select option when displayed in a generated profession text.

  • Type: String
  • Minimum Length: 1

description?

The description of the select option. Useful for Bad Habits, Trade Secrets and other entries where a description is available.

  • Type: Markdown-formatted text
  • Minimum Length: 1

errata?

ExplicitSkillSelectOption

  • Type: Object
Key Description Details
id The skill's identifier. An unique, increasing integer. 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 and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. 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 and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option. See details
prerequisites? See details
binding_cost? Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. See details
ap_value? Specific AP cost for the select option. See details
src? See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

id

The skill's identifier. An unique, increasing integer.

skill_applications?

Registers new applications, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.

skill_uses?

Registers uses, which get enabled once this entry is activated with its respective select option. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin select option.

prerequisites?

binding_cost?

Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.

  • Type: Integer
  • Minimum: 0

ap_value?

Specific AP cost for the select option.

  • Type: Integer
  • Minimum: 1

src?

translations?

All translations for the entry, identified by IETF language tag (BCP47).

ExplicitSkillSelectOption/skill_applications[]

ExplicitSkillSelectOption/skill_uses[]

ExplicitSkillSelectOptionTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
errata? See details

errata?

ExplicitCombatTechniqueSelectOption

  • Type: Object
Key Description Details
id The combat technique's identifier. See details
prerequisites? See details
binding_cost? Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs. See details
ap_value? Specific AP cost for the select option. See details
src? See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

id

The combat technique's identifier.

prerequisites?

binding_cost?

Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.

  • Type: Integer
  • Minimum: 0

ap_value?

Specific AP cost for the select option.

  • Type: Integer
  • Minimum: 1

src?

translations?

All translations for the entry, identified by IETF language tag (BCP47).

ExplicitCombatTechniqueSelectOptionTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
errata? See details

errata?

Rules

The rule text.

Effect

The effect description.

CombatSpecialAbilityUsageType

The definition of how the combat special ability can be used in combat.

CombatSpecialAbilityUsageType'0

  • Constant: "Passive"

CombatSpecialAbilityUsageType'1

  • Constant: "BasicManeuver"

CombatSpecialAbilityUsageType'2

  • Constant: "SpecialManeuver"

CombatSpecialAbilityType

The definition of if the combat special ability can be used when armed or when unarmed.

CombatSpecialAbilityType'0

  • Constant: "Armed"

CombatSpecialAbilityType'1

  • Constant: "Unarmed"

SkillApplications

Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.

SkillApplications[]

SkillApplication

  • Type: Object
Key Description Details
id The application's identifier. An entry-unique, increasing integer. See details
skill The skill(s) this application belongs to. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

id

The application's identifier. An entry-unique, increasing integer.

  • Type: Integer
  • Minimum: 1

skill

The skill(s) this application belongs to.

translations?

All translations for the entry, identified by IETF language tag (BCP47).

SkillApplicationAssociatedSkill

SkillApplicationAssociatedSkill'Single

  • Type: Object
Key Description Details
tag See details
single See details

tag

  • Constant: "Single"

single

SkillApplicationAssociatedSkill'Multiple

  • Type: Object
Key Description Details
tag See details
multiple See details

tag

  • Constant: "Multiple"

multiple

SkillApplicationAssociatedSkills

  • Type: Object
Key Description Details
list The skills this application belongs to. See details
required_skill_rating? If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite. See details

list

The skills this application belongs to.

required_skill_rating?

If an application applies to multiple skills, it may need to ensure the respective skill is on a certain skill rating if the activatable entry cannot ensure this prerequisite.

  • Type: Integer
  • Minimum: 1

SkillApplicationAssociatedSkills/list[]

SkillApplicationTranslation

  • Type: Object
Key Description Details
name The name of the application if different from the activatable entry's name. See details

name

The name of the application if different from the activatable entry's name.

SkillUses

Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.

SkillUses[]

SkillUse

  • Type: Object
Key Description Details
id The use's identifier. An entry-unique, increasing integer. See details
skill The skill(s) this use belongs to. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

id

The use's identifier. An entry-unique, increasing integer.

  • Type: Integer
  • Minimum: 1

skill

The skill(s) this use belongs to.

translations?

All translations for the entry, identified by IETF language tag (BCP47).

SkillUseAssociatedSkill

SkillUseAssociatedSkill'Single

  • Type: Object
Key Description Details
tag See details
single See details

tag

  • Constant: "Single"

single

SkillUseAssociatedSkill'Multiple

  • Type: Object
Key Description Details
tag See details
multiple See details

tag

  • Constant: "Multiple"

multiple

SkillUseAssociatedSkills

  • Type: Object
Key Description Details
list The skills this use belongs to. See details

list

The skills this use belongs to.

SkillUseAssociatedSkills/list[]

SkillUseTranslation

  • Type: Object
Key Description Details
name The name of the use if different from the activatable entry's name. See details

name

The name of the use if different from the activatable entry's name.

Penalty

The penalty the special ability gives when used.

Penalty'Single

  • Type: Object
Key Description Details
tag See details
single See details

tag

  • Constant: "Single"

single

Penalty'ByHandedness

  • Type: Object
Key Description Details
tag See details
by_handedness See details

tag

  • Constant: "ByHandedness"

by_handedness

Penalty'ByActivation

  • Type: Object
Key Description Details
tag See details
by_activation See details

tag

  • Constant: "ByActivation"

by_activation

Penalty'Selection

  • Type: Object
Key Description Details
tag See details
selection See details

tag

  • Constant: "Selection"

selection

Penalty'ByLevel

  • Type: Object
Key Description Details
tag See details
by_level See details

tag

  • Constant: "ByLevel"

by_level

Penalty'ByAttack

  • Type: Object
Key Description Details
tag See details
by_attack See details

tag

  • Constant: "ByAttack"

by_attack

Penalty'DependsOnHitZone

  • Type: Object
Key Description Details
tag See details
depends_on_hit_zone See details

tag

  • Constant: "DependsOnHitZone"

depends_on_hit_zone

Penalty'DependsOnHitZone/depends_on_hit_zone

  • Type: Empty Object

SinglePenalty

  • Type: Object
Key Description Details
value The penalty value. See details
applies_to_parry? Set to true if the penalty applies to the parry instead of the attack. See details

value

The penalty value.

  • Type: Integer

applies_to_parry?

Set to true if the penalty applies to the parry instead of the attack.

  • Constant: true

PenaltyByHandedness

  • Type: Object
Key Description Details
one_handed The penalty value for one-handed weapons. See details
two_handed The penalty value for two-handed weapons. See details
applies_to_parry? Set to true if the penalty applies to the parry instead of the attack. See details

one_handed

The penalty value for one-handed weapons.

  • Type: Integer

two_handed

The penalty value for two-handed weapons.

  • Type: Integer

applies_to_parry?

Set to true if the penalty applies to the parry instead of the attack.

  • Constant: true

PenaltyByActivation

  • Type: Object
Key Description Details
active The penalty value if the entry has been bought by the character. See details
inactive The penalty value if the entry has not been bought by the character. See details
applies_to_parry? Set to true if the penalty applies to the parry instead of the attack. See details

active

The penalty value if the entry has been bought by the character.

  • Type: Integer

inactive

The penalty value if the entry has not been bought by the character.

  • Type: Integer

applies_to_parry?

Set to true if the penalty applies to the parry instead of the attack.

  • Constant: true

PenaltySelection

  • Type: Object
Key Description Details
options See details

options

PenaltySelectionOptions

PenaltySelectionOptions'Specific

  • Type: Object
Key Description Details
tag See details
specific See details

tag

  • Constant: "Specific"

specific

PenaltySelectionOptions'Range

  • Type: Object
Key Description Details
tag See details
range See details

tag

  • Constant: "Range"

range

SpecificPenaltySelectionOptions

  • Type: Object
Key Description Details
list The list of specific penalty options. See details

list

The list of specific penalty options.

SpecificPenaltySelectionOptions/list[]

SpecificPenaltySelectionOption

  • Type: Object
Key Description Details
value The penalty value. See details

value

The penalty value.

  • Type: Integer

PenaltySelectionOptionsRange

  • Type: Object
Key Description Details
minimum The minimum penalty value. See details
maximum The maximum penalty value. See details

minimum

The minimum penalty value.

  • Type: Integer

maximum

The maximum penalty value.

  • Type: Integer

PenaltyByLevel

  • Type: Object
Key Description Details
levels A continuous range of penalties for each level. The first element is the penalty for the first level, the second element is the penalty for the second level, and so on. See details
external? The combat-related special ability of which the level defines the penalty instead. See details

levels

A continuous range of penalties for each level. The first element is the penalty for the first level, the second element is the penalty for the second level, and so on.

external?

The combat-related special ability of which the level defines the penalty instead.

PenaltyByLevel/levels[]

PenaltyByLevelLevel

  • Type: Object
Key Description Details
value The penalty value for this level. See details

value

The penalty value for this level.

  • Type: Integer

PenaltyByExternalLevel

The combat-related special ability of which the level defines the penalty instead.

  • Type: Object
Key Description Details
id The identifier of the combat-related special ability of which the level defines the penalty instead. See details

id

The identifier of the combat-related special ability of which the level defines the penalty instead.

PenaltyByAttack

  • Type: Object
Key Description Details
list A list of penalties for subsequent attacks. The first element is the penalty for the first attack, the second element is the penalty for the second attack, and so on. The order of the first element may be changed using initial_order, so that e.g. if set to 2, the first element is the penalty for the second attack, the second element is the penalty for the third attack, and so on. See details
initial_order? The order of the first element in the list of penalties. See details
attack_replacement? Set if a predefined different word should be used instead of the word attack for display purposes. See details

list

A list of penalties for subsequent attacks. The first element is the penalty for the first attack, the second element is the penalty for the second attack, and so on. The order of the first element may be changed using initial_order, so that e.g. if set to 2, the first element is the penalty for the second attack, the second element is the penalty for the third attack, and so on.

initial_order?

The order of the first element in the list of penalties.

  • Type: Number

attack_replacement?

Set if a predefined different word should be used instead of the word attack for display purposes.

PenaltyByAttack/list[]

PenaltyByAttackOrderItem

  • Type: Object
Key Description Details
value The penalty value for this order. See details

value

The penalty value for this order.

  • Type: Integer

PenaltyByAttackReplacement

Set if a predefined different word should be used instead of the word attack for display purposes.

  • Constant: "Throw"

EnchantmentCost

EnchantmentCost'ArcaneEnergyCost

  • Type: Object
Key Description Details
tag See details
arcane_energy_cost See details

tag

  • Constant: "ArcaneEnergyCost"

arcane_energy_cost

EnchantmentCost'BindingCost

  • Type: Object
Key Description Details
tag See details
binding_cost See details

tag

  • Constant: "BindingCost"

binding_cost

ArcaneEnergyCost

The AE Cost.

ArcaneEnergyCost'Fixed

  • Type: Object
Key Description Details
tag See details
fixed See details

tag

  • Constant: "Fixed"

fixed

ArcaneEnergyCost'PerCountable

  • Type: Object
Key Description Details
tag See details
per_countable See details

tag

  • Constant: "PerCountable"

per_countable

ArcaneEnergyCost'Interval

  • Type: Object
Key Description Details
tag See details
interval See details

tag

  • Constant: "Interval"

interval

ArcaneEnergyCost'ActivationAndHalfInterval

  • Type: Object
Key Description Details
tag See details
activation_and_half_interval See details

tag

  • Constant: "ActivationAndHalfInterval"

activation_and_half_interval

ArcaneEnergyCost'Indefinite

  • Type: Object
Key Description Details
tag See details
indefinite See details

tag

  • Constant: "Indefinite"

indefinite

ArcaneEnergyCost'Disjunction

  • Type: Object
Key Description Details
tag See details
disjunction See details

tag

  • Constant: "Disjunction"

disjunction

ArcaneEnergyCost'Variable

  • Type: Object
Key Description Details
tag See details
variable See details

tag

  • Constant: "Variable"

variable

ArcaneEnergyCost'Variable/variable

  • Type: Empty Object

FixedArcaneEnergyCost

  • Type: Object
Key Description Details
value The AE cost value. See details
is_permanent? Set to true if the AE costs are permanent. See details
interval? Specified if the AE cost value has to be paid for each time interval. See details
per_level? The AE cost are per level of the enchantment. It may either be displayed in a compressed way (e.g. 1 AE per level) or in a verbose way (e.g. 1 AE for level I; 2 AE for level II). See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

value

The AE cost value.

  • Type: Integer
  • Minimum: 1

is_permanent?

Set to true if the AE costs are permanent.

  • Constant: true

interval?

Specified if the AE cost value has to be paid for each time interval.

per_level?

The AE cost are per level of the enchantment. It may either be displayed in a compressed way (e.g. 1 AE per level) or in a verbose way (e.g. 1 AE for level I; 2 AE for level II).

translations?

All translations for the entry, identified by IETF language tag (BCP47).

FixedArcaneEnergyCostPerLevel

The AE cost are per level of the enchantment. It may either be displayed in a compressed way (e.g. 1 AE per level) or in a verbose way (e.g. 1 AE for level I; 2 AE for level II).

FixedArcaneEnergyCostPerLevel'0

  • Constant: "Compressed"

FixedArcaneEnergyCostPerLevel'1

  • Constant: "Verbose"

FixedArcaneEnergyCostTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
note? A note, appended to the generated option string in parenthesis. See details

note?

A note, appended to the generated option string in parenthesis.

ArcaneEnergyCostPerCountable

  • Type: Object
Key Description Details
value The AE cost value that has to be per a specific countable entity. See details
base_value? If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count. See details
translations All translations for the entry, identified by IETF language tag (BCP47). See details

value

The AE cost value that has to be per a specific countable entity.

  • Type: Integer
  • Minimum: 1

base_value?

If defined, in addition to the cost per entity you have to pay a flat amount, regardless of the entity count.

  • Type: Integer
  • Minimum: 1

translations

All translations for the entry, identified by IETF language tag (BCP47).

ArcaneEnergyCostPerCountableTranslation

  • Type: Object
Key Description Details
per The cost have to be per a specific countable entity, e.g. 8 AE per person. See details
note? A note, appended to the generated string in parenthesis. See details

per

The cost have to be per a specific countable entity, e.g. 8 AE per person.

note?

A note, appended to the generated string in parenthesis.

IntervalArcaneEnergyCost

  • Type: Object
Key Description Details
value The AE cost value that has to be payed each interval. See details
interval The time interval for which the AE cost value has to be paid. See details

value

The AE cost value that has to be payed each interval.

  • Type: Integer
  • Minimum: 1

interval

The time interval for which the AE cost value has to be paid.

ActivationAndHalfIntervalArcaneEnergyCost

  • Type: Object
Key Description Details
value The AE cost value that has to be payed for activation. Half of this value has to be payed each interval. See details
interval The time interval for which the AE cost value has to be paid. See details

value

The AE cost value that has to be payed for activation. Half of this value has to be payed each interval.

  • Type: Integer
  • Minimum: 2
  • Multiple of: 2

interval

The time interval for which the AE cost value has to be paid.

IndefiniteArcaneEnergyCost

  • Type: Object
Key Description Details
modifier? Specified if the indefinite AP cost description needs to be modified by a certain value. See details
translations All translations for the entry, identified by IETF language tag (BCP47). See details

modifier?

Specified if the indefinite AP cost description needs to be modified by a certain value.

translations

All translations for the entry, identified by IETF language tag (BCP47).

IndefiniteArcaneEnergyCostModifier

  • Type: Object
Key Description Details
arithmetic The arithmetic how to apply the value to the base. See details
value The value that is applied to the base using the defined arithmetic. See details

arithmetic

The arithmetic how to apply the value to the base.

value

The value that is applied to the base using the defined arithmetic.

  • Type: Integer
  • Minimum: 1

IndefiniteArcaneEnergyCostModifierArithmetic

  • Constant: "Add"

IndefiniteArcaneEnergyCostTranslation

  • Type: Object
Key Description Details
description A description of where the cost come from. See details

description

A description of where the cost come from.

ArcaneEnergyCostDisjunction

  • Type: Object
Key Description Details
interval? Specified if the selected AE cost option has to be paid for each time interval. See details
options The possible AE cost values. See details

interval?

Specified if the selected AE cost option has to be paid for each time interval.

options

The possible AE cost values.

ArcaneEnergyCostDisjunction/options[]

ArcaneEnergyCostDisjunctionInterval

  • Type: Object
Key Description Details
value The interval itself. See details
activation_value The AE cost value for activation. See details
after_activation Set to true if the action where the enchantment is casted does not as a part of the first interval that has to be payed, so that the first interval payment needs to be done after the activation. See details

value

The interval itself.

activation_value

The AE cost value for activation.

  • Type: Integer
  • Minimum: 1

after_activation

Set to true if the action where the enchantment is casted does not as a part of the first interval that has to be payed, so that the first interval payment needs to be done after the activation.

This works different than other sustained spells, since for them the end of the cast usually already counts as part of the first interval.

  • Type: Boolean

ArcaneEnergyCostDisjunctionOption

  • Type: Object
Key Description Details
value A possible AE cost value. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

value

A possible AE cost value.

  • Type: Integer
  • Minimum: 1

translations?

All translations for the entry, identified by IETF language tag (BCP47).

ArcaneEnergyCostDisjunctionOptionTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
note? A note, appended to the generated option string in parenthesis. See details

note?

A note, appended to the generated option string in parenthesis.

NoArcaneEnergyCost

  • Type: Object
Key Description Details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

translations?

All translations for the entry, identified by IETF language tag (BCP47).

NoArcaneEnergyCostTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
note? A note, appended to the generated string in parenthesis. See details

note?

A note, appended to the generated string in parenthesis.

Volume

The volume points the enchantment needs.

Volume'Fixed

  • Type: Object
Key Description Details
tag See details
fixed See details

tag

  • Constant: "Fixed"

fixed

Volume'PerLevel

  • Type: Object
Key Description Details
tag See details
per_level See details

tag

  • Constant: "PerLevel"

per_level

Volume'ByLevel

  • Type: Object
Key Description Details
tag See details
by_level See details

tag

  • Constant: "ByLevel"

by_level

Volume'Map

  • Type: Object
Key Description Details
tag See details
map See details

tag

  • Constant: "Map"

map

Volume'DerivedFromSelection

  • Type: Object
Key Description Details
tag See details
derived_from_selection See details

tag

  • Constant: "DerivedFromSelection"

derived_from_selection

FixedVolume

  • Type: Object
Key Description Details
points The volume points. See details

points

The volume points.

  • Type: Integer
  • Minimum: 0

VolumePerLevel

  • Type: Object
Key Description Details
points The volume points per level. See details

points

The volume points per level.

  • Type: Integer
  • Minimum: 1

VolumeByLevel

  • Type: Object
Key Description Details
list The volume points for each level. The first element is the volume points for the first level, the second element is the volume points for the second level, and so on. See details

list

The volume points for each level. The first element is the volume points for the first level, the second element is the volume points for the second level, and so on.

VolumeByLevel/list[]

VolumeByLevelItem

  • Type: Object
Key Description Details
points The volume points for this level. See details

points

The volume points for this level.

  • Type: Integer
  • Minimum: 0

VolumeMap

A content that is 3/4/5 Points for Chimera, Daimonid, Golems, Undead / Fairies, Ghosts / Demons, Elementals may be respresented as the following map:

options:
  - points: 3
    associated_options:
      - id:
          tag: General
          value: # ...
      # ...
    translations:
      en-US:
        label: "Chimera, Daimonid, Golems, Undead"
        label_standalone: "Chimera/Daimonid/Golems/Undead"
  - points: 4
    associated_options:
      - id:
          tag: General
          value: # ...
      # ...
    translations:
      en-US:
        label: "Fairies, Ghosts"
        label_standalone: "Fairies/Ghosts"
  - points: 5
    associated_options:
      - id:
          tag: General
          value: # ...
      # ...
    translations:
      en-US:
        label: "Demons, Elementals"
        label_standalone: "Demons/Elementals"

This will generate the exact same string as seen above. The associated options are not present in the example, but they link to the options the volume specification is meant for.

  • Type: Object
Key Description Details
options The possible costs and associated labels. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

options

The possible costs and associated labels.

translations?

All translations for the entry, identified by IETF language tag (BCP47).

VolumeMap/options[]

VolumeMapTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
list_prepend? Place a string between the for and the grouped map option labels. See details
list_append? Place a string after the grouped map option labels. See details
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. See details

list_prepend?

Place a string between the for and the grouped map option labels.

  • Type: String

list_append?

Place a string after the grouped map option labels.

  • Type: String

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: String

VolumeMapOption

  • Type: Object
Key Description Details
points The full permanent AE cost value for this option. See details
associated_options Links to the options this volume specification is meant for. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

points

The full permanent AE cost value for this option.

  • Type: Integer
  • Minimum: 1

associated_options

Links to the options this volume specification is meant for.

translations?

All translations for the entry, identified by IETF language tag (BCP47).

VolumeMapOption/associated_options[]

VolumeMapOptionAssociatedOption

  • Type: Object
Key Description Details
id The option's identifier. See details

id

The option's identifier.

VolumeMapOptionTranslation

  • Type: Object
Key Description Details
label The description of the option for cost string generation. See details
label_standalone? The description of the option if used standalone. Only used if different from label. See details

label

The description of the option for cost string generation.

label_standalone?

The description of the option if used standalone. Only used if different from label.

VolumeDerivedFromSelection

  • Type: Object
Key Description Details
fallback The volume for the selection if it does not define a specific one. See details

fallback

The volume for the selection if it does not define a specific one.

  • Type: Integer
  • Minimum: 0

BindingCost

The binding cost for an enchantment.

BindingCost'Fixed

  • Type: Object
Key Description Details
tag See details
fixed See details

tag

  • Constant: "Fixed"

fixed

BindingCost'PerLevel

  • Type: Object
Key Description Details
tag See details
per_level See details

tag

  • Constant: "PerLevel"

per_level

BindingCost'Map

  • Type: Object
Key Description Details
tag See details
map See details

tag

  • Constant: "Map"

map

BindingCost'DerivedFromSelection

  • Type: Object
Key Description Details
tag See details
derived_from_selection See details

tag

  • Constant: "DerivedFromSelection"

derived_from_selection

FixedBindingCost

  • Type: Object
Key Description Details
permanent_value The permanent AE cost. See details

permanent_value

The permanent AE cost.

If the enchantment has multiple levels, it is only applied for the first level.

  • Type: Integer
  • Minimum: 1

BindingCostPerLevel

  • Type: Object
Key Description Details
permanent_value The permanent AE cost per level. See details

permanent_value

The permanent AE cost per level.

  • Type: Integer
  • Minimum: 1

BindingCostMap

A content that is 2/4/8 permanent AE for spell-swords with the combat technique Daggers, Swords, or Two-Handed Swords may be respresented as the following map:

options:
  - permanent_value: 2
    translations:
      en-US:
        label: "Daggers"
        label_standalone: "Dagger"
  - permanent_value: 4
    translations:
      en-US:
        label: "Swords"
        label_standalone: "Sword"
  - permanent_value: 8
    translations:
      en-US:
        label: "Two-Handed Swords"
        label_standalone: "Two-Handed Sword"
list_prepend: "spell-swords with the combat technique"

This will generate the exact same string as seen above.

  • Type: Object
Key Description Details
options The possible costs and associated labels. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

options

The possible costs and associated labels.

translations?

All translations for the entry, identified by IETF language tag (BCP47).

BindingCostMap/options[]

BindingCostMapTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
list_prepend? Place a string between the for and the grouped map option labels. See details
list_append? Place a string after the grouped map option labels. See details
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. See details

list_prepend?

Place a string between the for and the grouped map option labels.

list_append?

Place a string after the grouped map option labels.

replacement?

If the string from the book cannot be generated using the default generation technique, use this string. All options still need to be inserted propertly, since it may be used by in-game tools to provide a selection to players.

BindingCostMapOption

  • Type: Object
Key Description Details
permanent_value The full permanent AE cost value for this option. See details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

permanent_value

The full permanent AE cost value for this option.

  • Type: Integer
  • Minimum: 1

translations?

All translations for the entry, identified by IETF language tag (BCP47).

BindingCostMapOptionTranslation

  • Type: Object
Key Description Details
label The description of the option for cost string generation. See details
label_standalone? The description of the option if used standalone. Only used if different from label. See details

label

The description of the option for cost string generation.

label_standalone?

The description of the option if used standalone. Only used if different from label.

BindingCostDerivedFromSelection

  • Type: Object
Key Description Details
fallback The binding cost for the selection if it does not define a specific one. See details

fallback

The binding cost for the selection if it does not define a specific one.

  • Type: Integer
  • Minimum: 0

PropertyDeclaration

The magic property's identifier. DependingOnProperty can only be used if the special ability has an option to select a property.

PropertyDeclaration'DependingOnSelection

  • Type: Object
Key Description Details
tag See details
depending_on_selection See details

tag

  • Constant: "DependingOnSelection"

depending_on_selection

PropertyDeclaration'DependingOnSelection/depending_on_selection

  • Type: Empty Object

PropertyDeclaration'Fixed

  • Type: Object
Key Description Details
tag See details
fixed See details

tag

  • Constant: "Fixed"

fixed

AspectDeclaration

The blessed aspect.

AdvancedSpecialAbility<Identifier>

A reference to an advanced special ability.

AdvancedSpecialAbility'General

  • Type: Object
Key Description Details
tag See details
general See details

tag

  • Constant: "General"

general

AdvancedSpecialAbility'RestrictOptions

  • Type: Object
Key Description Details
tag See details
restrict_options See details

tag

  • Constant: "RestrictOptions"

restrict_options

AdvancedSpecialAbility'OneOf

  • Type: Object
Key Description Details
tag See details
one_of See details

tag

  • Constant: "OneOf"

one_of

AdvancedSpecialAbility'DeriveFromExternalOption

  • Type: Object
Key Description Details
tag See details
derive_from_external_option See details

tag

  • Constant: "DeriveFromExternalOption"

derive_from_external_option

RestrictAdvancedSpecialAbilityOptions<Identifier>

  • Type: Object
Key Description Details
id The advanced special ability’s identifier. See details
option Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed. See details

id

The advanced special ability’s identifier.

option

Specify the select option(s) that only are allowed for the referenced advanced special ability; others are disallowed.

RestrictAdvancedSpecialAbilityOptions/option[]

OneOfAdvancedSpecialAbilityOptions<Identifier>

  • Type: Object
Key Description Details
options The possible advanced special abilities. See details
is_selection_required_on_purchase Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later. See details
display_option? See details

options

The possible advanced special abilities.

is_selection_required_on_purchase

Do have to choose the advanced special ability when buying the style special ability? Otherwise the decision can be made later.

  • Type: Boolean

display_option?

OneOfAdvancedSpecialAbilityOptions/options[]

AdvancedSpecialAbilityDerivedFromExternalOption<Identifier>

  • Type: Object
Key Description Details
external_entry The possible advanced special abilities. See details
map Map options from the external entry to allowed advanced special abilities. See details
display_option? See details

external_entry

The possible advanced special abilities.

map

Map options from the external entry to allowed advanced special abilities.

display_option?

AdvancedSpecialAbilityDerivedFromExternalOption/map[]

AdvancedSpecialAbilityDerivedFromExternalOptionMapping<Identifier>

Mapping from an option of the external entry to an allowed advanced special ability.

  • Type: Object
Key Description Details
from_option The select option's identifier. See details
to_advanced The advanced special ability's identifier. See details

from_option

The select option's identifier.

to_advanced

The advanced special ability's identifier.

AdvancedSpecialAbilityDerivedExternalEntryId

AdvancedSpecialAbilityDerivedExternalEntryOptionId

AdvancedSpecialAbilities<Identifier>

The Advanced Special Abilities for the respective Style Special Ability. Sometimes, only a specific select option or a set of select options of an entry is allowed, which can be modelled by the option property. It can also be that you can choose from a set of special abilities, but then you can't specify an option.

AdvancedSpecialAbilities[]

PrerequisitesReplacement

The prerequisites text. It is only used if the text cannot be generated from the given information.

ApplicableCombatTechniques

ApplicableCombatTechniques'None

  • Type: Object
Key Description Details
tag See details
none See details

tag

  • Constant: "None"

none

ApplicableCombatTechniques'None/none

  • Type: Empty Object

ApplicableCombatTechniques'DependingOnCombatStyle

  • Type: Object
Key Description Details
tag See details
depending_on_combat_style See details

tag

  • Constant: "DependingOnCombatStyle"

depending_on_combat_style

ApplicableCombatTechniques'DependingOnCombatStyle/depending_on_combat_style

  • Type: Empty Object

ApplicableCombatTechniques'All

  • Type: Object
Key Description Details
tag See details
all See details

tag

  • Constant: "All"

all

ApplicableCombatTechniques'AllClose

  • Type: Object
Key Description Details
tag See details
all_close See details

tag

  • Constant: "AllClose"

all_close

ApplicableCombatTechniques'AllRanged

  • Type: Object
Key Description Details
tag See details
all_ranged See details

tag

  • Constant: "AllRanged"

all_ranged

ApplicableCombatTechniques'Specific

  • Type: Object
Key Description Details
tag See details
specific See details

tag

  • Constant: "Specific"

specific

AllApplicableCombatTechniques

  • Type: Object
Key Description Details
restrictions? See details

restrictions?

AllApplicableCombatTechniques/restrictions[]

AllApplicableCloseCombatTechniques

  • Type: Object
Key Description Details
restrictions? See details

restrictions?

AllApplicableCloseCombatTechniques/restrictions[]

AllApplicableRangedCombatTechniques

  • Type: Object
Key Description Details
restrictions? See details

restrictions?

AllApplicableRangedCombatTechniques/restrictions[]

SpecificApplicableCombatTechniques

  • Type: Object
Key Description Details
list See details

list

SpecificApplicableCombatTechniques/list[]

SpecificApplicableCombatTechnique

  • Type: Object
Key Description Details
id See details
restrictions? See details

id

restrictions?

SpecificApplicableCombatTechnique/restrictions[]

ApplicableAllCombatTechniquesRestriction

ApplicableAllCombatTechniquesRestriction'Improvised

  • Type: Object
Key Description Details
tag See details
improvised See details

tag

  • Constant: "Improvised"

improvised

ApplicableAllCombatTechniquesRestriction'Improvised/improvised

  • Type: Empty Object

ApplicableAllCombatTechniquesRestriction'PointedBlade

  • Type: Object
Key Description Details
tag See details
pointed_blade See details

tag

  • Constant: "PointedBlade"

pointed_blade

ApplicableAllCombatTechniquesRestriction'PointedBlade/pointed_blade

  • Type: Empty Object

ApplicableAllCombatTechniquesRestriction'Mount

  • Type: Object
Key Description Details
tag See details
mount See details

tag

  • Constant: "Mount"

mount

ApplicableAllCombatTechniquesRestriction'Mount/mount

  • Type: Empty Object

ApplicableAllCombatTechniquesRestriction'Race

  • Type: Object
Key Description Details
tag See details
race See details

tag

  • Constant: "Race"

race

ApplicableAllCombatTechniquesRestriction'ExcludeCombatTechniques

  • Type: Object
Key Description Details
tag See details
exclude_combat_techniques See details

tag

  • Constant: "ExcludeCombatTechniques"

exclude_combat_techniques

ApplicableCloseCombatTechniquesRestriction

ApplicableCloseCombatTechniquesRestriction'Improvised

  • Type: Object
Key Description Details
tag See details
improvised See details

tag

  • Constant: "Improvised"

improvised

ApplicableCloseCombatTechniquesRestriction'Improvised/improvised

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'PointedBlade

  • Type: Object
Key Description Details
tag See details
pointed_blade See details

tag

  • Constant: "PointedBlade"

pointed_blade

ApplicableCloseCombatTechniquesRestriction'PointedBlade/pointed_blade

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'Mount

  • Type: Object
Key Description Details
tag See details
mount See details

tag

  • Constant: "Mount"

mount

ApplicableCloseCombatTechniquesRestriction'Mount/mount

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'HasParry

  • Type: Object
Key Description Details
tag See details
has_parry See details

tag

  • Constant: "HasParry"

has_parry

ApplicableCloseCombatTechniquesRestriction'HasParry/has_parry

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'OneHanded

  • Type: Object
Key Description Details
tag See details
one_handed See details

tag

  • Constant: "OneHanded"

one_handed

ApplicableCloseCombatTechniquesRestriction'OneHanded/one_handed

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'ParryingWeapon

  • Type: Object
Key Description Details
tag See details
parrying_weapon See details

tag

  • Constant: "ParryingWeapon"

parrying_weapon

ApplicableCloseCombatTechniquesRestriction'ParryingWeapon/parrying_weapon

  • Type: Empty Object

ApplicableCloseCombatTechniquesRestriction'Race

  • Type: Object
Key Description Details
tag See details
race See details

tag

  • Constant: "Race"

race

ApplicableCloseCombatTechniquesRestriction'ExcludeCombatTechniques

  • Type: Object
Key Description Details
tag See details
exclude_combat_techniques See details

tag

  • Constant: "ExcludeCombatTechniques"

exclude_combat_techniques

ApplicableRangedCombatTechniquesRestriction

ApplicableRangedCombatTechniquesRestriction'Improvised

  • Type: Object
Key Description Details
tag See details
improvised See details

tag

  • Constant: "Improvised"

improvised

ApplicableRangedCombatTechniquesRestriction'Improvised/improvised

  • Type: Empty Object

ApplicableRangedCombatTechniquesRestriction'PointedBlade

  • Type: Object
Key Description Details
tag See details
pointed_blade See details

tag

  • Constant: "PointedBlade"

pointed_blade

ApplicableRangedCombatTechniquesRestriction'PointedBlade/pointed_blade

  • Type: Empty Object

ApplicableRangedCombatTechniquesRestriction'Mount

  • Type: Object
Key Description Details
tag See details
mount See details

tag

  • Constant: "Mount"

mount

ApplicableRangedCombatTechniquesRestriction'Mount/mount

  • Type: Empty Object

ApplicableRangedCombatTechniquesRestriction'Race

  • Type: Object
Key Description Details
tag See details
race See details

tag

  • Constant: "Race"

race

ApplicableRangedCombatTechniquesRestriction'ExcludeCombatTechniques

  • Type: Object
Key Description Details
tag See details
exclude_combat_techniques See details

tag

  • Constant: "ExcludeCombatTechniques"

exclude_combat_techniques

ApplicableSpecificCombatTechniquesRestriction

ApplicableSpecificCombatTechniquesRestriction'Improvised

  • Type: Object
Key Description Details
tag See details
improvised See details

tag

  • Constant: "Improvised"

improvised

ApplicableSpecificCombatTechniquesRestriction'Improvised/improvised

  • Type: Empty Object

ApplicableSpecificCombatTechniquesRestriction'PointedBlade

  • Type: Object
Key Description Details
tag See details
pointed_blade See details

tag

  • Constant: "PointedBlade"

pointed_blade

ApplicableSpecificCombatTechniquesRestriction'PointedBlade/pointed_blade

  • Type: Empty Object

ApplicableSpecificCombatTechniquesRestriction'Mount

  • Type: Object
Key Description Details
tag See details
mount See details

tag

  • Constant: "Mount"

mount

ApplicableSpecificCombatTechniquesRestriction'Mount/mount

  • Type: Empty Object

ApplicableSpecificCombatTechniquesRestriction'Race

  • Type: Object
Key Description Details
tag See details
race See details

tag

  • Constant: "Race"

race

ApplicableSpecificCombatTechniquesRestriction'Level

  • Type: Object
Key Description Details
tag See details
level See details

tag

  • Constant: "Level"

level

ApplicableSpecificCombatTechniquesRestriction'Weapons

  • Type: Object
Key Description Details
tag See details
weapons See details

tag

  • Constant: "Weapons"

weapons

ApplicableCombatTechniquesNegativeCombatTechniquesRestriction<Ref>

  • Type: Object
Key Description Details
list The combat techniques this combat special ability is not applicable to. See details

list

The combat techniques this combat special ability is not applicable to.

ApplicableCombatTechniquesNegativeCombatTechniquesRestriction/list[]

ApplicableCombatTechniquesRaceRestriction

ApplicableCombatTechniquesLevelRestriction

  • Type: Object
Key Description Details
level The combat special ability is only applicable on a certain level. See details

level

The combat special ability is only applicable on a certain level.

  • Type: Integer
  • Minimum: 1

ApplicableCombatTechniquesWeaponRestriction

  • Type: Object
Key Description Details
list The specific weapons this combat special ability is only applicable to. See details

list

The specific weapons this combat special ability is only applicable to.

ApplicableCombatTechniquesWeaponRestriction/list[]

AdventurePointsValue

AdventurePointsValue'Fixed

  • Type: Object
Key Description Details
tag See details
fixed See details

tag

  • Constant: "Fixed"

fixed

AdventurePointsValue'ByLevel

  • Type: Object
Key Description Details
tag See details
by_level See details

tag

  • Constant: "ByLevel"

by_level

AdventurePointsValue'DerivedFromSelection

  • Type: Object
Key Description Details
tag See details
derived_from_selection See details

tag

  • Constant: "DerivedFromSelection"

derived_from_selection

AdventurePointsValue'Indefinite

  • Type: Object
Key Description Details
tag See details
indefinite See details

tag

  • Constant: "Indefinite"

indefinite

AdventurePointsValue'Indefinite/indefinite

  • Type: Empty Object

FixedAdventurePointsValue

A fixed adventure points value. If the entry has levels, this is the cost per level as well.

AdventurePointsValueByLevel

An entry with levels may have different costs for each level. The length of the list must match the amount of levels the special ability has.

AdventurePointsValueByLevel[]

AdventurePointsDerivedFromSelection

The adventure points value is derived from the selection of the special ability. Its display value may be able to be derived from the given information for the select options. If that is not the case or the generated text would not match the original one, a replacement text can be provided.

  • Type: Object
Key Description Details
translations? All translations for the entry, identified by IETF language tag (BCP47). See details

translations?

All translations for the entry, identified by IETF language tag (BCP47).

AdventurePointsDerivedFromSelectionTranslation

  • Type: Object
  • Minimum Properties: 1
Key Description Details
replacement? A replacement for the generated text if it would not match the original one. See details

replacement?

A replacement for the generated text if it would not match the original one.

AdventurePointsSingleValue

A single adventure points value.

  • Type: Integer
  • Minimum: 0

Input

A string that is used as a label for an input field.

AdventurePointsValueReplacement

The AP value. It is only used if the text cannot be generated from the given information.

AdventurePointsValueAppend

A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.

Reference in New Issue View Git Blame Copy Permalink