🤖 带有能力的 Entity 实例Class

tongsim.entity.mixin

entity.mixin

MixinEntityBase

Bases: Entity

用于通过 _ability_types 字段声明当前实体类型支持的能力（Ability Protocol 接口）， 并在创建时自动将这些能力方法绑定为实体成员方法。

_ability_types 为类变量，需在子类中显式指定能力列表。

Source code in src\tongsim\entity\mixin.py

class MixinEntityBase(Entity):
    """
    用于通过 `_ability_types` 字段声明当前实体类型支持的能力（Ability Protocol 接口），
    并在创建时自动将这些能力方法绑定为实体成员方法。

    `_ability_types` 为类变量，需在子类中显式指定能力列表。
    """

    _ability_types: ClassVar[list[type]] = []

    @classmethod
    async def create(cls, *args, **kwargs):
        self = cls(*args, **kwargs)
        for ability in cls._ability_types:
            await _bind_ability_methods(self, ability)
        return self

    @classmethod
    async def from_grpc(
        cls, entity_id: str, world_context: WorldContext
    ) -> "MixinEntityBase":
        """
        通过 gRPC 查询构造 Entity。
        """

        # TODO: 为了保留 Entity Base 层的干净实现，此处出现了重复逻辑调用
        resp = await UnaryAPI.query_components(world_context.conn, entity_id)
        if resp is None:
            raise RuntimeError(f"Failed to query components for entity '{entity_id}'.")

        components: dict[ComponentType, list[str]] = defaultdict(list)
        for component_id, component_type in resp.items():
            components[component_type].append(component_id)

        _logger.debug(
            f"[Consturct mixin entity from gRPC] Entity {entity_id}  ---  ability-types: {list(cls._ability_types)}"
        )
        return await cls.create(entity_id, world_context, components)

CameraEntity

Bases: MixinEntityBase, SceneAbility, CameraAbility

TongSim 的相机实体

Source code in src\tongsim\entity\mixin.py

class CameraEntity(MixinEntityBase, SceneAbility, CameraAbility):
    """
    TongSim 的相机实体
    """

    _ability_types: ClassVar[list[type]] = [SceneAbility, CameraAbility]

HFCameraEntity

Bases: MixinEntityBase, HFCameraAbility

TongSim 的高速相机实体

Source code in src\tongsim\entity\mixin.py

class HFCameraEntity(MixinEntityBase, HFCameraAbility):
    """
    TongSim 的高速相机实体
    """

    _ability_types: ClassVar[list[type]] = [HFCameraAbility]

AgentEntity

Bases: MixinEntityBase, SceneAbility, AgentActionAbility, AssetAbility, VoxelAbility

TongSim 的智能体

Source code in src\tongsim\entity\mixin.py

class AgentEntity(
    MixinEntityBase, SceneAbility, AgentActionAbility, AssetAbility, VoxelAbility
):
    """
    TongSim 的智能体
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        AgentActionAbility,
        AssetAbility,
        VoxelAbility,
    ]

ConsumableEntity

Bases: MixinEntityBase, SceneAbility, ConsumableEnergyAbility, AssetAbility, CollisionShapeAbility

可食用 或 可饮用 的实体。

Source code in src\tongsim\entity\mixin.py

class ConsumableEntity(
    MixinEntityBase,
    SceneAbility,
    ConsumableEnergyAbility,
    AssetAbility,
    CollisionShapeAbility,
):
    """
    可食用 或 可饮用 的实体。
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        ConsumableEnergyAbility,
        AssetAbility,
        CollisionShapeAbility,
    ]

ElectricApplianceEntity

Bases: MixinEntityBase, SceneAbility, AssetAbility, InteractableAbility, PowerableAbility, CollisionShapeAbility

TongSim 的支持交互控制的电器类型实体，比如台灯、电视、空调、冰箱、微波炉、电风扇、饮水机等等

Source code in src\tongsim\entity\mixin.py

class ElectricApplianceEntity(
    MixinEntityBase,
    SceneAbility,
    AssetAbility,
    InteractableAbility,
    PowerableAbility,
    CollisionShapeAbility,
):
    """
    TongSim 的支持交互控制的电器类型实体，比如台灯、电视、空调、冰箱、微波炉、电风扇、饮水机等等
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        AssetAbility,
        InteractableAbility,
        PowerableAbility,
        CollisionShapeAbility,
    ]

InteractableEntity

Bases: MixinEntityBase, SceneAbility, AssetAbility, InteractableAbility, CollisionShapeAbility

TongSim 的支持交互控制物体类型实体（不依赖电源），比如遥控器、墙上的开关

Source code in src\tongsim\entity\mixin.py

class InteractableEntity(
    MixinEntityBase,
    SceneAbility,
    AssetAbility,
    InteractableAbility,
    CollisionShapeAbility,
):
    """
    TongSim 的支持交互控制物体类型实体（不依赖电源），比如遥控器、墙上的开关
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        AssetAbility,
        InteractableAbility,
        CollisionShapeAbility,
    ]

BaseObjectEntity

Bases: MixinEntityBase, SceneAbility, ConsumableEnergyAbility, AssetAbility, InteractableAbility, PowerableAbility, CollisionShapeAbility, LightAbility

TongSim 的通用对象实体，包括大部分可以交互的接口

Source code in src\tongsim\entity\mixin.py

class BaseObjectEntity(
    MixinEntityBase,
    SceneAbility,
    ConsumableEnergyAbility,
    AssetAbility,
    InteractableAbility,
    PowerableAbility,
    CollisionShapeAbility,
    LightAbility,
):
    """
    TongSim 的通用对象实体，包括大部分可以交互的接口
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        ConsumableEnergyAbility,
        AssetAbility,
        InteractableAbility,
        PowerableAbility,
        CollisionShapeAbility,
        LightAbility,
    ]

LightEntity

Bases: MixinEntityBase, SceneAbility, AssetAbility, InteractableAbility, CollisionShapeAbility, LightAbility

TongSim 的灯实体

Source code in src\tongsim\entity\mixin.py

class LightEntity(
    MixinEntityBase,
    SceneAbility,
    AssetAbility,
    InteractableAbility,
    CollisionShapeAbility,
    LightAbility,
):
    """
    TongSim 的灯实体
    """

    _ability_types: ClassVar[list[type]] = [
        SceneAbility,
        AssetAbility,
        InteractableAbility,
        CollisionShapeAbility,
        LightAbility,
    ]

NPCEntity

Bases: MixinEntityBase, NPCActionAbility

TongSim 的 NPC 实体

Source code in src\tongsim\entity\mixin.py

class NPCEntity(MixinEntityBase, NPCActionAbility):
    """
    TongSim 的 NPC 实体
    """

    _ability_types: ClassVar[list[type]] = [NPCActionAbility]

    @classmethod
    async def from_grpc(
        cls, entity_id: str, world_context: WorldContext
    ) -> "MixinEntityBase":
        # note: 当前 NPC 不是一个 gRPC subject, 因此跳过 query components 的过程!
        components: dict[ComponentType, list[str]] = defaultdict(list)
        _logger.debug(
            f"[Consturct mixin entity from gRPC] Entity {entity_id}  ---  ability-types: {list(cls._ability_types)}"
        )
        return await cls.create(entity_id, world_context, components)