Star Rail RPG Simulator Models

rpgsimulator

HSR Lineup Simulator.

Classes:

• APCShadowLineup –

  A Apocalyptic Shadow lineup.

• APCShadowLineupResponse –

  Response for Apocalyptic Shadow lineups.

• APCShadowSchedule –

  Apocalyptic Shadow schedule.

• LineupDetail –

  Detail for a lineup.

• MOCSchedule –

  Memory of Chaos schedule.

• PureFictionLineup –

  A Pure Fiction lineup.

• PureFictionLineupResponse –

  Response for Pure Fiction lineups.

• PureFictionSchedule –

  Pure Future schedule.

• StarRailGameMode –

  HSR game mode, like MOC.

• StarRailGameModeBuff –

  HSR game mode buff.

• StarRailGameModeFloor –

  A floor of a game mode, like MOC Stage 1.

• StarRailGameModeSchedule –

  Base HSR lineup game mode schedule.

• StarRailGameModeType –

  HSR lineup game mode enum.

• StarRailLineup –

  A HSR lineup.

• StarRailLineupPlayer –

  A HSR lineup player.

• StarRailLineupResponse –

  Response for HSR lineups.

__all__ module-attribute

__all__ = ('APCShadowLineup', 'APCShadowLineupResponse', 'APCShadowSchedule', 'LineupDetail', 'MOCSchedule', 'PureFictionLineup', 'PureFictionLineupResponse', 'PureFictionSchedule', 'StarRailGameMode', 'StarRailGameModeBuff', 'StarRailGameModeFloor', 'StarRailGameModeSchedule', 'StarRailGameModeType', 'StarRailLineup', 'StarRailLineupPlayer', 'StarRailLineupResponse')

APCShadowLineup pydantic-model

A Apocalyptic Shadow lineup.

Fields:

• id (str)
• player (StarRailLineupPlayer)
• type (StarRailGameModeType)
• title (str)
• description (str)
• likes (int)
• comments (int)
• favorites (int)
• views (int)
• created_at (datetime)
• last_edited_at (datetime)
• stars (int)
• cycles_taken (int)
• characters (Sequence[Sequence[StarRailLineupCharacter]])
• detail (LineupDetail)
• node1_challenged_at (DateTime)
• node2_challenged_at (DateTime)

Validators:

• __unnest_characters → characters
• __nest_player

detail pydantic-field

detail: LineupDetail

node1_challenged_at pydantic-field

node1_challenged_at: DateTime

node2_challenged_at pydantic-field

node2_challenged_at: DateTime

APCShadowLineupResponse pydantic-model

Response for Apocalyptic Shadow lineups.

Fields:

• lineups (Sequence[APCShadowLineup])
• next_page_token (str)

lineups pydantic-field

lineups: Sequence[APCShadowLineup]

next_page_token pydantic-field

next_page_token: str

APCShadowSchedule pydantic-model

Apocalyptic Shadow schedule.

Fields:

• id (int)
• name (str)
• start_time (datetime)
• end_time (datetime)
• is_now (bool)
• is_show (bool)
• floor_nums (int)
• buff (StarRailGameModeBuff)
• node1_buffs (Sequence[StarRailGameModeBuff])
• node2_buffs (Sequence[StarRailGameModeBuff])

Validators:

• __convert_buffs

buff pydantic-field

buff: StarRailGameModeBuff

node1_buffs pydantic-field

node1_buffs: Sequence[StarRailGameModeBuff]

node2_buffs pydantic-field

node2_buffs: Sequence[StarRailGameModeBuff]

__convert_buffs pydantic-validator

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

LineupDetail pydantic-model

Detail for a lineup.

Fields:

• buffs (Sequence[StarRailGameModeBuff])
• points (int)

buffs pydantic-field

buffs: Sequence[StarRailGameModeBuff]

points pydantic-field

points: int

MOCSchedule pydantic-model

Memory of Chaos schedule.

Fields:

• id (int)
• name (str)
• start_time (datetime)
• end_time (datetime)
• is_now (bool)
• is_show (bool)
• floor_nums (int)
• buff (StarRailGameModeBuff)

Validators:

• __convert_buffs

buff pydantic-field

buff: StarRailGameModeBuff

__convert_buffs pydantic-validator

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

PureFictionLineup pydantic-model

A Pure Fiction lineup.

Fields:

• id (str)
• player (StarRailLineupPlayer)
• type (StarRailGameModeType)
• title (str)
• description (str)
• likes (int)
• comments (int)
• favorites (int)
• views (int)
• created_at (datetime)
• last_edited_at (datetime)
• stars (int)
• cycles_taken (int)
• characters (Sequence[Sequence[StarRailLineupCharacter]])
• detail (LineupDetail)
• node1_challenged_at (DateTime)
• node2_challenged_at (DateTime)

Validators:

• __unnest_characters → characters
• __nest_player

detail pydantic-field

detail: LineupDetail

node1_challenged_at pydantic-field

node1_challenged_at: DateTime

node2_challenged_at pydantic-field

node2_challenged_at: DateTime

PureFictionLineupResponse pydantic-model

Response for Pure Fiction lineups.

