com.github.shynixn.petblocks.api.business.service.CarryPetService.kt Maven / Gradle / Ivy
package com.github.shynixn.petblocks.api.business.service
import java.util.*
import java.util.concurrent.CompletableFuture
/**
* Created by Shynixn 2018.
*
* Version 1.2
*
* MIT License
*
* Copyright (c) 2018 by Shynixn
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
interface CarryPetService {
/**
* Starts the given [player] carry his pet if is is currently spawned.
* Does nothing if the pet is already getting carried.
*/
fun
carryPet(player: P)
/**
* Lets the given [player] drop his pet if he is currently carrying it.
* Does nothing if the player isn't carrying it.
* Returns when the action was completed.
*/
fun
dropPet(player: P): CompletableFuture
/**
* Lets the given [player] throw his pet if he is currently carrying.
* Does automatically drop it and does nothing if the player isn't carrying it.
* Returns when the action was completed.
*/
fun throwPet(player: P): CompletableFuture
/**
* Gets the itemstack from the carrying pet.
* Returns an empty optional if the player is carrying anything.
*/
fun getCarryPetItemStack(player: P): Optional
/**
* Gets if the given player is carrying a pet.
*/
fun isCarryingPet(player: P): Boolean
/**
* Clears all resources the given [player] may have allocated.
*/
fun
clearResources(player: P)
}