Star Rail Events Models

events

Classes:

• ChallengeStatus –

  Challenge status enum.

• ChallengeType –

  Challenge type enum.

• EventWarp –

  Event warp model.

• EventWarpCharacter –

  Event warp character model.

• EventWarpLightCone –

  Event warp light cone model.

• HSRBaseEventItem –

  Base event item model.

• HSRChallenge –

  HSR challenge model.

• HSREvent –

  HSR event model.

• HSREventCalendar –

  HSR event calendar model.

• HSREventReward –

  HSR event reward model.

• HSREventStatus –

  Event status enum.

• HSREventTimeType –

  Event time type enum.

• HSREventType –

  Event type enum.

• TimeInfo –

  Time info model.

__all__ module-attribute

__all__ = ('ChallengeStatus', 'ChallengeType', 'EventWarp', 'EventWarpCharacter', 'EventWarpLightCone', 'HSRBaseEventItem', 'HSRChallenge', 'HSREvent', 'HSREventCalendar', 'HSREventReward', 'HSREventStatus', 'HSREventTimeType', 'HSREventType', 'TimeInfo')

ChallengeStatus

Challenge status enum.

Attributes:

• FINISHED –
• IN_PROGRESS –
• LOCKED –

FINISHED class-attribute instance-attribute

FINISHED = 'challengeStatusFinish'

IN_PROGRESS class-attribute instance-attribute

IN_PROGRESS = 'challengeStatusInProgress'

LOCKED class-attribute instance-attribute

LOCKED = 'challengeStatusUnopened'

ChallengeType

Challenge type enum.

Attributes:

• ANOMALY_ARBITRATION –
• APC_SHADOW –

  Apocalyptic shadow.

• MOC –

  Memory of Chaos.

• PURE_FICTION –

ANOMALY_ARBITRATION class-attribute instance-attribute

ANOMALY_ARBITRATION = 'ChallengeTypePeak'

APC_SHADOW class-attribute instance-attribute

APC_SHADOW = 'ChallengeTypeBoss'

Apocalyptic shadow.

MOC class-attribute instance-attribute

MOC = 'ChallengeTypeChasm'

Memory of Chaos.

PURE_FICTION class-attribute instance-attribute

PURE_FICTION = 'ChallengeTypeStory'

EventWarp pydantic-model

Event warp model.

Fields:

• time_info (Optional[TimeInfo])
• name (str)
• type (str)
• characters (Sequence[EventWarpCharacter])
• light_cones (Sequence[EventWarpLightCone])
• is_after_version (bool)
• version (str)
• id (int)

Validators:

• __validate_time_info → time_info

characters pydantic-field

characters: Sequence[EventWarpCharacter]

id pydantic-field

id: int

is_after_version pydantic-field

is_after_version: bool

Whether the event happens after last version's update.

light_cones pydantic-field

light_cones: Sequence[EventWarpLightCone]

name pydantic-field

name: str

type pydantic-field

type: str

version pydantic-field

version: str

EventWarpCharacter pydantic-model

Event warp character model.

Fields:

• id (int)
• name (str)
• path (int)
• rarity (int)
• wiki_url (str)
• is_forward (bool)
• icon (str)
• large_icon (str)
• element (int)

element pydantic-field

element: int

icon pydantic-field

icon: str

large_icon pydantic-field

large_icon: str

EventWarpLightCone pydantic-model

Event warp light cone model.

Fields:

• id (int)
• name (str)
• path (int)
• rarity (int)
• wiki_url (str)
• is_forward (bool)
• icon (str)

icon pydantic-field

icon: str

HSRBaseEvent pydantic-model

HSR base event model.

Fields:

• time_info (Optional[TimeInfo])

Validators:

• __validate_time_info → time_info

time_info pydantic-field

time_info: Optional[TimeInfo] = None

__validate_time_info pydantic-validator

__validate_time_info(v: dict[str, Any]) -> Optional[dict[str, Any]]

HSRBaseEventItem pydantic-model

Base event item model.

Fields:

• id (int)
• name (str)
• icon (str)
• path (int)
• rarity (int)
• wiki_url (str)
• is_forward (bool)

icon pydantic-field

icon: str

id pydantic-field

id: int

is_forward pydantic-field

is_forward: bool

name pydantic-field

name: str

path pydantic-field

path: int

rarity pydantic-field

