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

33 KiB

Raw Blame History

Culture

Definitions

Culture (`Culture`)

Type: Object

Key	Description	Details
`id`	An unique, increasing integer.	See details
`language`	A list of native languages (usually it is only one).	See details
`script?`	A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty.	See details
`area_knowledge`	If the area knowledge has a fixed value or can be adjusted.	See details
`social_status`	A list of possible social status in the respective culture.	See details
`common_professions`	A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list).	See details
`common_advantages?`	A list of common advantages.	See details
`common_disadvantages?`	A list of common disadvantages.	See details
`uncommon_advantages?`	A list of uncommon advantages.	See details
`uncommon_disadvantages?`	A list of uncommon disadvantages.	See details
`common_skills`	A list of common skills.	See details
`uncommon_skills?`	A list of uncommon skills.	See details
`cultural_package`	The skill points you get for buying the culture package.	See details
`src`		See details
`translations`	All translations for the entry, identified by IETF language tag (BCP47).	See details

`id`

An unique, increasing integer.

Type: Integer
Minimum: 1

`language`

A list of native languages (usually it is only one).

Type: List
Items: Culture/language[]
Minimum Items: 1

`script?`

A list of native scripts (usually it is only one). If the culture does not use any script, leave this field empty.

Type: List
Items: Culture/script[]
Minimum Items: 1

`area_knowledge`

If the area knowledge has a fixed value or can be adjusted.

Type: AreaKnowledge

`social_status`

A list of possible social status in the respective culture.

Type: List
Items: Culture/social_status[]
Minimum Items: 1

`common_professions`

A list of professions that are typical for the culture, as well as professions that are rarely practiced or encountered in the culture. The list is either defined by group (as multiple lists) or plain (as a single list).

Type: CommonProfessions

`common_advantages?`

A list of common advantages.

Type: List
Items: Culture/common_advantages[]
Minimum Items: 1

`common_disadvantages?`

A list of common disadvantages.

Type: List
Items: Culture/common_disadvantages[]
Minimum Items: 1

`uncommon_advantages?`

A list of uncommon advantages.

Type: List
Items: Culture/uncommon_advantages[]
Minimum Items: 1

`uncommon_disadvantages?`

A list of uncommon disadvantages.

Type: List
Items: Culture/uncommon_disadvantages[]
Minimum Items: 1

`common_skills`

A list of common skills.

Type: List
Items: Culture/common_skills[]
Minimum Items: 1

`uncommon_skills?`

A list of uncommon skills.

Type: List
Items: Culture/uncommon_skills[]
Minimum Items: 1

`cultural_package`

The skill points you get for buying the culture package.

Type: List
Items: Culture/cultural_package[]
Minimum Items: 1

`src`

Type: PublicationRefs

`translations`

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

Type: LocaleMap<CultureTranslation>

`AreaKnowledge`

If the area knowledge has a fixed value or can be adjusted.

Type: Object

Key	Description	Details
`is_fixed`	`true` if the area knowledge has a fixed value, `false` if it can be adjusted.	See details

`is_fixed`

true if the area knowledge has a fixed value, false if it can be adjusted.

Type: Boolean

`CommonnessWeight`

The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only).

Type: Union
Cases: CommonnessWeight'0 | CommonnessWeight'1

`CommonnessWeight'0`

Constant: "Mostly"

`CommonnessWeight'1`

Constant: "Only"

`Weighted<ProfessionOrVariant>`

Some professions or profession variants are more common than others. There may be cultures where some professions or profession variants are not represented at all.

Type: Object

Key	Description	Details
`elements`	The list of more common professions or profession variants.	See details
`weight`	The "weight" difference compared to other professions or profession variants. Some professions or profession variants are simply more common (Mostly), but sometimes only specific elements are used (Only).	See details

`elements`

The list of more common professions or profession variants.

Type: List
Items: Weighted/elements[]
Minimum Items: 1

`weight`

Type: CommonnessWeight

`Weighted/elements[]`

Type: ProfessionOrVariant

`CommonProfessionConstraintsOperation`

This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).

Type: Union
Cases: CommonProfessionConstraintsOperation'0 | CommonProfessionConstraintsOperation'1

`CommonProfessionConstraintsOperation'0`

Constant: "Intersection"

`CommonProfessionConstraintsOperation'1`

Constant: "Difference"

`CommonProfessionConstraints<Constraint>`

A list of professions. The filter specifies how the list is applied to all mundane professions.

Type: Object

Key	Description	Details
`constraints`	The list of constraints.	See details
`operation`	This defines how the list of constraints should be offset against the list of all mundane professions: Either only the professions are kept that intersect with the constraints (include) or only the professions are kept that are different from the constraints (exclude).	See details

