// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

// TODO: Move BuildingCategory into this file
import {BuildingCategory, TaskKind} from "@ds/schema/Schema.sol";

enum BiomeKind {
    UNDISCOVERED,
    DISCOVERED
}

enum FacingDirectionKind {
    RIGHT,
    LEFT
}

struct CombatAction {
    CombatActionKind kind;
    bytes24 entityID; // Can be mobileUnit or building
    uint64 blockNum;
    bytes data;
}

enum CombatActionKind {
    NONE,
    JOIN,
    LEAVE,
    EQUIP
}

// ----------------------------------
// Actions interface
// ----------------------------------

interface Actions {
    // move the sending player's mobileUnit to target location
    function MOVE_MOBILE_UNIT(int16 z, int16 q, int16 r, int16 s) external;

    // transfer a qty of items from itemSlot[0] in equipees[0]'s equipSlots[0] bag
    // to itemSlot[1] in equipees[1]'s equipSlots[1] bag
    // bags must be at same location as mobileUnit
    // bags must either be owned by mobileUnit or owned by nobody
    function TRANSFER_ITEM_MOBILE_UNIT(
        bytes24 mobileUnit,
        bytes24[2] calldata equipees,
        uint8[2] calldata equipSlots,
        uint8[2] calldata itemSlots,
        bytes24 toBagId,
        uint64 qty
    ) external;

    function EXPORT_ITEM(bytes24 fromEquipee, uint8 fromEquipSlot, uint8 fromItemSlot, address toAddress, uint64 qty)
        external;

    function IMPORT_ITEM(bytes24 itemId, bytes24 toEquipee, uint8 toEquipSlot, uint8 toItemSlot, uint64 qty) external;

    // register an external contract as possible building
    function REGISTER_BUILDING_KIND(
        bytes24 buildingKind,
        string calldata name,
        BuildingCategory category,
        string calldata model,
        bytes24[4] calldata materialItem,
        uint64[4] calldata materialQty,
        bytes24[4] calldata inputItemIDs,
        uint64[4] calldata inputItemQtys,
        bytes24[1] calldata outputItemIDs,
        uint64[1] calldata outputItemQtys
    ) external;

    // register kind implementation contract
    function REGISTER_KIND_IMPLEMENTATION(bytes24 kind, address kindImplementation) external;
    function DEPLOY_KIND_IMPLEMENTATION(bytes24 kind, bytes calldata bytecode) external;

    // register plugins for use within supported clients
    //
    // plugins always reference a thing within the state. ie a plugin for a BuildingKind
    //
    // example:
    //
    //  REGISTER_KIND_PLUGIN(myRandomlyPickedPluginID, myBuildingKindID, "my-plugin", "function(){}")
    //
    function REGISTER_KIND_PLUGIN(
        bytes24 pluginID,
        bytes24 targetKind,
        string calldata name,
        string calldata src,
        bool alwaysActive
    ) external;

    // construct a building
    function CONSTRUCT_BUILDING_MOBILE_UNIT(
        bytes24 buildingKind, // what kind of building
        int16 z, // which zone to create on
        int16 q,
        int16 r,
        int16 s // which tile to create on (can be adjacent)
    ) external;

    // use a building
    // this action mostly just proxies through to the building kind implementation (if set)
    function BUILDING_USE(bytes24 buildingID, bytes24 mobileUnitID, bytes calldata payload) external;

    function REGISTER_ITEM_KIND(bytes24 itemKind, string calldata name, string calldata icon) external;

    function CRAFT(
        bytes24 buildingInstance // the building performing CRAFT
    ) external;

    function EXTRACT(
        bytes24 buildingInstance // the building performing EXTRACT
    ) external;

    // spawn a mobileUnit for the sender
    function SPAWN_MOBILE_UNIT() external;

    function START_COMBAT(
        bytes24 mobileUnitID,
        bytes24 tileID,
        bytes24[] calldata attackers,
        bytes24[] calldata defenders
    ) external;

    function FINALISE_COMBAT(bytes24 sessionID) external;

    function NAME_OWNED_ENTITY(bytes24 entity, string calldata name) external;
    function DESCRIBE_OWNED_ENTITY(bytes24 entity, string calldata shortDescription) external;
    function URL_OWNED_ENTITY(bytes24 entity, string calldata url) external;

    function TRANSFER_BAG_OWNERSHIP(bytes24 bag, bytes24 toEntity) external;

    function TRANSFER_BAG(bytes24 bag, bytes24 fromEntity, bytes24 toEntity, uint8 toEquipSlot) external;

    function SPAWN_EMPTY_BAG(bytes24 equipee, uint8 equipSlot) external;

    // Quests

    function REGISTER_QUEST(
        int16 zone,
        string calldata name,
        string calldata description,
        bool hasLocation,
        int16 z,
        int16 q,
        int16 r,
        int16 s,
        bytes24[] calldata tasks,
        bytes24[] calldata nextQuests
    ) external;

    function REGISTER_TASK(int16 zone, string calldata name, TaskKind kind, bytes calldata taskData) external;

    function ACCEPT_QUEST(bytes24 quest, uint8 questNum) external;

    function COMPLETE_QUEST(bytes24 quest, uint8 questNum) external;

    // ---------------------
    // the DEV_ actions below this point are not for public use they are
    // only available by a single authorized account and only for a short
    // period after initial world deployment.
    // ---------------------

    // action to set the type of quest the player should begin with
    function DEV_ASSIGN_AUTO_QUEST(string memory name, uint16 zone) external;

    // action to destroy the auto quest
    function DEV_DESTROY_AUTO_QUEST(string memory name, uint16 zone) external;

    // spawn a tile at any location
    function DEV_SPAWN_TILE(int16 z, int16 q, int16 r, int16 s) external;

    // spawn a building at any location
    function DEV_SPAWN_BUILDING(
        bytes24 buildingKind,
        int16 z,
        int16 q,
        int16 r,
        int16 s,
        FacingDirectionKind facingDirection
    ) external;

    // spawn a public bag on a tile populated with items
    function DEV_SPAWN_BAG(
        int16 z,
        int16 q,
        int16 r,
        int16 s,
        uint8 equipSlot,
        bytes24[] calldata slotContents,
        uint64[] calldata slotBalances
    ) external;

    // destroy a tile at any location
    function DEV_DESTROY_TILE(int16 z, int16 q, int16 r, int16 s) external;

    // destroy a building at any location
    function DEV_DESTROY_BUILDING(int16 z, int16 q, int16 r, int16 s) external;

    // spawn a bag with resources equip somewhere
    function DEV_DESTROY_BAG(
        bytes24 bagID,
        address owner,
        bytes24 equipee,
        uint8 equipSlot,
        bytes24[] calldata slotContents
    ) external;

    function SET_DATA_ON_BUILDING(bytes24 buildingID, string memory key, bytes32 data) external;

    function KICK_UNIT_FROM_ZONE(bytes24 mobileUnitID) external;

    function ZONE_USE(bytes24 mobileUnitID, bytes calldata payload) external;

    function SET_DATA_ON_ZONE(bytes24 zoneID, string memory key, bytes32 data) external;

    function ITEM_USE(bytes24 itemID, bytes24 mobileUnitID, bytes calldata payload) external;

    function SET_DATA_ON_ITEM(bytes24 itemID, string memory key, bytes32 data) external;
}