optolith/database-schema

Fork 0

Files

T

Lukas Obermann f865a34058 style: remove line breaks in documentation paragraphs

2024-11-16 16:58:45 +01:00

15 KiB

Raw Blame History

Patron

Definitions

Patron (`Patron`)

Type: Object

Key	Description	Details
`id`	The patron's identifier. An unique, increasing integer.	See details
`category`	The patron's category.	See details
`skills`	The patron-specific skills.	See details
`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).	See details
`primary_patron_cultures?`	The list of cultures where patrons from this category can be the primary patron of.	See details
`powers?`	The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons.	See details
`ae_cost?`	The patron-specific AE cost. Used by several animist forces for animal patrons.	See details
`improvement_cost?`	The patron-specific improvement cost. Used by several animist forces for animal patrons.	See details
`common_advantages?`	The patron may grant common advantages that are taken into account during character creation.	See details
`common_disadvantages?`	The patron may grant common disadvantages that are taken into account during character creation.	See details
`common_spellworks?`	The animist may learn spellworks common for this patron.	See details
`translations`	All translations for the entry, identified by IETF language tag (BCP47).	See details

`id`

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

Type: Integer
Minimum: 1

`category`

The patron's category.

Type: PatronCategoryReference

`skills`

The patron-specific skills.

Type: List
Items: Patron/skills[]
Minimum Items: 3
Maximum Items: 3

`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: PatronCulture

`primary_patron_cultures?`

The list of cultures where patrons from this category can be the primary patron of.

Type: List
Items: Patron/primary_patron_cultures[]
Unique Items: Yes

`powers?`

The patron-specific powers. Used by animist power Animal Powers I–III and should only be present on animal patrons.

Type: AnimalPowers

`ae_cost?`

The patron-specific AE cost. Used by several animist forces for animal patrons.

Type: Integer
Minimum: 2
Multiple of: 2

`improvement_cost?`

The patron-specific improvement cost. Used by several animist forces for animal patrons.

Type: ImprovementCost

`common_advantages?`

The patron may grant common advantages that are taken into account during character creation.

Source: Geisterwald & Knochenklippen, p. 6-7

Type: List
Items: Patron/common_advantages[]

`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: Patron/common_disadvantages[]

`common_spellworks?`

The animist may learn spellworks common for this patron.

Source: Geisterwald & Knochenklippen, p. 6-7

Type: List
Items: Patron/common_spellworks[]

`translations`

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

Type: LocaleMap<PatronTranslation>

`PatronTranslation`

Type: Object

Key	Description	Details
`name`	The name of the patron.	See details

`name`

The name of the patron.

Type: NonEmptyString

`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`		See details
`operation`		See details

`set`

Type: List
Items: PatronCulture/set[]

`operation`

Type: PatronCultureOperation

`PatronCulture/set[]`

Type: CultureReference

`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: PatronCultureOperation'0 | PatronCultureOperation'1

`PatronCultureOperation'0`

Constant: "Intersection"

`PatronCultureOperation'1`

Constant: "Difference"

`AnimalPowers`

Type: Object

Key	Description	Details
`level1`		See details
`level2`		See details
`level3`		See details

`level1`

Type: AnimalPowersLevel1

`level2`

Type: AnimalPowersLevel2

`level3`

Type: AnimalPowersLevel3

`AdvantageAnimalPower`

Type: Object

Key	Description	Details
`id`	The advantage's identifier.	See details
`level?`	It grants a higher level of the advantage.	See details
`option?`	It grants a specific general option of the advantage.	See details

`id`

The advantage's identifier.

Type: AdvantageIdentifier

`level?`

It grants a higher level of the advantage.

Type: Integer
Minimum: 2

`option?`

It grants a specific general option of the advantage.

Type: Integer
Minimum: 1

`SkillAnimalPower`

Type: Object

Key	Description	Details
`id`	The skill's identifier.	See details
`points`	The points that gets added to the skill's rating.	See details

`id`

The skill's identifier.

Type: SkillIdentifier

`points`

The points that gets added to the skill's rating.

Type: Integer
Minimum: 1

`AnimalPowerLevel1`

Type: Union
Cases: AnimalPowerLevel1'Advantage | AnimalPowerLevel1'Skill

`AnimalPowerLevel1'Advantage`

Type: Object

Key	Description	Details
`tag`		See details
`advantage`		See details

`tag`

Constant: "Advantage"

`advantage`

Type: AdvantageAnimalPower

`AnimalPowerLevel1'Skill`

Type: Object

Key	Description	Details
`tag`		See details
`skill`		See details

`tag`

Constant: "Skill"

`skill`

Type: SkillAnimalPower

`AnimalPowersLevel1`

Type: List
Items: AnimalPowersLevel1[]
Minimum Items: 1

`AnimalPowersLevel1[]`

Type: AnimalPowerLevel1

`CombatAnimalPower`

Type: Object

Key	Description	Details
`id`	The combat value.	See details
`value`	The value that gets added to the combat value.	See details

`id`

The combat value.

Type: CombatAnimalPowerType

`value`

The value that gets added to the combat value.

