Source code for tibiapy.models.creature

"""Models for creatures."""
from typing import Optional

from pydantic import computed_field

from tibiapy.models import BaseModel
from tibiapy.urls import get_creature_url




class BossEntry(BaseModel):
    """Represents a boss in the boostable bosses section in the Tibia.com library."""

    name: str
    """The name of the boss."""
    identifier: str
    """The internal name of the boss. Used for images."""

    @computed_field
    @property
    def image_url(self) -> str:
        """The URL to this boss's image."""
        return f"https://static.tibia.com/images/library/{self.identifier}.gif"





class BoostableBosses(BaseModel):
    """Represents the boostable bosses section in the Tibia.com library."""

    boosted_boss: BossEntry
    """The current boosted boss."""
    bosses: list[BossEntry]
    """The list of boostable bosses."""





class CreatureEntry(BaseModel):
    """Represents a creature in the Library section."""

    name: str
    """The name of the creature, usually in plural, except for the boosted creature."""
    identifier: str
    """The internal name of the creature's race. Used for links and images."""

    @property
    def url(self) -> str:
        """The URL to this creature's details."""
        return get_creature_url(self.identifier)

    @computed_field
    @property
    def image_url(self) -> str:
        """The URL to this creature's image."""
        return f"https://static.tibia.com/images/library/{self.identifier}.gif"





class Creature(CreatureEntry):
    """Represents a creature's details on the Tibia.com library."""

    name: str
    """The name of the creature, in plural form."""
    identifier: str
    """The race's internal name. Used for links and images."""
    description: str
    """A description of the creature."""
    hitpoints: int
    """The number of hitpoints the creature has."""
    experience: int
    """The number of experience points given for killing this creature."""
    immune_to: list[str]
    """The elements this creature is immune to."""
    weak_against: list[str]
    """The elements this creature is weak against."""
    strong_against: list[str]
    """The elements this creature is strong against."""
    loot: str
    """Some of the items this creature drops."""
    mana_cost: Optional[int]
    """The mana neccessary to summon or convince this creature."""
    summonable: bool
    """Whether this creature can be summoned or not."""
    convinceable: bool
    """Whether this creature can be convinced or not."""





class CreaturesSection(BaseModel):
    """Represents the creature's section in the Tibia.com library."""

    boosted_creature: CreatureEntry
    """The current boosted creature."""
    creatures: list[CreatureEntry]
    """The list of creatures in the library."""





class BoostedCreatures(BaseModel):
    """Contains both boosted creature and boosted boss."""

    creature: CreatureEntry
    """The boosted creature of the day."""
    boss: BossEntry
    """The boosted boss of the day."""