21 KiB
[TITLE MISSING]
Definitions
OneTimeCost
- Type: Union
- Cases: OneTimeCost'Single | OneTimeCost'Conjunction | OneTimeCost'Disjunction | OneTimeCost'Map
OneTimeCost'Single
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
single |
See details |
tag
- Constant:
"Single"
single
- Type: SingleOneTimeCost
OneTimeCost'Conjunction
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
conjunction |
See details |
tag
- Constant:
"Conjunction"
conjunction
- Type: MultipleOneTimeCosts
OneTimeCost'Disjunction
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
disjunction |
See details |
tag
- Constant:
"Disjunction"
disjunction
- Type: MultipleOneTimeCosts
OneTimeCost'Map
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
map |
See details |
tag
- Constant:
"Map"
map
- Type: CostMap
SingleOneTimeCost
- Type: Union
- Cases: SingleOneTimeCost'Modifiable | SingleOneTimeCost'NonModifiable | SingleOneTimeCost'Indefinite
SingleOneTimeCost'Modifiable
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
modifiable |
See details |
tag
- Constant:
"Modifiable"
modifiable
- Type: ModifiableOneTimeCost
SingleOneTimeCost'NonModifiable
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
non_modifiable |
See details |
tag
- Constant:
"NonModifiable"
non_modifiable
- Type: NonModifiableOneTimeCost
SingleOneTimeCost'Indefinite
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
indefinite |
See details |
tag
- Constant:
"Indefinite"
indefinite
- Type: IndefiniteOneTimeCost
MultipleOneTimeCosts
- Type: List
- Items: MultipleOneTimeCosts[]
- Minimum Items:
2
MultipleOneTimeCosts[]
- Type: SingleOneTimeCost
ModifiableOneTimeCost
- Type: Object
| Key | Description | Details |
|---|---|---|
initial_modification_level |
The initial skill modification identifier/level. | See details |
permanent_value? |
The part of the cost value that has to be spent permanently. | See details |
translations? |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
initial_modification_level
The initial skill modification identifier/level.
- Type: Integer
- Minimum:
1 - Maximum:
6
permanent_value?
The part of the cost value that has to be spent permanently.
- Type: Integer
- Minimum:
1
translations?
All translations for the entry, identified by IETF language tag (BCP47).
ModifiableOneTimeCostTranslation
- Type: Object
| Key | Description | Details |
|---|---|---|
replacement |
A replacement string. | See details |
replacement
A replacement string.
- Type: ResponsiveTextReplace
NonModifiableOneTimeCost
- Type: Object
| Key | Description | Details |
|---|---|---|
is_minimum? |
If true, the non-modifiable value is a minimum value. |
See details |
value |
The AE cost value. | See details |
permanent_value? |
The part of the cost value that has to be spent permanently. | See details |
per? |
The cost have to be per a specific countable entity, e.g. 8 KP per person. |
See details |
translations? |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
is_minimum?
If true, the non-modifiable value is a minimum value.
- Type: Boolean
value
The AE cost value.
- Type: Integer
- Minimum:
1
permanent_value?
The part of the cost value that has to be spent permanently.
- Type: Integer
- Minimum:
1
per?
The cost have to be per a specific countable entity, e.g. 8 KP per person.
translations?
All translations for the entry, identified by IETF language tag (BCP47).
NonModifiableOneTimeCostPerCountable
- Type: Object
| Key | Description | Details |
|---|---|---|
minimum_total? |
If defined, the minimum total AE that have to be spent casting the skill. | See details |
translations |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
minimum_total?
If defined, the minimum total AE that have to be spent casting the skill.
- Type: Number
translations
All translations for the entry, identified by IETF language tag (BCP47).
NonModifiableOneTimeCostPerCountableTranslation
- Type: Object
| Key | Description | Details |
|---|---|---|
countable |
The countable entity name. | See details |
countable
The countable entity name.
- Type: ResponsiveText
NonModifiableOneTimeCostTranslation
- Type: Object
| 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.
- Type: ResponsiveTextOptional
IndefiniteOneTimeCost
- 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).
IndefiniteOneTimeCostTranslation
- 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.
- Type: ResponsiveText
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:
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. | See details |
translations? |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
options
The possible costs and associated labels.
- Type: List
- Items: CostMap/options[]
- Minimum Items:
2
translations?
All translations for the entry, identified by IETF language tag (BCP47).
- Type: LocaleMap<CostMapTranslation>
CostMap/options[]
- Type: CostMapOption
CostMapOption
- Type: Object
| Key | Description | Details |
|---|---|---|
value |
The full cost value for this option. | See details |
permanent_value? |
The part of the value that has to be paid permanently. |
See details |
translations? |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
value
The full cost value for this option.
- Type: Integer
- Minimum:
1
permanent_value?
The part of the value that has to be paid permanently.
- Type: Integer
- Minimum:
0
translations?
All translations for the entry, identified by IETF language tag (BCP47).
CostMapOptionTranslation
- 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.
- Type: NonEmptyString
label_standalone?
The description of the option if used standalone. Only used if different from label.
- Type: NonEmptyString
CostMapTranslation
- Type: Object
| 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: NonEmptyString
list_append?
Place a string after the grouped map option labels.
- Type: NonEmptyString
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: NonEmptyString
SustainedCost
- Type: Union
- Cases: SustainedCost'Modifiable | SustainedCost'NonModifiable
SustainedCost'Modifiable
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
modifiable |
See details |
tag
- Constant:
"Modifiable"
modifiable
- Type: ModifiableSustainedCost
SustainedCost'NonModifiable
- Type: Object
| Key | Description | Details |
|---|---|---|
tag |
See details | |
non_modifiable |
See details |
tag
- Constant:
"NonModifiable"
non_modifiable
ModifiableSustainedCost
- Type: Object
| Key | Description | Details |
|---|---|---|
initial_modification_level |
The initial skill modification identifier/level. | See details |
interval |
The sustain interval. | See details |
initial_modification_level
The initial skill modification identifier/level.
- Type: Integer
- Minimum:
1 - Maximum:
6
interval
The sustain interval.
- Type: DurationUnitValue
NonModifiableSustainedCost
- Type: Object
| Key | Description | Details |
|---|---|---|
is_minimum? |
If true, the non-modifiable value is a minimum value. |
See details |
value |
The AE cost value. | See details |
per? |
The cost have to be per a specific countable entity, e.g. 8 KP per person per 5 minutes. |
See details |
interval |
The sustain interval. | See details |
is_minimum?
If true, the non-modifiable value is a minimum value.
- Type: Boolean
value
The AE cost value.
- Type: Integer
- Minimum:
1
per?
The cost have to be per a specific countable entity, e.g. 8 KP per person per 5 minutes.
interval
The sustain interval.
- Type: DurationUnitValue
NonModifiableSustainedCostPerCountable
- Type: Object
| Key | Description | Details |
|---|---|---|
minimum_total? |
If defined, the minimum total AE that have to be spent casting the skill. | See details |
translations |
All translations for the entry, identified by IETF language tag (BCP47). | See details |
minimum_total?
If defined, the minimum total AE that have to be spent casting the skill.
- Type: Number
translations
All translations for the entry, identified by IETF language tag (BCP47).
NonModifiableSustainedCostPerCountableTranslation
- Type: Object
| Key | Description | Details |
|---|---|---|
countable |
The countable entity name. | See details |
countable
The countable entity name.
- Type: ResponsiveText