Genshin Calculator Models

calculator

Genshin calculator models.

Classes:

• CalculatorArtifact –

  Artifact meant to be used with calculators.

• CalculatorArtifactResult –

  Calculation result for a specific artifact.

• CalculatorCharacter –

  Character meant to be used with calculators.

• CalculatorCharacterDetails –

  Details of a synced calculator character.

• CalculatorConsumable –

  Item consumed when upgrading.

• CalculatorFurnishing –

  Furnishing meant to be used with calculators.

• CalculatorFurnishingResults –

  Furnishing calculation result.

• CalculatorResult –

  Calculation result.

• CalculatorTalent –

  Talent of a character meant to be used with calculators.

• CalculatorWeapon –

  Weapon meant to be used with calculators.

Attributes:

• CALCULATOR_ARTIFACTS (Mapping[int, str]) –
• CALCULATOR_ELEMENTS (Mapping[int, str]) –
• CALCULATOR_WEAPON_TYPES (Mapping[int, str]) –

CALCULATOR_ARTIFACTS module-attribute

CALCULATOR_ARTIFACTS: Mapping[int, str] = {
    1: "Flower of Life",
    2: "Plume of Death",
    3: "Sands of Eon",
    4: "Goblet of Eonothem",
    5: "Circlet of Logos",
}

CALCULATOR_ELEMENTS module-attribute

CALCULATOR_ELEMENTS: Mapping[int, str] = {
    1: "Pyro",
    2: "Anemo",
    3: "Geo",
    4: "Dendro",
    5: "Electro",
    6: "Hydro",
    7: "Cryo",
}

CALCULATOR_WEAPON_TYPES module-attribute

CALCULATOR_WEAPON_TYPES: Mapping[int, str] = {
    0: "Unknown",
    1: "Sword",
    10: "Catalyst",
    11: "Claymore",
    12: "Bow",
    13: "Polearm",
}

CalculatorArtifact pydantic-model

Artifact meant to be used with calculators.

Fields:

• id (int)
• name (str)
• icon (str)
• rarity (int)
• pos (int)
• level (int)
• max_level (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

level pydantic-field

level: int = 0

max_level pydantic-field

max_level: int

name pydantic-field

name: str

pos pydantic-field

pos: int

pos_name property

pos_name: str

rarity pydantic-field

rarity: int

CalculatorArtifactResult pydantic-model

Calculation result for a specific artifact.

Fields:

• artifact_id (int)
• materials (Sequence[CalculatorConsumable])

artifact_id pydantic-field

artifact_id: int

materials pydantic-field

materials: Sequence[CalculatorConsumable]

CalculatorBatchResult pydantic-model

Batch calculation result.

Fields:

• characters (list[CalculatorResult])
• available_materials (list[CalculatorConsumable])
• total_materials (list[CalculatorConsumable])
• total_material_details (RemainingMaterialDetails)
• individual_results (Sequence[CalculatorBatchResult])
• has_user_info (bool)

available_materials pydantic-field

available_materials: list[CalculatorConsumable]

characters pydantic-field

characters: list[CalculatorResult]

has_user_info pydantic-field

has_user_info: bool

individual_results pydantic-field

individual_results: Sequence[CalculatorBatchResult]

total_material_details pydantic-field

total_material_details: RemainingMaterialDetails

total_materials pydantic-field

total_materials: list[CalculatorConsumable]

total_remaining_required_materials property

total_remaining_required_materials: Sequence[
    CalculatorConsumable
]

CalculatorCharacter pydantic-model

Character meant to be used with calculators.

Fields:

• id (int)
• name (str)
• rarity (int)
• icon (str)
• collab (bool)
• element (str)
• weapon_type (str)
• level (int)
• max_level (int)

Validators:

• __autocomplete
• __parse_element → element
• __parse_weapon_type → weapon_type

element pydantic-field

element: str

level pydantic-field

level: int = 0

max_level pydantic-field

max_level: int

weapon_type pydantic-field

weapon_type: str

CalculatorCharacterDetails pydantic-model

Details of a synced calculator character.

Fields:

• weapon (CalculatorWeapon)
• talents (Sequence[CalculatorTalent])
• artifacts (Sequence[CalculatorArtifact])

Validators:

• __correct_talent_current_level → talents

artifacts pydantic-field

artifacts: Sequence[CalculatorArtifact]

talents pydantic-field

talents: Sequence[CalculatorTalent]

upgradeable_talents property

upgradeable_talents: Sequence[CalculatorTalent]

All talents that can be leveled up.

weapon pydantic-field

weapon: CalculatorWeapon

CalculatorConsumable pydantic-model

Item consumed when upgrading.

Fields:

• id (int)
• name (str)
• icon (str)
• rarity (int)
• amount (int)
• lacking (int)
• wiki_url (str)

amount pydantic-field

amount: int = 1

icon pydantic-field

icon: str

id pydantic-field

id: int

lacking pydantic-field

lacking: int = 0

name pydantic-field

name: str

rarity pydantic-field

rarity: int

wiki_url pydantic-field

wiki_url: str

CalculatorDomain pydantic-model

Domain that drops a material.

Fields:

• name (str)
• weekdays (Sequence[int])
• calendar_url (str)

calendar_url pydantic-field

calendar_url: str

name pydantic-field

name: str

weekdays pydantic-field

weekdays: Sequence[int]

List of weekdays the domain is open, 0=Monday, 6=Sunday.

CalculatorFurnishing pydantic-model

Furnishing meant to be used with calculators.

Fields:

• id (int)
• name (str)
• icon (str)
• rarity (int)
• amount (Optional[int])

amount pydantic-field

amount: Optional[int] = None

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: int

CalculatorFurnishingResults pydantic-model

Furnishing calculation result.

Fields:

• furnishings (list[CalculatorConsumable])

furnishings pydantic-field

furnishings: list[CalculatorConsumable]

total property

total: Sequence[CalculatorConsumable]

CalculatorMonster pydantic-model

Monster that drops a material.

Fields:

• id (int)
• name (str)
• icon (str)
• map_url (str)

icon pydantic-field

icon: str

id pydantic-field

id: int

map_url pydantic-field

map_url: str

name pydantic-field

name: str

CalculatorResult pydantic-model

Calculation result.

Fields:

• character (list[CalculatorConsumable])
• weapon (list[CalculatorConsumable])
• talents (list[CalculatorTalentResult])
• artifacts (list[CalculatorArtifactResult])
• lineup_recommendation (Optional[str])

artifacts pydantic-field

artifacts: list[CalculatorArtifactResult]

character pydantic-field

character: list[CalculatorConsumable]

lineup_recommendation pydantic-field

lineup_recommendation: Optional[str] = None

talents pydantic-field

talents: list[CalculatorTalentResult]

total property

total: Sequence[CalculatorConsumable]

weapon pydantic-field

weapon: list[CalculatorConsumable]

CalculatorTalent pydantic-model

Talent of a character meant to be used with calculators.

Fields:

• id (int)
• group_id (int)
• name (str)
• icon (str)
• level (int)
• max_level (int)

group_id pydantic-field

group_id: int

icon pydantic-field

icon: str

id pydantic-field

id: int

level pydantic-field

level: int = 0

max_level pydantic-field

max_level: int

name pydantic-field

name: str

type property

type: (
    Literal["attack", "skill", "burst", "passive", "dash"]
    | None
)

The type of the talent, parsed from the group id.

Does not work for traveler!

upgradeable property

upgradeable: bool

Whether this talent can be leveled up.

CalculatorTalentInfo pydantic-model

Information about a talent in the calculator.

Fields:

• talent_id (int)
• current (int)
• target (int)

current pydantic-field

current: int = 0

talent_id pydantic-field

talent_id: int

target pydantic-field

target: int = 0

CalculatorTalentResult pydantic-model

Calculation result for a specific talent.

Fields:

• info (CalculatorTalentInfo)
• materials (Sequence[CalculatorConsumable])

info pydantic-field

info: CalculatorTalentInfo

materials pydantic-field

materials: Sequence[CalculatorConsumable]

CalculatorWeapon pydantic-model

Weapon meant to be used with calculators.

Fields:

• id (int)
• name (str)
• icon (str)
• rarity (int)
• type (str)
• level (int)
• max_level (int)

Validators:

• __parse_weapon_type → type

icon pydantic-field

icon: str

id pydantic-field

id: int

level pydantic-field

level: int = 0

max_level pydantic-field

max_level: int

name pydantic-field

name: str

rarity pydantic-field

rarity: int

type pydantic-field

type: str

MaterialSource

Source of the material.

Attributes:

• DOMAIN –
• MONSTER –
• SPECIAL –
• WEEKLY_BOSS –
• WORLD –

DOMAIN class-attribute instance-attribute

DOMAIN = 'MT_DUNGEON'

MONSTER class-attribute instance-attribute

MONSTER = 'MT_MONSTER'

SPECIAL class-attribute instance-attribute

SPECIAL = 'MT_SPECIAL'

WEEKLY_BOSS class-attribute instance-attribute

WEEKLY_BOSS = 'MT_WEEKLY_DUNGEON'

WORLD class-attribute instance-attribute

WORLD = 'MT_WORLD'

PartialCalculatorCharacter pydantic-model

Fields:

• id (int)
• icon (str)
• rarity (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

rarity pydantic-field

rarity: int

PartialCalculatorWeapon pydantic-model

Fields:

• id (int)
• icon (str)
• rarity (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

rarity pydantic-field

rarity: int

RemainingMaterialDetail pydantic-model

Details of remaining required materials for a character.

Fields:

• materials (Sequence[CalculatorConsumable])
• characters (Sequence[PartialCalculatorCharacter])
• weapons (Sequence[PartialCalculatorWeapon])
• material_source (MaterialSource)
• monster (Optional[CalculatorMonster])
• map_url (Optional[str])
• domain (Optional[CalculatorDomain])

characters pydantic-field

characters: Sequence[PartialCalculatorCharacter]

Characters these materials are needed for, empty if accessing weapons.

domain pydantic-field

domain: Optional[CalculatorDomain] = None

Domain info, may be present if material_source is MT_DUNGEON.

map_url pydantic-field

map_url: Optional[str] = None

URL to interactive map, present if material_source is MT_WORLD.

material_source pydantic-field

material_source: MaterialSource

materials pydantic-field

materials: Sequence[CalculatorConsumable]

monster pydantic-field

monster: Optional[CalculatorMonster] = None

Monster info, present if material_source is MT_MONSTER or MT_WEEKLY_DUNGEON.

weapons pydantic-field

weapons: Sequence[PartialCalculatorWeapon]

Weapons these materials are needed for, empty if accessing characters or talents.

RemainingMaterialDetails pydantic-model

Details of remaining required materials for a character.

Fields:

• characters (Sequence[RemainingMaterialDetail])
• weapon (Sequence[RemainingMaterialDetail])
• talents (Sequence[RemainingMaterialDetail])

characters pydantic-field

characters: Sequence[RemainingMaterialDetail]

talents pydantic-field

talents: Sequence[RemainingMaterialDetail]

weapon pydantic-field

weapon: Sequence[RemainingMaterialDetail]