Fields:

• lineups (Sequence[PureFictionLineup])
• next_page_token (str)

lineups pydantic-field

lineups: Sequence[PureFictionLineup]

next_page_token pydantic-field

next_page_token: str

PureFictionSchedule pydantic-model

Pure Future schedule.

Fields:

• id (int)
• name (str)
• start_time (datetime)
• end_time (datetime)
• is_now (bool)
• is_show (bool)
• floor_nums (int)
• buffs (Sequence[StarRailGameModeBuff])
• default_buffs (Sequence[StarRailGameModeBuff])

buffs pydantic-field

buffs: Sequence[StarRailGameModeBuff]

default_buffs pydantic-field

default_buffs: Sequence[StarRailGameModeBuff]

StarRailGameMode pydantic-model

HSR game mode, like MOC.

Fields:

• id (int)
• name (str)
• floors (Sequence[StarRailGameModeFloor])
• type (StarRailGameModeType)

Validators:

• __unnest_children

floors pydantic-field

floors: Sequence[StarRailGameModeFloor]

id pydantic-field

id: int

name pydantic-field

name: str

type pydantic-field

type: StarRailGameModeType

__unnest_children pydantic-validator

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

Unnest the children field.

StarRailGameModeBuff pydantic-model

HSR game mode buff.

Fields:

• name (str)
• desc (str)
• icon (Optional[str])
• simple_desc (Optional[str])

desc pydantic-field

desc: str

icon pydantic-field

icon: Optional[str] = None

name pydantic-field

name: str

simple_desc pydantic-field

simple_desc: Optional[str] = None

StarRailGameModeFloor pydantic-model

A floor of a game mode, like MOC Stage 1.

Fields:

• id (int)
• name (str)
• floor (int)

Validators:

• __extract_floor

floor pydantic-field

floor: int

id pydantic-field

id: int

name pydantic-field

name: str

__extract_floor pydantic-validator

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

StarRailGameModeSchedule pydantic-model

Base HSR lineup game mode schedule.

Fields:

• id (int)
• name (str)
• start_time (datetime)
• end_time (datetime)
• is_now (bool)
• is_show (bool)
• floor_nums (int)

end_time pydantic-field

end_time: datetime

floor_nums pydantic-field

floor_nums: int

id pydantic-field

id: int

is_now pydantic-field

is_now: bool

is_show pydantic-field

is_show: bool

name pydantic-field

name: str

start_time pydantic-field

start_time: datetime

StarRailGameModeType

HSR lineup game mode enum.

Attributes:

• ANOMALY_ARBITRATION –

  Anomaly Arbitration.

• APC_SHADOW –

  Apocalyptic Shadow.

• MOC –

  Memory of Chaos.

• PURE_FICTION –

  Pure Fiction.

ANOMALY_ARBITRATION class-attribute instance-attribute

ANOMALY_ARBITRATION = 'Peak'

Anomaly Arbitration.

APC_SHADOW class-attribute instance-attribute

APC_SHADOW = 'Boss'

Apocalyptic Shadow.

MOC class-attribute instance-attribute

MOC = 'Chasm'

Memory of Chaos.

PURE_FICTION class-attribute instance-attribute

PURE_FICTION = 'Story'

Pure Fiction.

StarRailLineup pydantic-model

A HSR lineup.

Fields:

• id (str)
• player (StarRailLineupPlayer)
• type (StarRailGameModeType)
• title (str)
• description (str)
• likes (int)
• comments (int)
• favorites (int)
• views (int)
• created_at (datetime)
• last_edited_at (datetime)
• stars (int)
• cycles_taken (int)
• characters (Sequence[Sequence[StarRailLineupCharacter]])

Validators:

• __unnest_characters → characters
• __nest_player

characters pydantic-field

characters: Sequence[Sequence[StarRailLineupCharacter]]

comments pydantic-field

comments: int

created_at pydantic-field

created_at: datetime

cycles_taken pydantic-field

cycles_taken: int

description pydantic-field

description: str

favorites pydantic-field

favorites: int

id pydantic-field

id: str

last_edited_at pydantic-field

last_edited_at: datetime

likes pydantic-field

likes: int

player pydantic-field

player: StarRailLineupPlayer

stars pydantic-field

stars: int

title pydantic-field

title: str

type pydantic-field

type: StarRailGameModeType

views pydantic-field

views: int

__nest_player pydantic-validator

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

Nest the player field.

__unnest_characters pydantic-validator

__unnest_characters(v: Sequence[dict[str, Any]]) -> Sequence[Sequence[dict[str, Any]]]

StarRailLineupPlayer pydantic-model

A HSR lineup player.

Fields:

• uid (str)
• nickname (str)
• avatar_url (str)
• level (int)

avatar_url pydantic-field

avatar_url: str

level pydantic-field

level: int

nickname pydantic-field

nickname: str

uid pydantic-field

uid: str

StarRailLineupResponse pydantic-model

Response for HSR lineups.

Fields:

• lineups (Sequence[StarRailLineup])
• next_page_token (str)

lineups pydantic-field

lineups: Sequence[StarRailLineup]

next_page_token pydantic-field

next_page_token: str