`constraints`

The list of constraints.

Type: List
Items: CommonProfessionConstraints/constraints[]
Minimum Items: 1

`operation`

Type: CommonProfessionConstraintsOperation

`CommonProfessionConstraints/constraints[]`

Type: Constraint

`Rarity`

Some professions may be found in a culture, but are not that common.

Type: Union
Cases: Rarity'0 | Rarity'1

`Rarity'0`

Constant: "Rare"

`Rarity'1`

Constant: "VeryRare"

`ProfessionConstraint`

Type: Object

Key	Description	Details
`id`	The profession's identifier.	See details
`weighted_variants?`	Some profession variants are more common than others. There may be cultures where some variants are not represented at all.	See details
`rarity?`	Some professions may be found in a culture, but are not that common.	See details

`id`

The profession's identifier.

Type: ProfessionIdentifier

`weighted_variants?`

Some profession variants are more common than others. There may be cultures where some variants are not represented at all.

Type: Weighted<ProfessionVariantReference>

`rarity?`

Some professions may be found in a culture, but are not that common.

Type: Rarity

`MundaneProfessionSubgroupConstraint`

Some professions may be found in a culture, but are not that common.

Type: Union
Cases: MundaneProfessionSubgroupConstraint'0 | MundaneProfessionSubgroupConstraint'1 | MundaneProfessionSubgroupConstraint'2

`MundaneProfessionSubgroupConstraint'0`

Constant: "Profane"

`MundaneProfessionSubgroupConstraint'1`

Constant: "Fighter"

`MundaneProfessionSubgroupConstraint'2`

Constant: "Religious"

`MagicalTraditionConstraint`

Type: Object

Key	Description	Details
`id`	The magical tradition's identifier.	See details
`weighted_professions?`	Some professions are more common than others. There may be cultures where some professions are not represented at all.	See details
`rarity?`	Some traditions may be found in a culture, but are not that common.	See details

`id`

The magical tradition's identifier.

Type: MagicalTraditionIdentifier

`weighted_professions?`

Some professions are more common than others. There may be cultures where some professions are not represented at all.

Type: Weighted<ProfessionReference>

`rarity?`

Some traditions may be found in a culture, but are not that common.

Type: Rarity

`BlessedTraditionConstraint`

Type: Object

Key	Description	Details
`id`	The magical tradition's identifier.	See details
`weighted_professions?`	Some professions are more common than others. There may be cultures where some professions are not represented at all.	See details
`rarity?`	Some traditions may be found in a culture, but are not that common.	See details

`id`

The magical tradition's identifier.

Type: BlessedTraditionIdentifier

`weighted_professions?`

Some professions are more common than others. There may be cultures where some professions are not represented at all.

Type: Weighted<ProfessionReference>

`rarity?`

Some traditions may be found in a culture, but are not that common.

Type: Rarity

`MundaneCommonProfessionConstraint`

Type: Union
Cases: MundaneCommonProfessionConstraint'Profession | MundaneCommonProfessionConstraint'ProfessionSubgroup

`MundaneCommonProfessionConstraint'Profession`

Type: Object

Key	Description	Details
`tag`		See details
`profession`		See details

`tag`

Constant: "Profession"

`profession`

Type: ProfessionConstraint

`MundaneCommonProfessionConstraint'ProfessionSubgroup`

Type: Object

Key	Description	Details
`tag`		See details
`profession_subgroup`		See details

`tag`

Constant: "ProfessionSubgroup"

`profession_subgroup`

Type: MundaneProfessionSubgroupConstraint

`MagicCommonProfessionConstraint`

Type: Union
Cases: MagicCommonProfessionConstraint'Tradition | MagicCommonProfessionConstraint'MagicDilettante | MagicCommonProfessionConstraint'Profession

`MagicCommonProfessionConstraint'Tradition`

Type: Object

Key	Description	Details
`tag`		See details
`tradition`		See details

`tag`

Constant: "Tradition"

`tradition`

Type: MagicalTraditionConstraint

`MagicCommonProfessionConstraint'MagicDilettante`

Type: Object

Key	Description	Details
`tag`		See details
`magic_dilettante`		See details

`tag`

Constant: "MagicDilettante"

`magic_dilettante`

Type: Object

`MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante`

Type: Empty Object

`MagicCommonProfessionConstraint'Profession`

Type: Object

Key	Description	Details
`tag`		See details
`profession`		See details

`tag`

Constant: "Profession"

`profession`

Type: ProfessionConstraint

`BlessedCommonProfessionConstraint`

Type: Object

Key	Description	Details
`tag`		See details
`tradition`		See details

`tag`

Constant: "Tradition"