Type: Integer
Minimum: 1

`CombatAnimalPowerType`

Type: Union
Cases: CombatAnimalPowerType'0 | CombatAnimalPowerType'1 | CombatAnimalPowerType'2 | CombatAnimalPowerType'3 | CombatAnimalPowerType'4 | CombatAnimalPowerType'5

`CombatAnimalPowerType'0`

Constant: "Attack"

`CombatAnimalPowerType'1`

Constant: "Parry"

`CombatAnimalPowerType'2`

Constant: "RangedCombat"

`CombatAnimalPowerType'3`

Constant: "Dodge"

`CombatAnimalPowerType'4`

Constant: "DamagePoints"

`CombatAnimalPowerType'5`

Constant: "Protection"

`AnimalPowerLevel2`

Type: Object

Key	Description	Details
`tag`		See details
`combat`		See details

`tag`

Constant: "Combat"

`combat`

Type: CombatAnimalPower

`AnimalPowersLevel2`

Type: List
Items: AnimalPowersLevel2[]
Minimum Items: 1

`AnimalPowersLevel2[]`

Type: AnimalPowerLevel2

`AttributeAnimalPower`

Type: Object

Key	Description	Details
`id`	The attribute's identifier.	See details
`value`	The value that gets added to the attribute.	See details

`id`

The attribute's identifier.

Type: AttributeIdentifier

`value`

The value that gets added to the attribute.

Type: Integer
Minimum: 1

`AnimalPowerLevel3`

Type: Object

Key	Description	Details
`tag`		See details
`attribute`		See details

`tag`

Constant: "Attribute"

`attribute`

Type: AttributeAnimalPower

`AnimalPowersLevel3`

Type: List
Items: AnimalPowersLevel3[]
Minimum Items: 1

`AnimalPowersLevel3[]`

Type: AnimalPowerLevel3

15 KiB Raw Blame History Unescape Escape

Patron

Definitions

Patron (Patron)

id

category

skills

culture

primary_patron_cultures?

powers?

ae_cost?

improvement_cost?

common_advantages?

common_disadvantages?

common_spellworks?

translations

Patron/skills[]

Patron/primary_patron_cultures[]

Patron/common_advantages[]

Patron/common_disadvantages[]

Patron/common_spellworks[]

PatronTranslation

name

PatronCulture

set

operation

PatronCulture/set[]

PatronCultureOperation

PatronCultureOperation'0

PatronCultureOperation'1

AnimalPowers

level1

level2

level3

AdvantageAnimalPower

id

level?

option?

SkillAnimalPower

id

points

AnimalPowerLevel1

AnimalPowerLevel1'Advantage

tag

advantage

AnimalPowerLevel1'Skill

tag

skill

AnimalPowersLevel1

AnimalPowersLevel1[]

CombatAnimalPower

id

value

CombatAnimalPowerType

CombatAnimalPowerType'0

CombatAnimalPowerType'1

CombatAnimalPowerType'2

CombatAnimalPowerType'3

CombatAnimalPowerType'4

CombatAnimalPowerType'5

AnimalPowerLevel2

tag

combat

AnimalPowersLevel2

AnimalPowersLevel2[]

AttributeAnimalPower

id

value

AnimalPowerLevel3

tag

attribute

AnimalPowersLevel3

AnimalPowersLevel3[]

15 KiB

Raw Blame History

Patron (`Patron`)

`id`

`category`

`skills`

`culture`

`primary_patron_cultures?`

`powers?`

`ae_cost?`

`improvement_cost?`

`common_advantages?`

`common_disadvantages?`

`common_spellworks?`

`translations`

`Patron/skills[]`

`Patron/primary_patron_cultures[]`

`Patron/common_advantages[]`

`Patron/common_disadvantages[]`

`Patron/common_spellworks[]`

`PatronTranslation`

`name`

`PatronCulture`

`set`

`operation`

`PatronCulture/set[]`

`PatronCultureOperation`

`PatronCultureOperation'0`

`PatronCultureOperation'1`

`AnimalPowers`

`level1`

`level2`

`level3`

`AdvantageAnimalPower`

`id`

`level?`

`option?`

`SkillAnimalPower`

`id`

`points`

`AnimalPowerLevel1`

`AnimalPowerLevel1'Advantage`

`tag`

`advantage`

`AnimalPowerLevel1'Skill`

`tag`

`skill`

`AnimalPowersLevel1`

`AnimalPowersLevel1[]`

`CombatAnimalPower`

`id`

`value`

`CombatAnimalPowerType`

`CombatAnimalPowerType'0`

`CombatAnimalPowerType'1`

`CombatAnimalPowerType'2`

`CombatAnimalPowerType'3`

`CombatAnimalPowerType'4`

`CombatAnimalPowerType'5`

`AnimalPowerLevel2`

`tag`

`combat`

`AnimalPowersLevel2`

`AnimalPowersLevel2[]`

`AttributeAnimalPower`

`id`

`value`

`AnimalPowerLevel3`

`tag`

`attribute`

`AnimalPowersLevel3`

`AnimalPowersLevel3[]`