ZZZ Upgrade Guide Models

upgrade_guide

ZZZ agent upgrade guide models.

Classes:

• DiscLevelCap –

  Max disc level per rarity.

• LevelCapInfo –

  Level caps for the current (or next) game version.

• PlanUnlockInfo –

  Which agents, bangboos, and W-engines referenced by a build the user owns.

• RecommendedBuddy –

  A recommended bangboo in a team comp.

• RecommendedBuild –

  A recommended build for an agent.

• RecommendedBuildDetail –

  The contents of a recommended build.

• RecommendedDiscProperty –

  A recommended disc main or sub stat.

• RecommendedDiscs –

  The recommended discs for a build.

• RecommendedStat –

  A target stat range in a recommended build.

• RecommendedTeam –

  Recommended team comps for a build.

• RecommendedTeamGroup –

  A recommended team (main or backup variant).

• RecommendedWeapon –

  The recommended W-engine for a build.

• SkillLevelCap –

  Max level for a skill type.

• SkillUpgradeAdvice –

  Recommended skill upgrade priority, grouped into tiers of skill types.

• TeamAvatarExtInfo –

  Extra info about an agent slot in a recommended team comp.

• UpgradeGuideAgentDetail –

  Detailed agent info (current build) in the upgrade guide tool.

• UpgradeGuideAgentInfo –

  Brief agent info in the upgrade guide tool.

• UpgradeGuideAgentProperty –

  An agent stat in the upgrade guide tool.

• UpgradeGuideAgentSkill –

  ZZZ agent skill model in the upgrade guide tool.

• UpgradeGuideAwakenInfo –

  Agent awaken (potential) system availability info.

• UpgradeGuideBaseAgent –

  Base agent model returned by the upgrade guide tool.

• UpgradeGuideDisc –

  A ZZZ disc in the upgrade guide tool.

• UpgradeGuideDiscSetEffect –

  A disc set effect in the upgrade guide tool.

• UpgradeGuideProperty –

  A disc or W-engine property with upgrade guide detail.

• UpgradeGuideSkillItem –

  An agent skill item in the upgrade guide tool.

• UpgradeGuideUser –

  The HoYoLAB user who owns the queried account.

• UpgradeGuideWEngine –

  A ZZZ W-engine in the upgrade guide tool.

• WikiEntry –

  A HoYoLAB wiki link.

• ZZZAgentUpgradeGuide –

  Detailed agent build and recommended upgrade guide.

• ZZZUpgradeGuideAgent –

  An entry in the upgrade guide tool's agent list.

DiscLevelCap pydantic-model

Max disc level per rarity.

Fields:

• b (int)
• a (int)
• s (int)

a pydantic-field

a: int

b pydantic-field

b: int

s pydantic-field

s: int

LevelCapInfo pydantic-model

Level caps for the current (or next) game version.

Fields:

• avatar_level_max (int)
• weapon_level_max (int)
• equip_level_max (DiscLevelCap)
• skill_core_level_max (int)
• skill_normal_level_max (Sequence[SkillLevelCap])

avatar_level_max pydantic-field

avatar_level_max: int

equip_level_max pydantic-field

equip_level_max: DiscLevelCap

skill_core_level_max pydantic-field

skill_core_level_max: int

skill_normal_level_max pydantic-field

skill_normal_level_max: Sequence[SkillLevelCap]

weapon_level_max pydantic-field

weapon_level_max: int

PlanUnlockInfo pydantic-model

Which agents, bangboos, and W-engines referenced by a build the user owns.

Fields:

• avatars (Mapping[int, bool])
• buddies (Mapping[int, bool])
• weapons (Mapping[int, bool])

avatars pydantic-field

avatars: Mapping[int, bool]

buddies pydantic-field

buddies: Mapping[int, bool]

weapons pydantic-field

weapons: Mapping[int, bool]

RecommendedBuddy pydantic-model

