seerapi-models 1.0.0__py3-none-any.whl

seerapi_models/items/__init__.py

@@ -0,0 +1,82 @@
+from ._common import Item, ItemCategory, ItemCategoryORM, ItemORM
+from .enegry_bead import EnergyBead, EnergyBeadBuffAttrORM, EnergyBeadORM
+from .equip import (
+    Equip,
+    EquipBonus,
+    EquipBonusAttrORM,
+    EquipBonusORM,
+    EquipEffectiveOccasion,
+    EquipEffectiveOccasionORM,
+    EquipORM,
+    EquipType,
+    EquipTypeORM,
+    Suit,
+    SuitBonus,
+    SuitBonusAttrORM,
+    SuitBonusORM,
+    SuitORM,
+)
+from .mintmark_gem import (
+    Gem,
+    GemCategory,
+    GemCategoryORM,
+    GemGen1,
+    GemGen1PartORM,
+    GemGen2,
+    GemGen2PartORM,
+    GemGenCategory,
+    GemGenCategoryORM,
+    GemORM,
+)
+from .skill_activation_item import SkillActivationItem, SkillActivationItemORM
+from .skill_stone import (
+    SkillStone,
+    SkillStoneCategory,
+    SkillStoneCategoryORM,
+    SkillStoneEffect,
+    SkillStoneEffectORM,
+    SkillStoneORM,
+)
+
+__all__ = [
+    'EnergyBead',
+    'EnergyBeadBuffAttrORM',
+    'EnergyBeadORM',
+    'Equip',
+    'EquipBonus',
+    'EquipBonusAttrORM',
+    'EquipBonusORM',
+    'EquipEffectiveOccasion',
+    'EquipEffectiveOccasionORM',
+    'EquipORM',
+    'EquipType',
+    'EquipTypeORM',
+    'Gem',
+    'GemCategory',
+    'GemCategoryORM',
+    'GemGen1',
+    'GemGen1PartORM',
+    'GemGen2',
+    'GemGen2PartORM',
+    'GemGenCategory',
+    'GemGenCategoryORM',
+    'GemORM',
+    'GemORM',
+    'Item',
+    'ItemCategory',
+    'ItemCategoryORM',
+    'ItemORM',
+    'SkillActivationItem',
+    'SkillActivationItemORM',
+    'SkillStone',
+    'SkillStoneCategory',
+    'SkillStoneCategoryORM',
+    'SkillStoneEffect',
+    'SkillStoneEffectORM',
+    'SkillStoneORM',
+    'Suit',
+    'SuitBonus',
+    'SuitBonusAttrORM',
+    'SuitBonusORM',
+    'SuitORM',
+]

seerapi_models/items/_common.py

