com.github.shynixn.blockball.api.business.service.BlockSelectionService.kt Maven / Gradle / Ivy
package com.github.shynixn.blockball.api.business.service
import java.util.*
/**
* 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 BlockSelectionService {
/**
* Selects the left location internally.
*/
fun selectLeftLocation(player: P, location: L) : Boolean
/**
* Selects the right location internally.
*/
fun selectRightLocation(player: P, location: L) : Boolean
/**
* Returns the leftclick internal or worledit selection of the given [player].
*/
fun getLeftClickLocation(player: P): Optional
/**
* Returns the rightclick internal or worledit selection of the given [player].
*/
fun getRightClickLocation(player: P): Optional
/**
* Gives the given [player] the selection tool if he does not
* already have it.
*/
fun setSelectionToolForPlayer(player : P)
/**
* Cleans open resources.
*/
fun
cleanResources(player: P)
}