Source code for agentscope.environment.event

# -*- coding: utf-8 -*-
"""The events which can be bound to envs."""
from abc import ABC, abstractmethod
from typing import Any, Tuple




class Event:
    """A class representing the information of an event.

    It contains the name of the event, the arguments of the event,
    and the returns of the event.
    """

    def __init__(
        self,
        name: str,
        args: dict = None,
        returns: Any = None,
    ) -> None:
        self._name = name
        self._args = args
        self._returns = returns

    @property
    def name(self) -> str:
        """Return the name of the event."""
        return self._name

    @property
    def args(self) -> dict:
        """Return the arguments of the event."""
        return self._args

    @property
    def returns(self) -> Any:
        """Return the returns of the event."""
        return self._returns





class Getable(ABC):
    """Representing an env whose value can be gotten."""



    @abstractmethod
    def get(self) -> Any:
        """Get the value of the env.

        Returns:
            `Any`: The value of the env.
        """






class Setable(ABC):
    """Representing an env whose value can be set."""



    @abstractmethod
    def set(self, value: Any) -> bool:
        """Set the value of the env.

        Args:
            value (`Any`): The new value of the env.

        Returns:
            `bool`: Whether the value was set successfully.
        """






class Movable2D(ABC):
    """A class representing an env can be moved in 2D."""



    @abstractmethod
    def move_by(self, x: float, y: float) -> bool:
        """Move the env in 2D by the given vector.

        Args:
            x (`float`): The movement in x direction.
            y (`float`): The movement in y direction.

        Returns:
            `bool`: Whether the movement was successful.
        """




    @abstractmethod
    def move_to(self, x: float, y: float) -> bool:
        """Move the env to the given position.

        Args:
            x (`float`): The x coordinate of the new position.
            y (`float`): The y coordinate of the new position.

        Returns:
            `bool`: Whether the movement was successful.
        """




    @abstractmethod
    def get_position(self) -> Tuple[float, float]:
        """Get the position of the env.

        Returns:
            `Tuple[float, float]`: The position of the env.
        """






class Holdable(ABC):
    """A class representing an env can be held,and during
    the holding period, all access behaviors except the owner
    are prohibited.
    """



    @abstractmethod
    def acquire(self, owner: str) -> bool:
        """Acquire the env.

        Args:
            owner (`str`): The owner of the env.

        Returns:
            `bool`: Whether the env was acquired successfully.
        """




    @abstractmethod
    def release(self, owner: str) -> bool:
        """Release the env.

        Args:
            owner (`str`): The owner of the env.

        Returns:
            `bool`: Whether the env was released successfully.
        """