Module genshin.models.starrail.warp_records

Star Rail warp records statistics models.

Classes

class StarRailFiveStarWarp (**data: Any)
Expand source code 
class StarRailFiveStarWarp(APIModel, Unique):
    """A 5-star item obtained from a warp banner type."""

    id: int
    uuid: str
    item: StarRailWarpItem
    is_up: bool
    count: int = Aliased("gacha_count")
    """Amount of warps it took to obtain this item."""

A 5-star item obtained from a warp banner type.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var count : int

Amount of warps it took to obtain this item.

var id : int
var is_up : bool
var item : StarRailWarpItem
var model_config : pydantic.config.ConfigDict
var uuid : str
class StarRailFiveStarWarps (**data: Any)
Expand source code 
class StarRailFiveStarWarps(APIModel):
    """All 5-star items obtained from a warp banner type."""

    version_id: int
    pity: int
    """Amount of warps since the last 5-star item."""
    warps: typing.Sequence[StarRailFiveStarWarp]

All 5-star items obtained from a warp banner type.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var model_config : pydantic.config.ConfigDict
var pity : int

Amount of warps since the last 5-star item.

var version_id : int
var warps : Sequence[StarRailFiveStarWarp]
class StarRailWarpBrief (**data: Any)
Expand source code 
class StarRailWarpBrief(APIModel):
    """Overview of recently obtained 5-star items across all banners."""

    version_id: int
    items: typing.Sequence[StarRailWarpBriefItem]

Overview of recently obtained 5-star items across all banners.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var items : Sequence[StarRailWarpBriefItem]
var model_config : pydantic.config.ConfigDict
var version_id : int
class StarRailWarpBriefItem (**data: Any)
Expand source code 
class StarRailWarpBriefItem(APIModel):
    """Recently obtained 5-star item with its count."""

    item: StarRailWarpItem
    count: int

Recently obtained 5-star item with its count.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var count : int
var item : StarRailWarpItem
var model_config : pydantic.config.ConfigDict
class StarRailWarpItem (**data: Any)
Expand source code 
class StarRailWarpItem(APIModel, Unique):
    """Item obtained from a warp."""

    id: int = Aliased("item_id")
    name: str
    icon: str
    big_icon: str
    type: str = Aliased("item_type")
    rarity: int

Item obtained from a warp.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var big_icon : str
var icon : str
var id : int
var model_config : pydantic.config.ConfigDict
var name : str
var rarity : int
var type : str
class StarRailWarpPoolStat (**data: Any)
Expand source code 
class StarRailWarpPoolStat(APIModel):
    """Statistics of a single warp banner."""

    banner_id: int = Aliased("gacha_id")
    version: str
    name: str = Aliased("pool_name")
    total_count: int
    up_count: int
    up_item: typing.Optional[StarRailWarpItem] = None

Statistics of a single warp banner.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var banner_id : int
var model_config : pydantic.config.ConfigDict
var name : str
var total_count : int
var up_count : int
var up_item : StarRailWarpItem | None
var version : str