rarity: int

wiki_url pydantic-field

wiki_url: str

HSRChallenge pydantic-model

HSR challenge model.

Fields:

• time_info (Optional[TimeInfo])
• id (int)
• name (str)
• type (Union[ChallengeType, str])
• status (Union[ChallengeStatus, str])
• rewards (Sequence[HSREventReward])
• special_reward (Optional[HSREventReward])
• total_progress (int)
• current_progress (int)
• show_text (str)

Validators:

• __validate_time_info → time_info
• __validate_special_reward → special_reward
• __validate_type → type
• __validate_status → status

current_progress pydantic-field

current_progress: int

id pydantic-field

id: int

name pydantic-field

name: str

rewards pydantic-field

rewards: Sequence[HSREventReward]

show_text pydantic-field

show_text: str

special_reward pydantic-field

special_reward: Optional[HSREventReward]

status pydantic-field

status: Union[ChallengeStatus, str]

total_progress pydantic-field

total_progress: int

type pydantic-field

type: Union[ChallengeType, str]

__validate_special_reward pydantic-validator

__validate_special_reward(v: Optional[HSREventReward]) -> Optional[HSREventReward]

__validate_status pydantic-validator

__validate_status(v: str) -> Union[ChallengeStatus, str]

__validate_type pydantic-validator

__validate_type(v: str) -> Union[ChallengeType, str]

HSREvent pydantic-model

HSR event model.

Fields:

• time_info (Optional[TimeInfo])
• id (int)
• version (str)
• name (str)
• description (str)
• type (Union[HSREventType, str])
• time_type (Union[HSREventTimeType, str])
• status (Union[HSREventStatus, str])
• rewards (Sequence[HSREventReward])
• total_progress (int)
• current_progress (int)
• special_reward (Optional[HSREventReward])
• is_after_version (bool)
• all_finished (bool)
• show_text (str)
• strategy (str)
• multiple_drop_type (int)
• multiple_drop_type_list (list[int])
• count_refresh_type (int)
• count_value (int)
• drop_multiple (int)
• panel_id (int)
• sort_weight (int)

Validators:

• __validate_time_info → time_info
• __validate_special_reward → special_reward
• __validate_type → type
• __validate_time_type → time_type
• __validate_status → status
• __format_name → name
• __format_description → description

all_finished pydantic-field

all_finished: bool

count_refresh_type pydantic-field

count_refresh_type: int

count_value pydantic-field

count_value: int

current_progress pydantic-field

current_progress: int

description pydantic-field

description: str

drop_multiple pydantic-field

drop_multiple: int

id pydantic-field

id: int

is_after_version pydantic-field

is_after_version: bool

Whether the event happens after last version's update.

multiple_drop_type pydantic-field

multiple_drop_type: int

multiple_drop_type_list pydantic-field

multiple_drop_type_list: list[int]

name pydantic-field

name: str

panel_id pydantic-field

panel_id: int

rewards pydantic-field

rewards: Sequence[HSREventReward]

show_text pydantic-field

show_text: str

sort_weight pydantic-field

sort_weight: int

special_reward pydantic-field

special_reward: Optional[HSREventReward]

status pydantic-field

status: Union[HSREventStatus, str]

strategy pydantic-field

strategy: str

time_type pydantic-field

time_type: Union[HSREventTimeType, str]

total_progress pydantic-field

total_progress: int

type pydantic-field

type: Union[HSREventType, str]

version pydantic-field

version: str

__format_description pydantic-validator

__format_description(v: str) -> str

__format_name pydantic-validator

__format_name(v: str) -> str

__validate_special_reward pydantic-validator

__validate_special_reward(v: HSREventReward) -> Optional[HSREventReward]

__validate_status pydantic-validator

__validate_status(v: str) -> Union[HSREventStatus, str]

__validate_time_type pydantic-validator

__validate_time_type(v: str) -> Union[HSREventTimeType, str]

__validate_type pydantic-validator

__validate_type(v: str) -> Union[HSREventType, str]

HSREventCalendar pydantic-model

HSR event calendar model.

Fields:

• character_warps (Sequence[EventWarp])
• light_cone_warps (Sequence[EventWarp])
• events (Sequence[HSREvent])
• challenges (Sequence[HSRChallenge])
• cur_game_version (str)
• now (TZDateTime)

challenges pydantic-field