`tradition`

Type: BlessedTraditionConstraint

`PlainCommonProfessions`

Type: CommonProfessionConstraints<ProfessionReference>

`GroupedCommonProfessions`

Lists of professions by group.

Type: Object
Minimum Properties: 1

Key	Description	Details
`mundane?`		See details
`magic?`		See details
`blessed?`		See details

`mundane?`

Type: CommonProfessionConstraints<MundaneCommonProfessionConstraint>

`magic?`

Type: CommonProfessionConstraints<MagicCommonProfessionConstraint>

`blessed?`

Type: CommonProfessionConstraints<BlessedCommonProfessionConstraint>

`CommonProfessions`

Type: Union
Cases: CommonProfessions'Plain | CommonProfessions'Grouped

`CommonProfessions'Plain`

Type: Object

Key	Description	Details
`tag`		See details
`plain`		See details

`tag`

Constant: "Plain"

`plain`

Type: PlainCommonProfessions

`CommonProfessions'Grouped`

Type: Object

Key	Description	Details
`tag`		See details
`grouped`		See details

`tag`

Constant: "Grouped"

`grouped`

Type: GroupedCommonProfessions

`CommonnessRatedSkill`

Type: SkillReference

`CulturalPackageItem`

Type: Object

Key	Description	Details
`id`	The skill's identifier.	See details
`points`	The skill points for the respective skill you get for buying the cultural package.	See details

`id`

The skill's identifier.

Type: SkillIdentifier

`points`

The skill points for the respective skill you get for buying the cultural package.

Type: Integer
Minimum: 1
Maximum: 2

`CultureTranslation`

Type: Object

Key	Description	Details
`name`	The name of the state.	See details
`area_knowledge`	The description of the area knowledge.	See details
`common_advantages?`	The respective common advantages text from the source book.	See details
`common_disadvantages?`	The respective common disadvantages text from the source book.	See details
`uncommon_advantages?`	The respective uncommon advantages text from the source book.	See details
`uncommon_disadvantages?`	The respective uncommon disadvantages text from the source book.	See details
`common_names`	Structured description of common names.	See details
`errata?`		See details

`name`

The name of the state.

Type: String
Minimum Length: 1

`area_knowledge`

The description of the area knowledge.

Type: AreaKnowledgeTranslation

`common_advantages?`

The respective common advantages text from the source book.

Type: NonEmptyString

`common_disadvantages?`

The respective common disadvantages text from the source book.

Type: NonEmptyString

`uncommon_advantages?`

The respective uncommon advantages text from the source book.

Type: NonEmptyString

`uncommon_disadvantages?`

The respective uncommon disadvantages text from the source book.

Type: NonEmptyString

`common_names`

Structured description of common names.

Type: CommonNames

`errata?`

Type: Errata

`AreaKnowledgeTranslation`

Description and examples of the area knowledge.

Type: Object

Key	Description	Details
`description`	The full description without examples in parenthesis.	See details
`abbreviated`	A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description.	See details
`examples?`	Examples of areas, if applicable.	See details

`description`

The full description without examples in parenthesis.

Type: String
Minimum Length: 1

`abbreviated`

A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description.

Type: String
Minimum Length: 1

`examples?`

Examples of areas, if applicable.

Type: List
Items: AreaKnowledgeTranslation/examples[]
Minimum Items: 1

`AreaKnowledgeTranslation/examples[]`

Type: AreaKnowledgeExample

`AreaKnowledgeExample`

Type: Object

Key	Description	Details
`area`		See details

`area`

Type: String
Minimum Length: 1

`CommonNames`

Structured description of common names.

Type: Object
Minimum Properties: 1

Key	Description	Details
`first_name_groups?`	First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups.	See details
`last_name_groups?`	Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups.	See details
`naming_rules?`	Special naming rules.	See details

`first_name_groups?`

First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups.

Type: List
Items: CommonNames/first_name_groups[]
Minimum Items: 1

`last_name_groups?`

Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups.

Type: List
Items: CommonNames/last_name_groups[]
Minimum Items: 1

`naming_rules?`

Special naming rules.

Type: NonEmptyString

`CommonNames/first_name_groups[]`

Type: CommonNameGroup

`CommonNames/last_name_groups[]`

Type: CommonNameGroup

`CommonNameGroup`

Type: Object

Key	Description	Details
`label`	The group label.	See details
`sex?`	The binary sex if the group is only for a certain binary sex.	See details
`names`	The names from the group.	See details

`label`

The group label.

Type: NonEmptyString

`sex?`

The binary sex if the group is only for a certain binary sex.

Type: BinarySex

`names`

The names from the group.

Type: List
Items: CommonNameGroup/names[]
Minimum Items: 1

