Star Rail Character Models

character

Starrail base character model.

Classes:

• BaseMemoSprite –

  HSR base memosprite.

• BaseRelic –

  HSR base relic.

• BaseSkill –

  HSR character/memosprite skill.

• DetailMemoSprite –

  HSR memosprite for detail character.

• DetailRelic –

  HSR character relic with properties.

• DetailRelicProperty –

  Relic property for detailed character.

• DetailSkill –

  HSR character/memosprite skill for detail character.

• FloorCharacter –

  Character in a floor.

• LineupMemoSprite –

  HSR lineup memosprite.

• LineupRelic –

  HSR lineup relic.

• PropertyInfo –

  Relic property info.

• Rank –

  HSR character eidolon.

• RelicProperty –

  HSR relic property.

• RogueCharacter –

  Rogue character model.

• SimpleRelic –

  HSR simple relic without properties.

• SkillStage –

  Character skill stage.

• StarRailBaseCharacter –

  Base character model.

• StarRailBaseEquipment –

  HSR character light cone.

• StarRailBaseProperty –

  HSR detail character endpoint base property (for memosprite.)

• StarRailCharacterProperty –

  HSR property for detailed character, with preferred and recommended flags.

• StarRailDetailCharacter –

  HSR character with detailed equipment and relics.

• StarRailEquipment –

  HSR character light cone.

• StarRailLineupCharacter –

  HSR lineup simulator character.

• StarRailLineupProperty –

  HSR character/memosprite property for lineup simulator.

• StarRailPartialCharacter –

  Character without any equipment.

• StarRailPath –

  StarRail character path.

• StarRailSimpleCharacter –

  HSR character with simplified data.

__all__ module-attribute

__all__ = ('BaseMemoSprite', 'BaseRelic', 'BaseSkill', 'DetailMemoSprite', 'DetailRelic', 'DetailRelicProperty', 'DetailSkill', 'FloorCharacter', 'LineupMemoSprite', 'LineupRelic', 'PropertyInfo', 'Rank', 'RelicProperty', 'RogueCharacter', 'SimpleRelic', 'SkillStage', 'StarRailBaseCharacter', 'StarRailBaseEquipment', 'StarRailBaseProperty', 'StarRailCharacterProperty', 'StarRailDetailCharacter', 'StarRailEquipment', 'StarRailLineupCharacter', 'StarRailLineupProperty', 'StarRailPartialCharacter', 'StarRailPath', 'StarRailSimpleCharacter')

BaseMemoSprite pydantic-model

HSR base memosprite.

Fields:

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

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

BaseRelic pydantic-model

HSR base relic.

Fields:

• id (int)
• pos (int)
• rarity (int)

id pydantic-field

id: int

pos pydantic-field

pos: int

rarity pydantic-field

rarity: int

BaseSkill pydantic-model

HSR character/memosprite skill.

Fields:

• point_id (str)
• point_type (int)
• item_url (str)
• level (int)
• is_activated (bool)
• is_rank_work (bool)
• pre_point (str)
• anchor (str)
• remake (str)

anchor pydantic-field

anchor: str

is_activated pydantic-field

is_activated: bool

is_rank_work pydantic-field

is_rank_work: bool

item_url pydantic-field

item_url: str

level pydantic-field

level: int

point_id pydantic-field

point_id: str

point_type pydantic-field

point_type: int

pre_point pydantic-field

pre_point: str

remake pydantic-field

remake: str

DetailMemoSprite pydantic-model

HSR memosprite for detail character.

Fields:

• id (int)
• name (str)
• icon (str)
• properties (Sequence[StarRailBaseProperty])
• skills (Sequence[DetailSkill])

properties pydantic-field

properties: Sequence[StarRailBaseProperty]

skills pydantic-field

skills: Sequence[DetailSkill]

DetailRelic pydantic-model

HSR character relic with properties.

Fields:

• id (int)
• pos (int)
• rarity (int)
• level (int)
• name (str)
• desc (str)
• icon (str)
• wiki (str)
• main_property (DetailRelicProperty)
• properties (Sequence[DetailRelicProperty])

main_property pydantic-field

main_property: DetailRelicProperty

properties pydantic-field

properties: Sequence[DetailRelicProperty]

wiki pydantic-field

wiki: str

DetailRelicProperty pydantic-model

Relic property for detailed character.

Fields:

• property_type (int)
• value (str)
• times (int)
• preferred (bool)
• recommended (bool)
• info (PropertyInfo)

info pydantic-field

info: PropertyInfo

preferred pydantic-field

preferred: bool

property_type pydantic-field

property_type: int

recommended pydantic-field

recommended: bool

times pydantic-field

times: int

value pydantic-field

value: str

DetailSkill pydantic-model

HSR character/memosprite skill for detail character.

Fields:

• point_id (str)
• point_type (int)
• item_url (str)
• level (int)
• is_activated (bool)
• is_rank_work (bool)
• pre_point (str)
• anchor (str)
• remake (str)
• skill_stages (Sequence[SkillStage])

skill_stages pydantic-field

skill_stages: Sequence[SkillStage]

FloorCharacter pydantic-model

Character in a floor.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• level (int)
• rank (int)

level pydantic-field

level: int

rank pydantic-field

rank: int

LineupMemoSprite pydantic-model

HSR lineup memosprite.

Fields:

• id (int)
• name (str)
• icon (str)
• properties (Sequence[StarRailLineupProperty])
• skills (Sequence[BaseSkill])

properties pydantic-field

properties: Sequence[StarRailLineupProperty]

skills pydantic-field

skills: Sequence[BaseSkill]

LineupRelic pydantic-model

HSR lineup relic.

Fields:

• id (int)
• pos (int)
• rarity (int)
• set_name (str)
• set_num (int)
• main_property (RelicProperty)
• properties (Sequence[RelicProperty])
• wiki (str)

main_property pydantic-field

main_property: RelicProperty

properties pydantic-field

properties: Sequence[RelicProperty]

set_name pydantic-field

set_name: str

set_num pydantic-field

set_num: int

wiki pydantic-field

wiki: str

PropertyInfo pydantic-model

Relic property info.

Fields:

• property_type (int)
• name (str)
• icon (str)
• property_name_relic (str)
• property_name_filter (str)

icon pydantic-field

icon: str

name pydantic-field

name: str

property_name_filter pydantic-field

property_name_filter: str

property_name_relic pydantic-field

property_name_relic: str

property_type pydantic-field

property_type: int

Rank pydantic-model

HSR character eidolon.

Fields:

• id (int)
• pos (int)
• name (str)
• icon (str)
• desc (str)
• is_unlocked (bool)

desc pydantic-field

desc: str

icon pydantic-field

icon: str

id pydantic-field

id: int

is_unlocked pydantic-field

is_unlocked: bool

name pydantic-field

name: str

pos pydantic-field

pos: int

RelicProperty pydantic-model

HSR relic property.

Fields:

• property_type (int)
• value (str)
• times (int)
• name (str)
• icon (str)

icon pydantic-field

icon: str

name pydantic-field

name: str

property_type pydantic-field

property_type: int

times pydantic-field

times: int

value pydantic-field

value: str

RogueCharacter pydantic-model

Rogue character model.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• level (int)
• rank (int)

level pydantic-field

level: int

rank pydantic-field

rank: int

SimpleRelic pydantic-model

HSR simple relic without properties.

Fields:

• id (int)
• pos (int)
• rarity (int)
• level (int)
• name (str)
• desc (str)
• icon (str)

desc pydantic-field

desc: str

icon pydantic-field

icon: str

level pydantic-field

level: int

name pydantic-field

name: str

SkillStage pydantic-model

Character skill stage.

Fields:

• name (str)
• desc (str)
• level (int)
• remake (str)
• item_url (str)
• is_activated (bool)
• is_rank_work (bool)

desc pydantic-field

desc: str

is_activated pydantic-field

is_activated: bool

is_rank_work pydantic-field

is_rank_work: bool

item_url pydantic-field

item_url: str

level pydantic-field

level: int

name pydantic-field

name: str

remake pydantic-field

remake: str

StarRailBaseCharacter pydantic-model

Base character model.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)

element pydantic-field

element: str

icon pydantic-field

icon: str

id pydantic-field

id: int

rarity pydantic-field

rarity: int

StarRailBaseEquipment pydantic-model

HSR character light cone.

Fields:

• id (int)
• level (int)
• rank (int)
• name (str)
• desc (str)
• icon (str)
• rarity (int)

desc pydantic-field

desc: str

icon pydantic-field

icon: str

id pydantic-field

id: int

level pydantic-field

level: int

name pydantic-field

name: str

rank pydantic-field

rank: int

rarity pydantic-field

rarity: int

StarRailBaseProperty pydantic-model

HSR detail character endpoint base property (for memosprite.)

Fields:

• property_type (int)
• info (PropertyInfo)
• base (str)
• add (str)
• final (str)

add pydantic-field

add: str

base pydantic-field

base: str

final pydantic-field

final: str

info pydantic-field

info: PropertyInfo

property_type pydantic-field

property_type: int

StarRailCharacterProperty pydantic-model

HSR property for detailed character, with preferred and recommended flags.

Fields:

• property_type (int)
• info (PropertyInfo)
• base (str)
• add (str)
• final (str)
• preferred (bool)
• recommended (bool)

preferred pydantic-field

preferred: bool

recommended pydantic-field

recommended: bool

StarRailDetailCharacter pydantic-model