A recommended bangboo in a team comp.

Fields:

• id (int)
• name (str)
• rarity (str)

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: str

RecommendedBuild pydantic-model

A recommended build for an agent.

Fields:

• id (int)
• name (str)
• description (str)
• released_at (UnixDateTime)
• detail (Optional[RecommendedBuildDetail])

description pydantic-field

description: str

detail pydantic-field

detail: Optional[RecommendedBuildDetail] = None

id pydantic-field

id: int

name pydantic-field

name: str

released_at pydantic-field

released_at: UnixDateTime

RecommendedBuildDetail pydantic-model

The contents of a recommended build.

Fields:

• target_stats (Sequence[RecommendedStat])
• weapon (RecommendedWeapon)
• discs (RecommendedDiscs)
• skills (Sequence[UpgradeGuideAgentSkill])
• team (RecommendedTeam)
• avatar_wiki (Sequence[WikiEntry])
• bangboo_wiki (Sequence[WikiEntry])
• unlock_info (PlanUnlockInfo)
• unlocked_talents (Sequence[int])

avatar_wiki pydantic-field

avatar_wiki: Sequence[WikiEntry]

bangboo_wiki pydantic-field

bangboo_wiki: Sequence[WikiEntry]

discs pydantic-field

discs: RecommendedDiscs

skills pydantic-field

skills: Sequence[UpgradeGuideAgentSkill]

target_stats pydantic-field

target_stats: Sequence[RecommendedStat]

team pydantic-field

team: RecommendedTeam

unlock_info pydantic-field

unlock_info: PlanUnlockInfo

unlocked_talents pydantic-field

unlocked_talents: Sequence[int]

weapon pydantic-field

weapon: RecommendedWeapon

RecommendedDiscProperty pydantic-model

A recommended disc main or sub stat.

Fields:

• name (str)
• type (Union[int, ZZZPropertyType])
• system_id (int)

Validators:

• __cast_id → type

name pydantic-field

name: str

system_id pydantic-field

system_id: int

type pydantic-field

type: Union[int, ZZZPropertyType]

RecommendedDiscs pydantic-model

The recommended discs for a build.

Fields:

• sets (Sequence[UpgradeGuideDiscSetEffect])
• set_kind (int)
• slot_4_main_stats (Sequence[RecommendedDiscProperty])
• slot_5_main_stats (Sequence[RecommendedDiscProperty])
• slot_6_main_stats (Sequence[RecommendedDiscProperty])
• sub_stats (Sequence[RecommendedDiscProperty])

set_kind pydantic-field

set_kind: int

sets pydantic-field

sets: Sequence[UpgradeGuideDiscSetEffect]

slot_4_main_stats pydantic-field

slot_4_main_stats: Sequence[RecommendedDiscProperty]

slot_5_main_stats pydantic-field

slot_5_main_stats: Sequence[RecommendedDiscProperty]

slot_6_main_stats pydantic-field

slot_6_main_stats: Sequence[RecommendedDiscProperty]

sub_stats pydantic-field

sub_stats: Sequence[RecommendedDiscProperty]

RecommendedStat pydantic-model

A target stat range in a recommended build.

Fields:

• name (str)
• type (Union[int, ZZZPropertyType])
• low (str)
• mid (str)
• high (str)
• show_phase (int)
• show_percent (int)

Validators:

• __cast_id → type

high pydantic-field

high: str

low pydantic-field

low: str

mid pydantic-field

mid: str

name pydantic-field

name: str

show_percent pydantic-field

show_percent: int

show_phase pydantic-field

show_phase: int

type pydantic-field

type: Union[int, ZZZPropertyType]

RecommendedTeam pydantic-model

Recommended team comps for a build.

Fields:

• main (RecommendedTeamGroup)
• backup (RecommendedTeamGroup)

backup pydantic-field

backup: RecommendedTeamGroup

main pydantic-field

main: RecommendedTeamGroup

