Source code for tibiapy.models.kill_statistics

"""Models related to the Kill Statistics."""
from tibiapy.models import BaseModel
from tibiapy.urls import get_kill_statistics_url




class RaceEntry(BaseModel):
    """Represents the statistics of a race."""

    last_day_killed: int
    """Number of creatures of this race killed in the last day."""
    last_day_players_killed: int
    """Number of players killed by this race in the last day."""
    last_week_killed: int
    """Number of creatures of this race killed in the last week."""
    last_week_players_killed: int
    """Number of players killed by this race in the last week."""





class KillStatistics(BaseModel):
    """Represents the kill statistics of a world."""

    world: str
    """The world the statistics belong to."""
    entries: dict[str, RaceEntry]
    """A dictionary of kills entries of every race, where the key is the name of the race."""
    total: RaceEntry
    """The kill statistics totals."""
    available_worlds: list[str]
    """The list of worlds available for selection."""

    @property
    def url(self) -> str:
        """The URL to the kill statistics page on Tibia.com containing the results."""
        return get_kill_statistics_url(self.world)

    @property
    def players(self) -> RaceEntry:
        """The kill statistics for players."""
        return self.entries.get("players", RaceEntry(last_week_players_killed=0, last_week_killed=0,
                                                     last_day_players_killed=0, last_day_killed=0))