ERC-7509: 实体组件系统

// SPDX-License-Identifier: CC0-1.0
pragma solidity >=0.8.0;

interface IWorld {
    /**
     * 创建一个新的实体。
     * @dev 实体必须被分配一个唯一的 Id。
     * 如果实体的状态为 true，则表示它可用，如果为 false，则表示它不可用。
     * 当实体的状态为 false 时，您无法为实体添加或删除组件。
     * @return 新的实体 id。
     */
    function createEntity() external returns (uint256);

    /**
     * 实体是否存在于 world 中。
     * @param _entityId 是实体的 Id。
     * @return true 存在，false 不存在。
     */
    function entityExists(uint256 _entityId) external view returns (bool);

    /**
     * 获取 world 中实体的总数。
     * @return 实体的总数。
     */
    function getEntityCount() external view returns (uint256);

    /**
     * 设置实体的状态。
     * @dev 实体必须存在。
     * @param _entityId 是实体的 Id。
     * @param _entityState 是实体的状态，true 表示可用，false 表示不可用。
     */
    function setEntityState(uint256 _entityId, bool _entityState) external;

    /**
     * 获取实体的状态。
     * @param _entityId 实体的 Id。
     * @return 实体的当前状态。
     */
    function getEntityState(uint256 _entityId) external view returns (bool);

    /**
     * 向 world 注册一个组件。
     * @dev 组件必须先在 world 中注册才能附加到实体。
     * 不得重复向 world 注册同一个组件。
     * 应该检查组件合约的 world() 返回的合约地址是否与当前的 world 合约相同。
     * 组件的状态为 true 表示它可用，false 表示它不可用。当组件状态设置为 false 时，它不能附加到实体。
     * @param _componentAddress 是组件的合约地址。
     */
    function registerComponent(address _componentAddress) external;

    /**
     * 组件是否存在于 world 中。
     * @param _componentAddress 是组件的合约地址。
     * @return true 存在，false 不存在。
     */
    function componentExists(address _componentAddress)
        external
        view
        returns (bool);

    /**
     * 获取在 world 中注册的所有组件的合约地址。
     * @return 合约地址数组。
     */
    function getComponents() external view returns (address[] memory);

    /**
     * 设置组件状态。
     * @dev 组件必须存在。
     * @param _componentAddress 是组件的合约地址。
     * @param _componentState 是组件的状态，true 表示可用，false 表示不可用。
     */
    function setComponentState(address _componentAddress, bool _componentState)
        external;

    /**
     * 获取组件的状态。
     * @param _componentAddress 是组件的合约地址。
     * @return true 表示可用，false 表示不可用。
     */
    function getComponentState(address _componentAddress)
        external
        view
        returns (bool);

    /**
     * 将组件附加到实体。
     * @dev 实体必须可用。组件必须可用。一个组件不能重复添加到实体。
     * @param _entityId 是实体的 Id。
     * @param _componentAddress 是要附加的组件的地址。
     */
    function addComponent(uint256 _entityId, address _componentAddress)
        external;

    /**
     * 实体是否附加了组件。
     * @dev 实体必须存在。组件必须已注册。
     * @param _entityId 是实体的 Id。
     * @param _componentAddress 是组件地址。
     * @return true 已附加，false 未附加
     */
    function hasComponent(uint256 _entityId, address _componentAddress)
        external
        view
        returns (bool);

    /**
     * 从实体中移除组件。
     * @dev 实体必须可用。该组件必须在此之前已添加到实体。
     * @param _entityId 是实体的 Id。
     * @param _componentAddress 是要移除的组件的地址。
     */
    function removeComponent(uint256 _entityId, address _componentAddress)
        external;

    /**
     * 获取附加到实体的所有组件的合约地址。
     * @dev 实体必须存在。
     * @param _entityId 是实体的 Id。
     * @return 此实体拥有的组件的合约地址数组。
     */
    function getEntityComponents(uint256 _entityId)
        external
        view
        returns (address[] memory);

    /**
     * 向 world 注册一个系统。
     * @dev 不得重复向 world 注册同一个系统。系统状态为 true 表示可用，false 表示不可用。
     * @param _systemAddress 是系统的合约地址。
     */
    function registerSystem(address _systemAddress) external;

    /**
     * 系统是否存在于 world 中。
     * @param _systemAddress 是系统的合约地址。
     * @return true 存在，false 不存在。
     */
    function systemExists(address _systemAddress) external view returns (bool);

    /**
     * 获取在 world 中注册的所有系统的合约地址。
     * @return 合约地址数组。
     */
    function getSystems() external view returns (address[] memory);

    /**
     * 设置系统的状态。
     * @dev 系统必须存在。
     * @param _systemAddress 是系统的合约地址。
     * @param _systemState 是系统的状态。
     */
    function setSystemState(address _systemAddress, bool _systemState) external;

    /**
     * 获取系统的状态。
     * @param _systemAddress 是系统的合约地址。
     * @return 系统的状态。
     */
    function getSystemState(address _systemAddress)
        external
        view
        returns (bool);
}

// SPDX-License-Identifier: CC0-1.0
pragma solidity >=0.8.0;
import "./Types.sol";

interface IComponent {
    /**
     * 组件注册的 world 合约地址。
     * @return world 合约地址。
     */
    function world() external view returns (address);

    /**
     * 获取组件的数据类型和 get() 参数类型
     * @dev 应该导入 Types 库，这是一个包含所有数据类型的枚举库。
     * 实体数据可以根据数据类型存储。
     * get() 参数数据类型可用于获取实体数据。
     * @return 实体的数据类型数组
     * @return get 参数数据类型数组
     */
    function types()
        external
        view
        returns (Types.Type[] memory, Types.Type[] memory);

    /**
     * 存储实体数据。
     * @dev 实体必须可用。操作它的系统必须可用。
     * 实体附加了组件。
     * @param _entityId 是实体的 Id。
     * @param _data 是要存储的数据。
     */
    function set(uint256 _entityId, bytes memory _data) external;

    /**
     * 根据实体 Id 获取实体的数据。
     * @param _entityId 是实体的 Id。
     * @return 实体数据。
     */
    function get(uint256 _entityId) external view returns (bytes memory);

    /** 根据实体 Id 和参数获取实体的数据。
     * @param _entityId 是实体的 Id。
     * @param _params 是一个额外的参数，它应该取决于您是否需要它。
     * @return 实体数据。
     */
    function get(uint256 _entityId, bytes memory _params)
        external
        view
        returns (bytes memory);
}