HSR character with detailed equipment and relics.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• name (str)
• level (int)
• rank (int)
• image (str)
• equip (Optional[StarRailEquipment])
• ranks (Sequence[Rank])
• path (StarRailPath)
• figure_path (str)
• relics (Sequence[DetailRelic])
• ornaments (Sequence[DetailRelic])
• properties (Sequence[StarRailCharacterProperty])
• skills (Sequence[DetailSkill])
• memosprite (Optional[DetailMemoSprite])

Validators:

• __return_none → memosprite

memosprite pydantic-field

memosprite: Optional[DetailMemoSprite]

ornaments pydantic-field

ornaments: Sequence[DetailRelic]

properties pydantic-field

properties: Sequence[StarRailCharacterProperty]

relics pydantic-field

relics: Sequence[DetailRelic]

skills pydantic-field

skills: Sequence[DetailSkill]

__return_none pydantic-validator

__return_none(value: Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]

Return None if memosprite ID is 0.

StarRailEquipment pydantic-model

HSR character light cone.

Fields:

• id (int)
• level (int)
• rank (int)
• name (str)
• desc (str)
• icon (str)
• rarity (int)
• wiki (str)

wiki pydantic-field

wiki: str

StarRailLineupCharacter pydantic-model

HSR lineup simulator character.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• name (str)
• level (int)
• rank (int)
• equip (Optional[StarRailBaseEquipment])
• relics (Sequence[LineupRelic])
• ranks (Sequence[Rank])
• properties (Sequence[StarRailLineupProperty])
• skills (Sequence[BaseSkill])
• memosprite (Optional[LineupMemoSprite])
• path (StarRailPath)
• figure_path (str)

equip pydantic-field

equip: Optional[StarRailBaseEquipment]

figure_path pydantic-field

figure_path: str

memosprite pydantic-field

memosprite: Optional[LineupMemoSprite]

path pydantic-field

path: StarRailPath

properties pydantic-field

properties: Sequence[StarRailLineupProperty]

ranks pydantic-field

ranks: Sequence[Rank]

relics pydantic-field

relics: Sequence[LineupRelic]

skills pydantic-field

skills: Sequence[BaseSkill]

StarRailLineupProperty pydantic-model

HSR character/memosprite property for lineup simulator.

Fields:

• property_type (int)
• base (str)
• add (str)
• final (str)
• name (str)
• icon (str)
• base_float (float)
• add_float (float)
• final_float (float)

add pydantic-field

add: str

add_float pydantic-field

add_float: float

base pydantic-field

base: str

base_float pydantic-field

base_float: float

final pydantic-field

final: str

final_float pydantic-field

final_float: float

icon pydantic-field

icon: str

name pydantic-field

name: str

property_type pydantic-field

property_type: int

StarRailPartialCharacter pydantic-model

Character without any equipment.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• name (str)
• level (int)
• rank (int)

level pydantic-field

level: int

name pydantic-field

name: str

rank pydantic-field

rank: int

StarRailPath

StarRail character path.

Attributes:

• ABUNDANCE –
• DESTRUCTION –
• ELATION –
• ERUDITION –
• HARMONY –
• NIHILITY –
• PRESERVATION –
• REMEMBRANCE –
• THE_HUNT –

ABUNDANCE class-attribute instance-attribute

ABUNDANCE = 7

DESTRUCTION class-attribute instance-attribute

DESTRUCTION = 1

ELATION class-attribute instance-attribute

ELATION = 9

ERUDITION class-attribute instance-attribute

ERUDITION = 3

HARMONY class-attribute instance-attribute

HARMONY = 4

NIHILITY class-attribute instance-attribute

NIHILITY = 5

PRESERVATION class-attribute instance-attribute

PRESERVATION = 6

REMEMBRANCE class-attribute instance-attribute

REMEMBRANCE = 8

THE_HUNT class-attribute instance-attribute

THE_HUNT = 2

StarRailSimpleCharacter pydantic-model

HSR character with simplified data.

Relics and ornaments have no properties, no skills, properties, and memosprite. This happens when the character is viewed by other players.

Fields:

• id (int)
• element (str)
• rarity (int)
• icon (str)
• name (str)
• level (int)
• rank (int)
• image (str)
• equip (Optional[StarRailEquipment])
• relics (Sequence[SimpleRelic])
• ornaments (Sequence[SimpleRelic])
• ranks (Sequence[Rank])
• path (StarRailPath)
• figure_path (str)

equip pydantic-field

equip: Optional[StarRailEquipment]

figure_path pydantic-field

figure_path: str

image pydantic-field

image: str

is_wearing_outfit property

is_wearing_outfit: bool

Whether the character is wearing an outfit.

ornaments pydantic-field

ornaments: Sequence[SimpleRelic]

path pydantic-field

path: StarRailPath

ranks pydantic-field

ranks: Sequence[Rank]

relics pydantic-field

relics: Sequence[SimpleRelic]