/*
* Corpse - Dead bodies in bukkit
* Copyright (C) unldenis <https://github.com/unldenis>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package com.github.unldenis.corpse.api ;

public class CorpseAPI {

    /**
     * Method that creates a corpse in the player's position and with its skin and inventory
     * @param player The player to copy
     * @return a new Corpse object
     */
    public Corpse spawnCorpse (@NotNull Player player ) ;

    /**
     * Method that creates a corpse in the given place and with the skin, name and inventory of the player
     * @param player The player to copy
     * @param location The location where to spawn the corpse
     * @return a new Corpse object
     */
    public Corpse spawnCorpse (@NotNull Player player, @NotNull Location location ) ;

    /**
     * Method that creates a corpse in the given place and with the skin and name of the offlinePlayer
     * @param offlinePlayer The offlinePlayer to copy
     * @param location The location where to spawn the corpse
     * @return a new Corpse object
     */
    public Corpse spawnCorpse (@NotNull OfflinePlayer offlinePlayer, @NotNull Location location ) ;

    /**
     * Method that creates a corpse in the given place and with the skin and name of the player
     * with a custom inventory.
     * @param player The player to copy
     * @param location The location where to spawn the corpse
     * @param helmet The helmet to put on the corpse
     * @param chestPlate The chestPlate to put on the corpse
     * @param leggings The leggings to put on the corpse
     * @param boots The boots to put on the corpse
     * @return a new Corpse object
     */
    public Corpse spawnCorpse (
            @NotNull Player player,
            @NotNull Location location,
            @Nullable ItemStack helmet,
            @Nullable ItemStack chestPlate,
            @Nullable ItemStack leggings,
            @Nullable ItemStack boots
    ) ;

    /**
     * Method that creates a corpse in the given place and with the skin and name of the offlinePlayer
     * with a custom inventory.
     * @param offlinePlayer The offlinePlayer to copy
     * @param location The location where to spawn the corpse
     * @param helmet The helmet to put on the corpse
     * @param chestPlate The chestPlate to put on the corpse
     * @param leggings The leggings to put on the corpse
     * @param boots The boots to put on the corpse
     * @return a new Corpse object
     */
    public Corpse spawnCorpse (
            @NotNull OfflinePlayer offlinePlayer,
            @NotNull Location location,
            @Nullable ItemStack helmet,
            @Nullable ItemStack chestPlate,
            @Nullable ItemStack leggings,
            @Nullable ItemStack boots
    ) ;

    /**
     * Method that removes a corpse
     * @param corpse The corpse to be removed
     */
    public void removeCorpse (@NotNull Corpse corpse ) ;

    /**
     * Class method that allows you to use the API.
     * @return an instance of this class
     */
    @NotNull
    public static synchronized CorpseAPI getInstance ( ) ;
}