RecommendedTeamGroup pydantic-model

A recommended team (main or backup variant).

Fields:

• agents (Sequence[UpgradeGuideAgentInfo])
• buddies (Sequence[RecommendedBuddy])
• ext_info (Sequence[TeamAvatarExtInfo])

agents pydantic-field

agents: Sequence[UpgradeGuideAgentInfo]

buddies pydantic-field

buddies: Sequence[RecommendedBuddy]

ext_info pydantic-field

ext_info: Sequence[TeamAvatarExtInfo]

RecommendedWeapon pydantic-model

The recommended W-engine for a build.

Fields:

• main (Optional[UpgradeGuideWEngine])
• backup (Optional[UpgradeGuideWEngine])

Validators:

• __nullify_placeholder → main, backup

backup pydantic-field

backup: Optional[UpgradeGuideWEngine] = None

main pydantic-field

main: Optional[UpgradeGuideWEngine] = None

SkillLevelCap pydantic-model

Max level for a skill type.

Fields:

• type (ZZZSkillType)
• level (int)

level pydantic-field

level: int

type pydantic-field

type: ZZZSkillType

SkillUpgradeAdvice pydantic-model

Recommended skill upgrade priority, grouped into tiers of skill types.

Fields:

• first (Sequence[int])
• second (Sequence[int])
• third (Sequence[int])

first pydantic-field

first: Sequence[int]

second pydantic-field

second: Sequence[int]

third pydantic-field

third: Sequence[int]

TeamAvatarExtInfo pydantic-model

Extra info about an agent slot in a recommended team comp.

Fields:

• backup_avatar_list (Sequence[Any])
• pos_type (int)

backup_avatar_list pydantic-field

backup_avatar_list: Sequence[Any]

pos_type pydantic-field

pos_type: int

UpgradeGuideAgentDetail pydantic-model

Detailed agent info (current build) in the upgrade guide tool.

Fields:

• id (int)
• element (ZZZElementType)
• rarity (Literal['S', 'A'])
• name (str)
• full_name (str)
• specialty (ZZZSpecialty)
• faction_icon (str)
• rectangle_icon (str)
• square_icon (Optional[str])
• faction_name (str)
• sub_element (int)
• awaken_state (str)
• level (int)
• rank (int)
• properties (Sequence[UpgradeGuideAgentProperty])
• skills (Sequence[UpgradeGuideAgentSkill])
• ranks (Sequence[ZZZAgentRank])
• signature_weapon_id (int)
• skill_upgrade (SkillUpgradeAdvice)
• promotes (int)
• unlock (bool)
• awaken_info (Optional[UpgradeGuideAwakenInfo])

awaken_info pydantic-field

awaken_info: Optional[UpgradeGuideAwakenInfo] = None

None for agents the user has not unlocked.

level pydantic-field

level: int

promotes pydantic-field

promotes: int

Current ascension (promotion) level.

properties pydantic-field

properties: Sequence[UpgradeGuideAgentProperty]

rank pydantic-field

rank: int

Also known as Mindscape Cinema in-game.

ranks pydantic-field

ranks: Sequence[ZZZAgentRank]

Also known as Mindscape Cinemas in-game.

signature_weapon_id pydantic-field

signature_weapon_id: int

skill_upgrade pydantic-field

skill_upgrade: SkillUpgradeAdvice

skills pydantic-field

skills: Sequence[UpgradeGuideAgentSkill]

unlock pydantic-field

unlock: bool

UpgradeGuideAgentInfo pydantic-model

Brief agent info in the upgrade guide tool.

Fields:

• id (int)
• element (ZZZElementType)
• rarity (Literal['S', 'A'])
• name (str)
• full_name (str)
• specialty (ZZZSpecialty)
• faction_icon (str)
• rectangle_icon (str)
• square_icon (Optional[str])
• faction_name (str)
• sub_element (int)
• awaken_state (str)
• level (int)
• rank (int)

