# Package net.axay.kspigot.gui

## Types

ForColumnEight
Link copied to clipboard
interface ForColumnEight : ForInventoryWidthNine
Content copied to clipboard
ForColumnFive
Link copied to clipboard
interface ForColumnFive : ForInventoryWidthFive, ForInventoryWidthNine
Content copied to clipboard
ForColumnFour
Link copied to clipboard
interface ForColumnFour : ForInventoryWidthFive, ForInventoryWidthNine
Content copied to clipboard
ForColumnNine
Link copied to clipboard
interface ForColumnNine : ForInventoryWidthNine
Content copied to clipboard
ForColumnOne
Link copied to clipboard
interface ForColumnOne : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
Content copied to clipboard
ForColumnSeven
Link copied to clipboard
interface ForColumnSeven : ForInventoryWidthNine
Content copied to clipboard
ForColumnSix
Link copied to clipboard
interface ForColumnSix : ForInventoryWidthNine
Content copied to clipboard
ForColumnThree
Link copied to clipboard
interface ForColumnThree : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
Content copied to clipboard
ForColumnTwo
Link copied to clipboard
interface ForColumnTwo : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
Content copied to clipboard
ForCompleteRowOne
Link copied to clipboard
interface ForCompleteRowOne : ForRowOne, ForRowOneSlotOneToThree, ForRowOneSlotFourToFive
Content copied to clipboard
ForCompleteRowThree
Link copied to clipboard
interface ForCompleteRowThree : ForRowThree, ForRowThreeSlotOneToThree
Content copied to clipboard
ForCompleteRowTwo
Link copied to clipboard
interface ForCompleteRowTwo : ForRowTwo, ForRowTwoSlotOneToThree
Content copied to clipboard
ForEveryInventory
Link copied to clipboard
interface ForEveryInventory : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine, ForInventoryThreeByThree, ForInventoryOneByFive
Content copied to clipboard
ForInventory
Link copied to clipboard
interface ForInventory
Content copied to clipboard
ForInventoryFiveByNine
Link copied to clipboard
interface ForInventoryFiveByNine : ForInventorySixByNine
Content copied to clipboard
ForInventoryFourByNine
Link copied to clipboard
interface ForInventoryFourByNine : ForInventoryFiveByNine
Content copied to clipboard
ForInventoryOneByFive
Link copied to clipboard
interface ForInventoryOneByFive : ForInventoryOneByNine
Content copied to clipboard
ForInventoryOneByNine
Link copied to clipboard
interface ForInventoryOneByNine : ForInventoryTwoByNine
Content copied to clipboard
ForInventorySixByNine
Link copied to clipboard
interface ForInventorySixByNine : ForInventory
Content copied to clipboard
ForInventoryThreeByNine
Link copied to clipboard
interface ForInventoryThreeByNine : ForInventoryFourByNine
Content copied to clipboard
ForInventoryThreeByThree
Link copied to clipboard
interface ForInventoryThreeByThree : ForInventoryThreeByNine
Content copied to clipboard
ForInventoryTwoByNine
Link copied to clipboard
interface ForInventoryTwoByNine : ForInventoryThreeByNine
Content copied to clipboard
ForInventoryWidthFive
Link copied to clipboard
interface ForInventoryWidthFive : ForInventoryOneByFive
Content copied to clipboard
ForInventoryWidthNine
Link copied to clipboard
interface ForInventoryWidthNine : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForInventoryWidthThree
Link copied to clipboard
interface ForInventoryWidthThree : ForInventoryThreeByThree
Content copied to clipboard
ForRowFive
Link copied to clipboard
interface ForRowFive : ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForRowFour
Link copied to clipboard
interface ForRowFour : ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForRowOne
Link copied to clipboard
interface ForRowOne : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForRowOneSlotFourToFive
Link copied to clipboard
interface ForRowOneSlotFourToFive : ForRowOne, ForInventoryOneByFive
Content copied to clipboard
ForRowOneSlotOneToThree
Link copied to clipboard
interface ForRowOneSlotOneToThree : ForRowOne, ForInventoryOneByFive, ForInventoryThreeByThree
Content copied to clipboard
ForRowSix
Link copied to clipboard
interface ForRowSix : ForInventorySixByNine
Content copied to clipboard
ForRowThree
Link copied to clipboard
interface ForRowThree : ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForRowThreeSlotOneToThree
Link copied to clipboard
interface ForRowThreeSlotOneToThree : ForRowThree, ForInventoryThreeByThree
Content copied to clipboard
ForRowTwo
Link copied to clipboard
interface ForRowTwo : ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
Content copied to clipboard
ForRowTwoSlotOneToThree
Link copied to clipboard
interface ForRowTwoSlotOneToThree : ForRowTwo, ForInventoryThreeByThree
Content copied to clipboard
GUI
Link copied to clipboard
abstract class GUI<T : ForInventory>(data: GUIData<T>)
Content copied to clipboard
GUIBuilder
Link copied to clipboard
class GUIBuilder<T : ForInventory>(type: GUIType<T>, guiCreator: GUICreator<T>)
Content copied to clipboard
GUIClickEvent
Link copied to clipboard
class GUIClickEvent<T : ForInventory>(bukkitEvent: InventoryClickEvent, guiInstance: GUIInstance<T>, player: Player)
Content copied to clipboard
GUICreator
Link copied to clipboard
abstract class GUICreator<T : ForInventory>
Content copied to clipboard
GUIData
Link copied to clipboard
class GUIData<T : ForInventory>(guiType: GUIType<T>, title: String?, pages: Map<Int, GUIPage<T>>, defaultPage: Int, transitionTo: InventoryChangeEffect?, transitionFrom: InventoryChangeEffect?, generalOnClick: (GUIClickEvent<T>) -> Unit?)
Content copied to clipboard
GUIElement
Link copied to clipboard
abstract class GUIElement<T : ForInventory> : GUISlot<T>
Content copied to clipboard
GUIHolder
Link copied to clipboard
object GUIHolder : AutoCloseable
Content copied to clipboard
GUIIndividual
Link copied to clipboard
class GUIIndividual<T : ForInventory>(guiData: GUIData<T>, resetOnClose: Boolean, resetOnQuit: Boolean) : GUI<T>
Content copied to clipboard
GUIInstance
Link copied to clipboard
class GUIInstance<T : ForInventory>(gui: GUI<T>, holder: Player?)
Content copied to clipboard
GUIPage
Link copied to clipboard
class GUIPage<T : ForInventory>(number: Int, slots: Map<Int, GUISlot<T>>, transitionTo: PageChangeEffect?, transitionFrom: PageChangeEffect?)
Content copied to clipboard
GUIPageBuilder
Link copied to clipboard
class GUIPageBuilder<T : ForInventory>(type: GUIType<T>, page: Int)
Content copied to clipboard
GUIPageChangeCalculator
Link copied to clipboard
abstract class GUIPageChangeCalculator
Content copied to clipboard
GUIShared
Link copied to clipboard
class GUIShared<T : ForInventory>(guiData: GUIData<T>) : GUI<T>
Content copied to clipboard
GUISlot
Link copied to clipboard
abstract class GUISlot<T : ForInventory>
Content copied to clipboard
GUIType
Link copied to clipboard
class GUIType<in T : ForInventory>(dimensions: InventoryDimensions, bukkitType: InventoryType?)
Content copied to clipboard
IndividualGUICreator
Link copied to clipboard
class IndividualGUICreator<T : ForInventory>(resetOnClose: Boolean, resetOnQuit: Boolean) : GUICreator<T>
Content copied to clipboard
InventoryAllSlots
Link copied to clipboard
class InventoryAllSlots<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
InventoryBorderSlots
Link copied to clipboard
class InventoryBorderSlots<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
InventoryChangeEffect
Link copied to clipboard
enum InventoryChangeEffect : Enum<InventoryChangeEffect>
Content copied to clipboard
InventoryColumnSlots
Link copied to clipboard
class InventoryColumnSlots<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
InventoryCornerSlots
Link copied to clipboard
class InventoryCornerSlots<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
InventoryDimensions
Link copied to clipboard
data class InventoryDimensions(width: Int, height: Int)
Content copied to clipboard
InventoryRowSlots
Link copied to clipboard
class InventoryRowSlots<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
InventorySlot
Link copied to clipboard
data class InventorySlot(row: Int, slotInRow: Int) : Comparable<InventorySlot>
Content copied to clipboard
InventorySlotCompound
Link copied to clipboard
interface InventorySlotCompound<out T : ForInventory>
Content copied to clipboard
InventorySlotRange
Link copied to clipboard
class InventorySlotRange<out T : ForInventory> : InventorySlotCompound<T> , ClosedRange<InventorySlot>
Content copied to clipboard
PageChangeEffect
Link copied to clipboard
enum PageChangeEffect : Enum<PageChangeEffect>
Content copied to clipboard
SharedGUICreator
Link copied to clipboard
class SharedGUICreator<T : ForInventory> : GUICreator<T>
Content copied to clipboard
SingleInventorySlot
Link copied to clipboard
open class SingleInventorySlot<T : ForInventory> : InventorySlotCompound<T>
Content copied to clipboard
Slots
Link copied to clipboard
object Slots
Content copied to clipboard

## Functions

gotoPage
Link copied to clipboard
fun GUIInstance<*>.gotoPage(page: Int, overrideEffect: PageChangeEffect? = null)
Content copied to clipboard
kSpigotGUI
Link copied to clipboard
fun <T : ForInventory> kSpigotGUI(type: GUIType<T>, guiCreator: GUICreator<T> = IndividualGUICreator(), builder: GUIBuilder<T>.() -> Unit): GUI<T>
Content copied to clipboard
linTo
Link copied to clipboard
infix fun <T : ForInventory> SingleInventorySlot<out T>.linTo(slot: SingleInventorySlot<out T>): InventorySlotRange<T>
Content copied to clipboard
This range contains all slots having an index between the indeces of the two given slots.
openGUI
Link copied to clipboard
fun Player.openGUI(gui: GUI<*>, page: Int? = null): InventoryView?
Content copied to clipboard
rectTo
Link copied to clipboard
infix fun <T : ForInventory> SingleInventorySlot<out T>.rectTo(slot: SingleInventorySlot<out T>): InventorySlotRange<T>
Content copied to clipboard
This range contains all slots inside of a thought rectangle with the two given slots as two opposite corners of the rectangle.