@@ -0,0 +1,95 @@
+from typing import TYPE_CHECKING, Optional
+
+from sqlmodel import Field, Relationship
+
+from seerapi_models.build_model import BaseCategoryModel, BaseResModel, ConvertToORM
+from seerapi_models.common import ResourceRef
+
+if TYPE_CHECKING:
+    from .enegry_bead import EnergyBeadORM
+    from .equip import EquipORM
+    from .mintmark_gem import GemORM
+    from .skill_activation_item import SkillActivationItemORM
+    from .skill_stone import SkillStoneORM
+
+
+class ItemBase(BaseResModel):
+    name: str = Field(description='物品名称')
+    desc: str | None = Field(
+        default=None, description='物品描述，可能为空（在游戏内显示为默认描述）'
+    )
+    max: int = Field(description='物品最大数量')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'item'
+
+
+class Item(ItemBase, ConvertToORM['ItemORM']):
+    category: ResourceRef['ItemCategory'] = Field(description='物品分类')
+
+    @classmethod
+    def get_orm_model(cls) -> type['ItemORM']:
+        return ItemORM
+
+    def to_orm(self) -> 'ItemORM':
+        return ItemORM(
+            id=self.id,
+            name=self.name,
+            desc=self.desc,
+            max=self.max,
+            category_id=self.category.id,
+        )
+
+
+class ItemORM(ItemBase, table=True):
+    skill_stone: Optional['SkillStoneORM'] = Relationship(
+        back_populates='item',
+    )
+    energy_bead: Optional['EnergyBeadORM'] = Relationship(
+        back_populates='item',
+    )
+    skill_activation_item: Optional['SkillActivationItemORM'] = Relationship(
+        back_populates='item',
+    )
+    equip: Optional['EquipORM'] = Relationship(
+        back_populates='item',
+    )
+    gem: Optional['GemORM'] = Relationship(
+        back_populates='item',
+    )
+
+    category_id: int = Field(foreign_key='item_category.id')
+    category: 'ItemCategoryORM' = Relationship(
+        back_populates='item',
+    )
+
+
+class ItemCategoryBase(BaseCategoryModel):
+    name: str = Field(description='物品分类名称')
+    max: int = Field(description='物品最大数量')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'item_category'
+
+
+class ItemCategory(ItemCategoryBase, ConvertToORM['ItemCategoryORM']):
+    item: list[ResourceRef['Item']] = Field(
+        default_factory=list, description='该分类下的所有物品'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['ItemCategoryORM']:
+        return ItemCategoryORM
+
+    def to_orm(self) -> 'ItemCategoryORM':
+        return ItemCategoryORM(
+            id=self.id,
+            name=self.name,
+            max=self.max,
+        )
+
+
+class ItemCategoryORM(ItemCategoryBase, table=True):
+    item: list['ItemORM'] = Relationship(back_populates='category')

seerapi_models/items/enegry_bead.py

@@ -0,0 +1,93 @@
+from typing import Optional
+
+from sqlmodel import Field, Relationship
+
+from seerapi_models.build_model import BaseResModel, ConvertToORM
+from seerapi_models.common import (
+    EidEffectInUse,
+    EidEffectInUseORM,
+    ResourceRef,
+    SixAttributes,
+    SixAttributesORM,
+)
+
+from ._common import Item, ItemORM
+
+
+class EnergyBeadBase(BaseResModel):
+    id: int = Field(primary_key=True, foreign_key='item.id', description='能量珠ID')
+    name: str = Field(description='能量珠名称')
+    desc: str = Field(description='能量珠描述')
+    idx: int = Field(description='能量珠效果ID')
+    use_times: int = Field(description='使用次数')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'energy_bead'
+
+
+class EnergyBead(EnergyBeadBase, ConvertToORM['EnergyBeadORM']):
+    item: ResourceRef['Item'] = Field(description='能量珠物品资源引用')
+    effect: EidEffectInUse = Field(description='能量珠效果')
+    ability_buff: SixAttributes | None = Field(
+        default=None, description='能力加成数值，仅当能量珠效果为属性加成时有效'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['EnergyBeadORM']:
+        return EnergyBeadORM
+
+    def to_orm(self) -> 'EnergyBeadORM':
+        return EnergyBeadORM(
+            id=self.id,
+            name=self.name,
+            desc=self.desc,
+            idx=self.idx,
+            effect_in_use=self.effect.to_orm(),
+            use_times=self.use_times,
+            ability_buff=EnergyBeadBuffAttrORM(
+                **self.ability_buff.model_dump(),
+            )
+            if self.ability_buff
+            else None,
+        )
+
+
+class EnergyBeadORM(EnergyBeadBase, table=True):
+    effect_in_use: 'EidEffectInUseORM' = Relationship(
+        back_populates='energy_bead',
+        sa_relationship_kwargs={
+            'primaryjoin': 'EnergyBeadORM.effect_in_use_id == EidEffectInUseORM.id',
+        },
+    )
+    effect_in_use_id: int | None = Field(
+        default=None, foreign_key='eid_effect_in_use.id'
+    )
+    ability_buff: Optional['EnergyBeadBuffAttrORM'] = Relationship(
+        back_populates='energy_bead',
+        sa_relationship_kwargs={
+            'uselist': False,
+            'primaryjoin': 'EnergyBeadORM.id == EnergyBeadBuffAttrORM.id',
+        },
+    )
+    item: 'ItemORM' = Relationship(back_populates='energy_bead')
+
+
+class EnergyBeadBuffAttrORM(SixAttributesORM, table=True):
+    id: int | None = Field(
+        default=None,
+        primary_key=True,
+        foreign_key='energy_bead.id',
+        description='能量珠能力加成ID',
+    )
+    energy_bead: 'EnergyBeadORM' = Relationship(
+        back_populates='ability_buff',
+        sa_relationship_kwargs={
+            'uselist': False,
+            'primaryjoin': 'EnergyBeadORM.id == EnergyBeadBuffAttrORM.id',
+        },
+    )
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'energy_bead_buff_attr'

seerapi_models/items/equip.py

@@ -0,0 +1,383 @@
+from typing import TYPE_CHECKING, Optional
+from typing_extensions import Self
+
+from pydantic import BaseModel
+from sqlmodel import Field, Relationship, SQLModel
+
+from seerapi_models.build_model import (
+    BaseCategoryModel,
+    BaseResModel,
+    BaseResModelWithOptionalId,
+    ConvertToORM,
+)
+from seerapi_models.common import (
+    EidEffectInUse,
+    EidEffectInUseORM,
+    ResourceRef,
+    SixAttributes,
+    SixAttributesORM,
+)
+from seerapi_models.items._common import Item, ItemORM
+
+if TYPE_CHECKING:
+    from seerapi_models.pet import Pet, PetORM
+
+
+class SuitBonusAttrORM(SixAttributesORM, table=True):
+    suit_bonus: 'SuitBonusORM' = Relationship(
+        back_populates='attribute',
+    )
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'suit_bonus_attr'
+
+
+class EquipBonusAttrORM(SixAttributesORM, table=True):
+    equip_bonus: 'EquipBonusORM' = Relationship(
+        back_populates='attribute',
+    )
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'equip_bonus_attr'
+
+
+class PkAttribute(BaseModel):
+    """装备PK加成（战队保卫战等远古活动使用）"""
+
+    pk_hp: int = Field(description='装备提供的血量加成')
+    pk_atk: int = Field(description='装备提供的攻击力加成')
+    pk_fire_range: int = Field(description='装备提供的射击范围加成')
+
+
+class OtherAttribute(BaseModel):
+    hit_rate: int = Field(default=0, description='命中加成')
+    dodge_rate: int = Field(default=0, description='闪避加成')
+    crit_rate: int = Field(default=0, description='暴击加成')
+
+    @classmethod
+    def from_list(cls, other_attr_args: list[int]) -> Self:
+        return cls(
+            hit_rate=other_attr_args[0],
+            dodge_rate=other_attr_args[1],
+            crit_rate=other_attr_args[2],
+        )
+
+
+class PetSuitLink(SQLModel, table=True):
+    pet_id: int | None = Field(default=None, foreign_key='pet.id', primary_key=True)
+    suit_id: int | None = Field(
+        default=None, foreign_key='suit_bonus.id', primary_key=True
+    )
+
+
+class EquipEffect(SQLModel):
+    newse_id: int | None = Field(
+        default=None,
+        description='部件特性ID，一部分套装使用该字段来表示效果',
+    )
+    eid_effect: EidEffectInUse | None = Field(
+        default=None,
+        description='部件效果，一部分套装使用该字段来表示效果',
+    )
+
+
+class EquipBonusBase(BaseResModelWithOptionalId):
+    desc: str = Field(description='部件描述')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'equip_bonus'
+
+
+class EquipBonus(EquipBonusBase, EquipEffect, ConvertToORM['EquipBonusORM']):
+    attribute: SixAttributes | None = Field(
+        default=None, description='属性加成，仅在部件有属性加成时有效'
+    )
+    other_attribute: OtherAttribute | None = Field(
+        default=None, description='其他属性加成，仅在部件有命中/闪避/暴击加成时有效'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['EquipBonusORM']:
+        return EquipBonusORM
+
+    def to_orm(self) -> 'EquipBonusORM':
+        other_attr_kwargs = (
+            self.other_attribute.model_dump() if self.other_attribute else {}
+        )
+        effect_in_use_orm = None
+        if self.eid_effect:
+            effect_in_use_orm = self.eid_effect.to_orm()
+
+        return EquipBonusORM(
+            id=self.id,
+            desc=self.desc,
+            effect_in_use=effect_in_use_orm,
+            newse_id=self.newse_id,
+            attribute=EquipBonusAttrORM(**self.attribute.model_dump())
+            if self.attribute
+            else None,
+            **other_attr_kwargs,
+        )
+
+
+class EquipBonusORM(EquipBonusBase, table=True):
+    equip: 'EquipORM' = Relationship(
+        back_populates='bonus',
+    )
+
+    effect_in_use_id: int | None = Field(foreign_key='eid_effect_in_use.id')
+    effect_in_use: Optional['EidEffectInUseORM'] = Relationship(
+        back_populates='equip_bonus',
+    )
+    newse_id: int | None = Field(default=None)
+    attribute_id: int | None = Field(default=None, foreign_key='equip_bonus_attr.id')
+    attribute: Optional['EquipBonusAttrORM'] = Relationship(
+        back_populates='equip_bonus',
+    )
+
+    hit_rate: int | None = Field(default=None)
+    dodge_rate: int | None = Field(default=None)
+    crit_rate: int | None = Field(default=None)
+
+
+class SuitBonusBase(BaseResModel):
+    id: int = Field(
+        description='套装效果ID',
+        primary_key=True,
+        foreign_key='suit.id',
+    )
+    desc: str = Field(description='套装描述')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'suit_bonus'
+
+
+class SuitBonus(SuitBonusBase, EquipEffect, ConvertToORM['SuitBonusORM']):
+    effective_pets: list[ResourceRef['Pet']] | None = Field(
+        default=None,
+        description='表示套装效果仅在这些精灵上生效，null表示对所有精灵都生效',
+    )
+    attribute: SixAttributes | None = Field(
+        default=None, description='属性加成，仅在套装效果为属性加成时有效'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['SuitBonusORM']:
+        return SuitBonusORM
+
+    def to_orm(self) -> 'SuitBonusORM':
+        effect_in_use_orm = None
+        if self.eid_effect:
+            effect_in_use_orm = self.eid_effect.to_orm()
+
+        return SuitBonusORM(
+            id=self.id,
+            desc=self.desc,
+            newse_id=self.newse_id,
+            effect_in_use=effect_in_use_orm,
+            attribute=SuitBonusAttrORM(**self.attribute.model_dump())
+            if self.attribute
+            else None,
+        )
+
+
+class SuitBonusORM(SuitBonusBase, table=True):
+    suit: 'SuitORM' = Relationship(
+        back_populates='bonus',
+    )
+
+    newse_id: int | None = Field(default=None)
+    effect_in_use_id: int | None = Field(
+        default=None, foreign_key='eid_effect_in_use.id'
+    )
+    effect_in_use: Optional['EidEffectInUseORM'] = Relationship(
+        back_populates='suit_bonus',
+    )
+    attribute_id: int | None = Field(default=None, foreign_key='suit_bonus_attr.id')
+    attribute: Optional['SuitBonusAttrORM'] = Relationship(
+        back_populates='suit_bonus',
+    )
+
+    effective_pets: list['PetORM'] = Relationship(
+        back_populates='exclusive_suit_bonus',
+        link_model=PetSuitLink,
+    )
+
+
+class SuitBase(BaseResModel):
+    name: str = Field(description='名称')
+    transform: bool = Field(description='是否可变形')
+    tran_speed: float | None = Field(
+        default=None, description='变形速度，仅当该套装可变形时有效'
+    )
+    suit_desc: str = Field(description='套装描述')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'suit'
+
+
+class Suit(SuitBase, ConvertToORM['SuitORM']):
+    equips: list[ResourceRef['Equip']] = Field(
+        default_factory=list, description='部件列表'
+    )
+    bonus: SuitBonus | None = Field(
+        default=None, description='套装效果，仅当该套装为能力加成套装时有效'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['SuitORM']:
+        return SuitORM
+
+    def to_orm(self) -> 'SuitORM':
+        return SuitORM(
+            id=self.id,
+            name=self.name,
+            transform=self.transform,
+            tran_speed=self.tran_speed,
+            suit_desc=self.suit_desc,
+            bonus=self.bonus.to_orm() if self.bonus else None,
+        )
+
+
+class SuitORM(SuitBase, table=True):
+    equips: list['EquipORM'] = Relationship(
+        back_populates='suit',
+    )
+    bonus: Optional['SuitBonusORM'] = Relationship(
+        back_populates='suit',
+    )
+
+
+class EquipBase(BaseResModel):
+    id: int = Field(primary_key=True, foreign_key='item.id', description='部件ID')
+    name: str = Field(description='部件名称')
+    speed: float | None = Field(
+        default=None, description='部件速度移动加成，一般只有脚部部件提供'
+    )
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'equip'
+
+
+class Equip(EquipBase, ConvertToORM['EquipORM']):
+    item: ResourceRef['Item'] = Field(description='装备部件物品资源引用')
+    bonus: EquipBonus | None = Field(
+        default=None, description='部件效果，仅当该部件为能力加成部件时有效'
+    )
+    occasion: ResourceRef['EquipEffectiveOccasion'] | None = Field(
+        default=None, description='部件生效场合，仅当该部件为能力加成部件时有效'
+    )
+    suit: ResourceRef[Suit] | None = Field(
+        default=None, description='部件所属套装，仅当该部件有套装时有效'
+    )
+    part_type: ResourceRef['EquipType'] = Field(description='部件类型')
+    pk_attribute: PkAttribute | None = Field(
+        default=None,
+        description='部件PK加成，战队保卫战等老玩法使用，当三个加成项都为0时为null',
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['EquipORM']:
+        return EquipORM
+
+    def to_orm(self) -> 'EquipORM':
+        pk_kwargs = self.pk_attribute.model_dump() if self.pk_attribute else {}
+        return EquipORM(
+            id=self.id,
+            name=self.name,
+            speed=self.speed,
+            part_type_id=self.part_type.id,
+            suit_id=self.suit.id if self.suit else None,
+            occasion_id=self.occasion.id if self.occasion else None,
+            bonus=self.bonus.to_orm() if self.bonus else None,
+            **pk_kwargs,
+        )
+
+
+class EquipORM(EquipBase, table=True):
+    part_type_id: int = Field(foreign_key='equip_type.id')
+    part_type: 'EquipTypeORM' = Relationship(
+        back_populates='equip',
+    )
+    suit_id: int | None = Field(default=None, foreign_key='suit.id')
+    suit: 'SuitORM' = Relationship(
+        back_populates='equips',
+    )
+    bonus_id: int | None = Field(default=None, foreign_key='equip_bonus.id')
+    bonus: Optional['EquipBonusORM'] = Relationship(
+        back_populates='equip',
+    )
+    occasion_id: int | None = Field(
+        default=None, foreign_key='equip_effective_occasion.id'
+    )
+    occasion: 'EquipEffectiveOccasionORM' = Relationship(
+        back_populates='equip',
+    )
+
+    pk_hp: int | None = Field(default=None)
+    pk_atk: int | None = Field(default=None)
+    pk_fire_range: int | None = Field(default=None)
+
+    item: 'ItemORM' = Relationship(back_populates='equip')
+
+
+class EquipTypeBase(BaseCategoryModel):
+    name: str = Field(description='部件类型名称')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'equip_type'
+
+
+class EquipType(EquipTypeBase, ConvertToORM['EquipTypeORM']):
+    equip: list[ResourceRef] = Field(default_factory=list, description='部件列表')
+
+    @classmethod
+    def get_orm_model(cls) -> type['EquipTypeORM']:
+        return EquipTypeORM
+
+    def to_orm(self) -> 'EquipTypeORM':
+        return EquipTypeORM(
+            id=self.id,
+            name=self.name,
+        )
+
+
+class EquipTypeORM(EquipTypeBase, table=True):
+    equip: list['EquipORM'] = Relationship(
+        back_populates='part_type',
+    )
+
+
+class EquipEffectiveOccasionBase(BaseCategoryModel):
+    description: str = Field(description='部件生效场合描述')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'equip_effective_occasion'
+
+
+class EquipEffectiveOccasion(
+    EquipEffectiveOccasionBase, ConvertToORM['EquipEffectiveOccasionORM']
+):
+    equip: list[ResourceRef] = Field(default_factory=list, description='部件列表')
+
+    @classmethod
+    def get_orm_model(cls) -> type['EquipEffectiveOccasionORM']:
+        return EquipEffectiveOccasionORM
+
+    def to_orm(self) -> 'EquipEffectiveOccasionORM':
+        return EquipEffectiveOccasionORM(
+            id=self.id,
+            description=self.description,
+        )
+
+
+class EquipEffectiveOccasionORM(EquipEffectiveOccasionBase, table=True):
+    equip: list['EquipORM'] = Relationship(back_populates='occasion')