level pydantic-field

level: int

rank pydantic-field

rank: int

Also known as Mindscape Cinema in-game.

UpgradeGuideAgentProperty pydantic-model

An agent stat in the upgrade guide tool.

Fields:

• name (str)
• type (Union[int, ZZZPropertyType])
• value (str)
• add (str)
• final (str)
• final_val (str)

Validators:

• __cast_id → type

final_val pydantic-field

final_val: str

The final value without formatting (e.g. percentages stripped).

UpgradeGuideAgentSkill pydantic-model

ZZZ agent skill model in the upgrade guide tool.

Fields:

• level (int)
• type (ZZZSkillType)
• items (Sequence[UpgradeGuideSkillItem])

items pydantic-field

items: Sequence[UpgradeGuideSkillItem]

UpgradeGuideAwakenInfo pydantic-model

Agent awaken (potential) system availability info.

Fields:

• has_potential (bool)
• current_level (int)
• max_level (int)

current_level pydantic-field

current_level: int

has_potential pydantic-field

has_potential: bool

max_level pydantic-field

max_level: int

UpgradeGuideBaseAgent pydantic-model

Base agent model returned by the upgrade guide tool.

Fields:

• id (int)
• element (ZZZElementType)
• rarity (Literal['S', 'A'])
• name (str)
• full_name (str)
• specialty (ZZZSpecialty)
• faction_icon (str)
• rectangle_icon (str)
• faction_name (str)
• square_icon (Optional[str])
• sub_element (int)
• awaken_state (str)

awaken_state pydantic-field

awaken_state: str

square_icon pydantic-field

square_icon: Optional[str] = None

sub_element pydantic-field

sub_element: int

UpgradeGuideDisc pydantic-model

A ZZZ disc in the upgrade guide tool.

Fields:

• id (int)
• level (int)
• name (str)
• icon (str)
• rarity (Literal['B', 'A', 'S'])
• position (int)
• properties (Sequence[UpgradeGuideProperty])
• main_properties (Sequence[UpgradeGuideProperty])
• set_effect (UpgradeGuideDiscSetEffect)
• invalid_property_cnt (int)
• all_hit (bool)

all_hit pydantic-field

all_hit: bool

invalid_property_cnt pydantic-field

invalid_property_cnt: int

main_properties pydantic-field

main_properties: Sequence[UpgradeGuideProperty]

properties pydantic-field

properties: Sequence[UpgradeGuideProperty]

set_effect pydantic-field

set_effect: UpgradeGuideDiscSetEffect

UpgradeGuideDiscSetEffect pydantic-model

A disc set effect in the upgrade guide tool.

Fields:

• id (int)
• name (str)
• owned_num (int)
• two_piece_description (str)
• four_piece_description (str)
• icon (str)
• count (int)
• rarity (str)

count pydantic-field

count: int

icon pydantic-field

icon: str

rarity pydantic-field

rarity: str

UpgradeGuideProperty pydantic-model

A disc or W-engine property with upgrade guide detail.

Fields:

• name (str)
• type (Union[int, ZZZPropertyType])
• value (str)
• level (int)
• valid (bool)
• system_id (int)
• add (int)

Validators:

• __cast_id → type

add pydantic-field

add: int

level pydantic-field

level: int

system_id pydantic-field

system_id: int

valid pydantic-field

valid: bool

UpgradeGuideSkillItem pydantic-model

An agent skill item in the upgrade guide tool.

Fields:

• title (str)
• text (str)
• awaken (bool)

awaken pydantic-field

awaken: bool

UpgradeGuideUser pydantic-model

The HoYoLAB user who owns the queried account.

Fields:

• aid (str)
• name (str)
• avatar (str)
• level (int)
• jump_url (str)
• uid (str)

aid pydantic-field

aid: str

avatar pydantic-field

avatar: str

jump_url pydantic-field

