Honkai Mode Models

modes

Honkai battle chronicle models.

Classes:

• Boss –

  Represents a Boss encountered in Abyss or Memorial Arena.

• ELF –

  Represents an ELF equipped for a battle.

• ElysianRealm –

  Represents one completed run of Elysean Realms.

• MemorialArena –

  Represents aggregate weekly performance for the entire Memorial Arena rotation.

• MemorialBattle –

  Represents weekly performance against a single Memorial Arena boss.

• OldAbyss –

  Represents once cycle of Quantum Singularis or Dirac Sea.

• SuperstringAbyss –

  Represents one cycle of Superstring Abyss, exclusive to players of level 81 and up.

REMEMBRANCE_SIGILS module-attribute

REMEMBRANCE_SIGILS: dict[int, tuple[str, int]] = {119301: ('The MOTH Insignia', 1), 119302: ('Home Lost', 1), 119303: ('False Hope', 1), 119304: ('Tin Flask', 1), 119305: ('Ruined Legacy', 1), 119306: ('Burden', 2), 119307: ('Gold Goblet', 2), 119308: ("Mad King's Mask", 2), 119309: ('Light as a Bodhi Leaf', 2), 119310: ('Forget-Me-Not', 2), 119311: ('Forbidden Seed', 2), 119312: ('Memory', 2), 119313: ('Crystal Rose', 2), 119314: ('Abandoned', 3), 119315: ('Good Old Days', 3), 119316: ('Shattered Shackles', 3), 119317: ('Heavy as a Million Lives', 3), 119318: ('Stained Sakura', 3), 119319: ('The First Scale', 3), 119320: ('Resolve', 3), 119321: ('Thorny Crown', 3), 119326: ('Veil of Tears', 2), 119327: ('Pseudo Miracle', 2), 119328: ('Fragile Friend', 2), 119329: ('Rainbow of Absence', 2), 119330: ('Feast of Emptiness', 2), 119331: ('It Will Be Written', 4), 119332: ('Because of You', 4), 119333: ('Boundless Feeling', 4), 119334: ('Dreamful Gold', 4), 119335: ('Falling in Past Light', 4), 119336: ("An Old Pal's Legacy", 4), 119337: ('Empty Like Shala', 4), 119338: ('Tsukimi Himiko', 4), 119339: ('Out of Reach', 4), 119340: ('Boundless Logos', 4), 119341: ('The Lonely Moon', 4), 119342: ('Hometown', 4), 119343: ('Awakening', 4), 119344: ('Proof of Good and Evil', 3), 119345: ('Faraway Ship', 3), 119346: ('Ravenous Gully', 3), 119347: ('Grey-scale Rainbow', 3), 119348: ('Nine Lives', 3), 119349: ('Key to the Deep', 1)}

__all__ module-attribute

__all__ = ['ELF', 'Boss', 'ElysianRealm', 'MemorialArena', 'MemorialBattle', 'OldAbyss', 'SuperstringAbyss']

BaseAbyss pydantic-model

Represents one cycle of abyss.

(3 days per cycle, 2 cycles per week)

Fields:

• raw_tier (int)
• score (int)
• lineup (Sequence[Battlesuit])
• boss (Boss)
• elf (Optional[ELF])

boss pydantic-field

boss: Boss

elf pydantic-field

elf: Optional[ELF]

lineup pydantic-field

lineup: Sequence[Battlesuit]

raw_tier pydantic-field

raw_tier: int

score pydantic-field

score: int

Boss pydantic-model

Represents a Boss encountered in Abyss or Memorial Arena.

Fields:

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

Validators:

• __fix_url → icon

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

__fix_url pydantic-validator

__fix_url(url: str) -> str

Condition pydantic-model

Represents a debuff picked at the beginning of an Elysian Realms run.

Fields:

• name (str)
• description (str)
• difficulty (int)

description pydantic-field

description: str

difficulty pydantic-field

difficulty: int

name pydantic-field

name: str

ELF pydantic-model

Represents an ELF equipped for a battle.

Fields:

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

Validators:

• __fix_rank → rarity

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: str

upgrade_level pydantic-field

upgrade_level: int

__fix_rank pydantic-validator

__fix_rank(rarity: Union[int, str]) -> str

ElysianRealm pydantic-model

Represents one completed run of Elysean Realms.

Fields:

• completed_at (datetime)
• floors_cleared (int)
• score (int)
• difficulty (int)
• conditions (Sequence[Condition])
• signets (Sequence[Signet])
• leader (Battlesuit)
• supports (Sequence[Battlesuit])
• elf (Optional[ELF])
• remembrance_sigil (RemembranceSigil)

Validators:

• __extend_sigil → remembrance_sigil

completed_at pydantic-field

completed_at: datetime

conditions pydantic-field

conditions: Sequence[Condition]

difficulty pydantic-field

difficulty: int

elf pydantic-field

elf: Optional[ELF]

floors_cleared pydantic-field

floors_cleared: int

leader pydantic-field

leader: Battlesuit

lineup property

lineup: Sequence[Battlesuit]

remembrance_sigil pydantic-field

remembrance_sigil: RemembranceSigil

score pydantic-field

score: int

signets pydantic-field

signets: Sequence[Signet]

supports pydantic-field

supports: Sequence[Battlesuit]

__extend_sigil pydantic-validator

__extend_sigil(sigil: Any) -> Any

MemorialArena pydantic-model

Represents aggregate weekly performance for the entire Memorial Arena rotation.

Fields:

• score (int)
• ranking (float)
• raw_rank (int)
• raw_tier (int)
• end_time (datetime)
• battle_data (Sequence[MemorialBattle])

battle_data pydantic-field

battle_data: Sequence[MemorialBattle]

end_time pydantic-field

end_time: datetime

rank property

rank: str

The user's Memorial Arena rank as displayed in-game.

ranking pydantic-field

ranking: float

raw_rank pydantic-field

raw_rank: int

raw_tier pydantic-field

raw_tier: int

score pydantic-field

score: int

MemorialBattle pydantic-model

Represents weekly performance against a single Memorial Arena boss.

Fields:

• score (int)
• lineup (Sequence[Battlesuit])
• elf (Optional[ELF])
• boss (Boss)

boss pydantic-field

boss: Boss

elf pydantic-field

elf: Optional[ELF]

lineup pydantic-field

lineup: Sequence[Battlesuit]

score pydantic-field

score: int

OldAbyss pydantic-model

Represents once cycle of Quantum Singularis or Dirac Sea.

Exclusive to players of level 80 and below.

Fields:

• raw_tier (int)
• score (int)
• lineup (Sequence[Battlesuit])
• boss (Boss)
• elf (Optional[ELF])
• end_time (datetime)
• raw_type (str)
• result (str)
• raw_rank (int)

Validators:

• __normalize_level → raw_rank

end_time pydantic-field

end_time: datetime

raw_rank pydantic-field

raw_rank: int

raw_type pydantic-field

raw_type: str

result pydantic-field

result: str

__normalize_level pydantic-validator

__normalize_level(rank: str) -> int

RemembranceSigil pydantic-model

Represents a Remembrance Sigil from Elysian Realms.

Fields:

• icon (str)

icon pydantic-field

icon: str

id property

id: int

name property

name: str

rarity property

rarity: int

Signet pydantic-model

Represents a buff Signet picked in an Elysian Realms run.

Fields:

• id (int)
• icon (str)
• number (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

name property

name: str

number pydantic-field

number: int

get_scaled_icon

get_scaled_icon(scale: Literal[1, 2, 3] = 2) -> str

SuperstringAbyss pydantic-model

Represents one cycle of Superstring Abyss, exclusive to players of level 81 and up.

Fields:

• score (int)
• lineup (Sequence[Battlesuit])
• boss (Boss)
• elf (Optional[ELF])
• end_time (datetime)
• raw_tier (int)
• placement (int)
• trophies_gained (int)
• end_trophies (int)
• raw_start_rank (int)
• raw_end_rank (int)

end_time pydantic-field

end_time: datetime

end_trophies pydantic-field

end_trophies: int

placement pydantic-field

placement: int

raw_end_rank pydantic-field

raw_end_rank: int

raw_start_rank pydantic-field

raw_start_rank: int

raw_tier pydantic-field

raw_tier: int = 4

start_trophies property

start_trophies: int

trophies_gained pydantic-field

trophies_gained: int

get_abyss_rank_mi18n

get_abyss_rank_mi18n(rank: int, tier: int) -> str

Turn the rank returned by the API into the respective rank name displayed in-game.

prettify_MA_rank

prettify_MA_rank(rank: int) -> str

Turn the rank returned by the API into the respective rank name displayed in-game.