`CommonNameGroup/names[]`

Type: CommonName

`CommonName`

Type: Object

Key	Description	Details
`name`		See details
`note?`	Additional information about the name, appended in parenthesis.	See details

`name`

Type: NonEmptyString

`note?`

Additional information about the name, appended in parenthesis.

Type: NonEmptyString

33 KiB Raw Blame History

Culture

Definitions

Culture (Culture)

id

language

script?

area_knowledge

social_status

common_professions

common_advantages?

common_disadvantages?

uncommon_advantages?

uncommon_disadvantages?

common_skills

uncommon_skills?

cultural_package

src

translations

Culture/language[]

Culture/script[]

Culture/social_status[]

Culture/common_advantages[]

Culture/common_disadvantages[]

Culture/uncommon_advantages[]

Culture/uncommon_disadvantages[]

Culture/common_skills[]

Culture/uncommon_skills[]

Culture/cultural_package[]

AreaKnowledge

is_fixed

CommonnessWeight

CommonnessWeight'0

CommonnessWeight'1

Weighted<ProfessionOrVariant>

elements

weight

Weighted/elements[]

CommonProfessionConstraintsOperation

CommonProfessionConstraintsOperation'0

CommonProfessionConstraintsOperation'1

CommonProfessionConstraints<Constraint>

constraints

operation

CommonProfessionConstraints/constraints[]

Rarity

Rarity'0

Rarity'1

ProfessionConstraint

id

weighted_variants?

rarity?

MundaneProfessionSubgroupConstraint

MundaneProfessionSubgroupConstraint'0

MundaneProfessionSubgroupConstraint'1

MundaneProfessionSubgroupConstraint'2

MagicalTraditionConstraint

id

weighted_professions?

rarity?

BlessedTraditionConstraint

id

weighted_professions?

rarity?

MundaneCommonProfessionConstraint

MundaneCommonProfessionConstraint'Profession

tag

profession

MundaneCommonProfessionConstraint'ProfessionSubgroup

tag

profession_subgroup

MagicCommonProfessionConstraint

MagicCommonProfessionConstraint'Tradition

tag

tradition

MagicCommonProfessionConstraint'MagicDilettante

tag

magic_dilettante

MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante

MagicCommonProfessionConstraint'Profession

33 KiB

Raw Blame History

Culture (`Culture`)

`id`

`language`

`script?`

`area_knowledge`

`social_status`

`common_professions`

`common_advantages?`

`common_disadvantages?`

`uncommon_advantages?`

`uncommon_disadvantages?`

`common_skills`

`uncommon_skills?`

`cultural_package`

`src`

`translations`

`Culture/language[]`

`Culture/script[]`

`Culture/social_status[]`

`Culture/common_advantages[]`

`Culture/common_disadvantages[]`

`Culture/uncommon_advantages[]`

`Culture/uncommon_disadvantages[]`

`Culture/common_skills[]`

`Culture/uncommon_skills[]`

`Culture/cultural_package[]`

`AreaKnowledge`

`is_fixed`

`CommonnessWeight`

`CommonnessWeight'0`

`CommonnessWeight'1`

`Weighted<ProfessionOrVariant>`

`elements`

`weight`

`Weighted/elements[]`

`CommonProfessionConstraintsOperation`

`CommonProfessionConstraintsOperation'0`

`CommonProfessionConstraintsOperation'1`

`CommonProfessionConstraints<Constraint>`

`constraints`

`operation`

`CommonProfessionConstraints/constraints[]`

`Rarity`

`Rarity'0`

`Rarity'1`

`ProfessionConstraint`

`id`

`weighted_variants?`

`rarity?`

`MundaneProfessionSubgroupConstraint`

`MundaneProfessionSubgroupConstraint'0`

`MundaneProfessionSubgroupConstraint'1`

`MundaneProfessionSubgroupConstraint'2`

`MagicalTraditionConstraint`

`id`

`weighted_professions?`

`rarity?`

`BlessedTraditionConstraint`

`id`

`weighted_professions?`

`rarity?`

`MundaneCommonProfessionConstraint`

`MundaneCommonProfessionConstraint'Profession`

`tag`

`profession`

`MundaneCommonProfessionConstraint'ProfessionSubgroup`

`tag`

`profession_subgroup`

`MagicCommonProfessionConstraint`

`MagicCommonProfessionConstraint'Tradition`

`tag`

`tradition`

`MagicCommonProfessionConstraint'MagicDilettante`

`tag`

`magic_dilettante`

`MagicCommonProfessionConstraint'MagicDilettante/magic_dilettante`

`MagicCommonProfessionConstraint'Profession`

`tag`

`profession`