Skip to content

API Reference

GIElement

Bases: StrEnum

Represent a Genshin Impact element.

Source code in hakushin/enums.py 
43
44
45
46
47
48
49
50
51
52
class GIElement(StrEnum):
    """Represent a Genshin Impact element."""

    HYDRO = "Hydro"
    PYRO = "Pyro"
    CRYO = "Cryo"
    ELECTRO = "Electro"
    ANEMO = "Anemo"
    GEO = "Geo"
    DENDRO = "Dendro"

Game

Bases: StrEnum

Represent games supported by the Hakushin API.

Source code in hakushin/enums.py 
19
20
21
22
23
24
25
26
27
class Game(StrEnum):
    """Represent games supported by the Hakushin API."""

    GI = "gi"
    """Genshin Impact."""
    HSR = "hsr"
    """Honkai: Star Rail."""
    ZZZ = "zzz"
    """Zenless Zone Zero."""

GI = 'gi' class-attribute instance-attribute

Genshin Impact.

HSR = 'hsr' class-attribute instance-attribute

Honkai: Star Rail.

ZZZ = 'zzz' class-attribute instance-attribute

Zenless Zone Zero.

HSRElement

Bases: StrEnum

Represent an HSR element.

Source code in hakushin/enums.py 
55
56
57
58
59
60
61
62
63
64
class HSRElement(StrEnum):
    """Represent an HSR element."""

    ICE = "Ice"
    FIRE = "Fire"
    THUNDER = "Thunder"
    WIND = "Wind"
    PHYSICAL = "Physical"
    QUANTUM = "Quantum"
    IMAGINARY = "Imaginary"

HSREndgameType

Bases: StrEnum

Represent an HSR endgame.

Source code in hakushin/enums.py 
80
81
82
83
84
85
class HSREndgameType(StrEnum):
    """Represent an HSR endgame."""

    MEMORY_OF_CHAOS = "maze"
    PURE_FICTION = "story"
    APOCALYPTIC_SHADOW = "boss"

HSRPath

Bases: StrEnum

Represent an HSR character path.

Source code in hakushin/enums.py 
67
68
69
70
71
72
73
74
75
76
77
class HSRPath(StrEnum):
    """Represent an HSR character path."""

    PRESERVATION = "Knight"
    THE_HUNT = "Rogue"
    DESTRUCTION = "Warrior"
    ERUDITION = "Mage"
    HARMONY = "Shaman"
    NIHILITY = "Warlock"
    ABUNDANCE = "Priest"
    REMEMBRANCE = "Memory"

Language

Bases: StrEnum

Represent languages supported by the Hakushin API.

Source code in hakushin/enums.py 
30
31
32
33
34
35
36
37
38
39
40
class Language(StrEnum):
    """Represent languages supported by the Hakushin API."""

    EN = "en"
    """English."""
    ZH = "zh"
    """Simple Chinese."""
    KO = "ko"
    """Korean."""
    JA = "ja"
    """Japanese."""

EN = 'en' class-attribute instance-attribute

English.

JA = 'ja' class-attribute instance-attribute

Japanese.

KO = 'ko' class-attribute instance-attribute

Korean.

ZH = 'zh' class-attribute instance-attribute

Simple Chinese.

ZZZAttackType

Bases: IntEnum

Represent a ZZZ character attack type.

Source code in hakushin/enums.py 
109
110
111
112
113
114
class ZZZAttackType(IntEnum):
    """Represent a ZZZ character attack type."""

    SLASH = 101
    STRIKE = 102
    PIERCE = 103

ZZZElement

Bases: IntEnum

Represent a ZZZ character element.

Source code in hakushin/enums.py 
 99
100
101
102
103
104
105
106
class ZZZElement(IntEnum):
    """Represent a ZZZ character element."""

    PHYSICAL = 200
    FIRE = 201
    ICE = 202
    ELECTRIC = 203
    ETHER = 205

ZZZSkillType

Bases: StrEnum

Represent a ZZZ character skill type.

Source code in hakushin/enums.py 
117
118
119
120
121
122
123
124
class ZZZSkillType(StrEnum):
    """Represent a ZZZ character skill type."""

    BASIC = "Basic"
    DODGE = "Dodge"
    SPECIAL = "Special"
    CHAIN = "Chain"
    ASSIST = "Assist"

ZZZSpecialty

Bases: IntEnum

Represent a ZZZ character specialty.

Source code in hakushin/enums.py 
88
89
90
91
92
93
94
95
96
class ZZZSpecialty(IntEnum):
    """Represent a ZZZ character specialty."""

    ATTACK = 1
    STUN = 2
    ANOMALY = 3
    SUPPORT = 4
    DEFENSE = 5
    RUPTURE = 6