jump_url: str

level pydantic-field

level: int

name pydantic-field

name: str

uid pydantic-field

uid: str

UpgradeGuideWEngine pydantic-model

A ZZZ W-engine in the upgrade guide tool.

Fields:

• id (int)
• level (int)
• name (str)
• icon (str)
• rarity (Literal['B', 'A', 'S'])
• effect_title (str)
• effect_description (str)
• profession (ZZZSpecialty)
• refinement (int)
• properties (Sequence[UpgradeGuideProperty])
• main_properties (Sequence[UpgradeGuideProperty])

main_properties pydantic-field

main_properties: Sequence[UpgradeGuideProperty]

properties pydantic-field

properties: Sequence[UpgradeGuideProperty]

refinement pydantic-field

refinement: int

Can be 0 when the W-engine is a recommendation the user does not own.

WikiEntry pydantic-model

A HoYoLAB wiki link.

Fields:

• id (int)
• url (str)

id pydantic-field

id: int

url pydantic-field

url: str

ZZZAgentUpgradeGuide pydantic-model

Detailed agent build and recommended upgrade guide.

Fields:

• avatar (UpgradeGuideAgentDetail)
• discs (Sequence[UpgradeGuideDisc])
• weapon (Optional[UpgradeGuideWEngine])
• plan (RecommendedBuild)
• level_caps (Optional[LevelCapInfo])
• next_level_caps (Optional[LevelCapInfo])
• user (UpgradeGuideUser)
• my_plan_id (str)
• my_plan_list (Sequence[Any])
• valid_property_cnt (int)
• from_my_plan (bool)
• is_followed (bool)
• new_feed_plan_flag (bool)
• old_plan (bool)
• plan_changed (bool)
• plan_deleted (bool)
• plan_only_special_property (bool)

avatar pydantic-field

avatar: UpgradeGuideAgentDetail

discs pydantic-field

discs: Sequence[UpgradeGuideDisc]

from_my_plan pydantic-field

from_my_plan: bool

is_followed pydantic-field

is_followed: bool

level_caps pydantic-field

level_caps: Optional[LevelCapInfo] = None

None for agents the user has not unlocked.

my_plan_id pydantic-field

my_plan_id: str

my_plan_list pydantic-field

my_plan_list: Sequence[Any]

new_feed_plan_flag pydantic-field

new_feed_plan_flag: bool

next_level_caps pydantic-field

next_level_caps: Optional[LevelCapInfo] = None

None for agents the user has not unlocked.

old_plan pydantic-field

old_plan: bool

plan pydantic-field

plan: RecommendedBuild

The recommended build (upgrade guide).

plan_changed pydantic-field

plan_changed: bool

plan_deleted pydantic-field

plan_deleted: bool

plan_only_special_property pydantic-field

plan_only_special_property: bool

user pydantic-field

user: UpgradeGuideUser

valid_property_cnt pydantic-field

valid_property_cnt: int

weapon pydantic-field

weapon: Optional[UpgradeGuideWEngine] = None

ZZZUpgradeGuideAgent pydantic-model

An entry in the upgrade guide tool's agent list.

Fields:

• id (int)
• element (ZZZElementType)
• rarity (Literal['S', 'A'])
• name (str)
• full_name (str)
• specialty (ZZZSpecialty)
• faction_icon (str)
• rectangle_icon (str)
• square_icon (Optional[str])
• faction_name (str)
• sub_element (int)
• awaken_state (str)
• level (int)
• rank (int)
• unlocked (bool)
• is_up (bool)
• is_teaser (bool)
• is_top (bool)

Validators:

• __unnest_avatar

is_teaser pydantic-field

is_teaser: bool

Whether the agent is unreleased (teaser/preview only).

is_top pydantic-field

is_top: bool

is_up pydantic-field

is_up: bool

Whether the agent is currently on a rate-up banner.

unlocked pydantic-field

unlocked: bool