challenges: Sequence[HSRChallenge]

character_warps pydantic-field

character_warps: Sequence[EventWarp]

cur_game_version pydantic-field

cur_game_version: str

Current game version.

events pydantic-field

events: Sequence[HSREvent]

light_cone_warps pydantic-field

light_cone_warps: Sequence[EventWarp]

now pydantic-field

now: TZDateTime

HSREventReward pydantic-model

HSR event reward model.

Fields:

• id (int)
• name (str)
• icon (str)
• wiki_url (str)
• num (int)
• rarity (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

num pydantic-field

num: int

rarity pydantic-field

rarity: int

wiki_url pydantic-field

wiki_url: str

HSREventStatus

Event status enum.

Attributes:

• DOUBLE_REWARDS_LOCKED –
• DOUBLE_REWARD_ACT_STATUS_PROGRESS –
• DOUBLE_REWARD_ACT_STATUS_UNOPENED –
• OTHER_ACT_STATUS_FINISH –
• OTHER_IN_PROGRESS –
• OTHER_LOCKED –
• SIGN_IN_UNCLAIMED –
• SIGN_STATUS_FINISH –
• SIGN_STATUS_SIGNED_TODAY –
• SIGN_STATUS_UNCLAIMED –
• SIGN_STATUS_UNSIGNED_TODAY –

DOUBLE_REWARDS_LOCKED class-attribute instance-attribute

DOUBLE_REWARDS_LOCKED = 'DoubleActStatusUnopened'

DOUBLE_REWARD_ACT_STATUS_PROGRESS class-attribute instance-attribute

DOUBLE_REWARD_ACT_STATUS_PROGRESS = 'DoubleRewardActStatusProgress'

DOUBLE_REWARD_ACT_STATUS_UNOPENED class-attribute instance-attribute

DOUBLE_REWARD_ACT_STATUS_UNOPENED = 'DoubleRewardActStatusUnopened'

OTHER_ACT_STATUS_FINISH class-attribute instance-attribute

OTHER_ACT_STATUS_FINISH = 'OtherActStatusFinish'

OTHER_IN_PROGRESS class-attribute instance-attribute

OTHER_IN_PROGRESS = 'OtherActStatusUnFinish'

OTHER_LOCKED class-attribute instance-attribute

OTHER_LOCKED = 'OtherActStatusUnopened'

SIGN_IN_UNCLAIMED class-attribute instance-attribute

SIGN_IN_UNCLAIMED = 'SignActStatusUnclaimed'

SIGN_STATUS_FINISH class-attribute instance-attribute

SIGN_STATUS_FINISH = 'SignStatusFinish'

SIGN_STATUS_SIGNED_TODAY class-attribute instance-attribute

SIGN_STATUS_SIGNED_TODAY = 'SignStatusSignedToday'

SIGN_STATUS_UNCLAIMED class-attribute instance-attribute

SIGN_STATUS_UNCLAIMED = 'SignStatusUnclaimed'

SIGN_STATUS_UNSIGNED_TODAY class-attribute instance-attribute

SIGN_STATUS_UNSIGNED_TODAY = 'SignStatusUnSignedToday'

HSREventTimeType

Event time type enum.

Attributes:

• DEFAULT –
• LONG –

  Simulated universe.

DEFAULT class-attribute instance-attribute

DEFAULT = 'ActTimeTypeDefault'

LONG class-attribute instance-attribute

LONG = 'ActTimeTypeLong'

Simulated universe.

HSREventType

Event type enum.

Attributes:

• DOUBLE_REWARDS –

  Plannar Fissure, Garden of Plenty, etc.

• OTHER –
• SIGN_IN –

  Daily sign-in event.

DOUBLE_REWARDS class-attribute instance-attribute

DOUBLE_REWARDS = 'ActivityTypeDouble'

Plannar Fissure, Garden of Plenty, etc.

OTHER class-attribute instance-attribute

OTHER = 'ActivityTypeOther'

SIGN_IN class-attribute instance-attribute

SIGN_IN = 'ActivityTypeSign'

Daily sign-in event.

TimeInfo pydantic-model

Time info model.

Fields:

• start (TZDateTime)
• end (TZDateTime)
• now (TZDateTime)

end pydantic-field

end: TZDateTime

now pydantic-field

now: TZDateTime

start pydantic-field

start: TZDateTime