ktInventory/dev.s7a.ktinventory.util

Package-level declarations

Functions

inline fun <T : AbstractKtInventory> ~~getAllViewers~~(): Map<Player, T>

fun <T : AbstractKtInventory> ~~getAllViewers~~(clazz: KClass<T>): Map<Player, T>

Gets all online players currently viewing an inventory of the specified type.

inline fun <T : ParentInventory> ~~getAllViewersDeeply~~(): Map<Player, T>

Gets all online players currently viewing an inventory or child inventory of the specified parent type. This function searches through the inventory hierarchy to find parent inventories of the specified type.

getAllViewersPaginated

inline fun <T : AbstractKtInventoryPaginated<*>> ~~getAllViewersPaginated~~(): Map<Player, AbstractKtInventoryPaginated.Entry<T>>

fun <T : AbstractKtInventoryPaginated<*>> ~~getAllViewersPaginated~~(clazz: KClass<T>): Map<Player, AbstractKtInventoryPaginated.Entry<T>>

Gets all online players currently viewing a paginated inventory of the specified type.

getOpenInventory

inline fun <T : AbstractKtInventory> ~~getOpenInventory~~(player: HumanEntity): T?

fun <T : AbstractKtInventory> ~~getOpenInventory~~(clazz: KClass<T>, player: HumanEntity): T?

Gets the currently open inventory of the specified type for a player.

getOpenInventoryPaginated

inline fun <T : AbstractKtInventoryPaginated<*>> ~~getOpenInventoryPaginated~~(player: HumanEntity): AbstractKtInventoryPaginated.Entry<T>?

fun <T : AbstractKtInventoryPaginated<*>> ~~getOpenInventoryPaginated~~(clazz: KClass<T>, player: HumanEntity): AbstractKtInventoryPaginated.Entry<T>?

Gets the currently open paginated inventory entry of the specified type for a player.

getTopInventory

inline fun <T : Any> getTopInventory(player: HumanEntity): T?

fun <T : Any> getTopInventory(clazz: KClass<T>, player: HumanEntity): T?

Gets the holder of the top inventory in the currently open inventory view.

getTopInventoryPaginatedEntry

inline fun <T : AbstractKtInventoryPaginated<*>> getTopInventoryPaginatedEntry(player: HumanEntity): AbstractKtInventoryPaginated.Entry<T>?

fun <T : AbstractKtInventoryPaginated<*>> getTopInventoryPaginatedEntry(clazz: KClass<T>, player: HumanEntity): AbstractKtInventoryPaginated.Entry<T>?

Gets the paginated inventory entry of the top inventory in the currently open inventory view.

getTopInventoryPaginatedFetchedEntry

inline fun <T : AbstractKtInventoryPaginatedFetched<*, *>> getTopInventoryPaginatedFetchedEntry(player: HumanEntity): AbstractKtInventoryPaginatedFetched.Entry<*, *>?

fun <T : AbstractKtInventoryPaginatedFetched<*, *>> getTopInventoryPaginatedFetchedEntry(clazz: KClass<T>, player: HumanEntity): AbstractKtInventoryPaginatedFetched.Entry<*, *>?

Gets the condition-fetched paginated inventory entry of the top inventory in the currently open inventory view.

getTopInventoryPaginatedLazyFetchedEntry

inline fun <T : AbstractKtInventoryPaginatedLazyFetched<*, *, *>> getTopInventoryPaginatedLazyFetchedEntry(player: HumanEntity): AbstractKtInventoryPaginatedLazyFetched.Entry<*, *, *>?

fun <T : AbstractKtInventoryPaginatedLazyFetched<*, *, *>> getTopInventoryPaginatedLazyFetchedEntry(clazz: KClass<T>, player: HumanEntity): AbstractKtInventoryPaginatedLazyFetched.Entry<*, *, *>?

Gets the lazy-fetched paginated inventory entry of the top inventory in the currently open inventory view.

getTopInventoryPaginatedSequenceEntry

inline fun <T : AbstractKtInventoryPaginatedSequence<*>> getTopInventoryPaginatedSequenceEntry(player: HumanEntity): AbstractKtInventoryPaginatedSequence.Entry<T>?

fun <T : AbstractKtInventoryPaginatedSequence<*>> getTopInventoryPaginatedSequenceEntry(clazz: KClass<T>, player: HumanEntity): AbstractKtInventoryPaginatedSequence.Entry<T>?

Gets the sequence-backed paginated inventory entry of the top inventory in the currently open inventory view.

getViewers

inline fun <T : Any> getViewers(): Map<Player, T>

fun <T : Any> getViewers(clazz: KClass<T>): Map<Player, T>

Gets all online players currently viewing an inventory holder of the specified type.

getViewersDeeply

inline fun <T : ParentInventory> getViewersDeeply(): Map<Player, T>

fun <T : ParentInventory> getViewersDeeply(clazz: KClass<T>): Map<Player, T>

getViewersPaginatedEntry

inline fun <T : AbstractKtInventoryPaginated<*>> getViewersPaginatedEntry(): Map<Player, AbstractKtInventoryPaginated.Entry<T>>

fun <T : AbstractKtInventoryPaginated<*>> getViewersPaginatedEntry(clazz: KClass<T>): Map<Player, AbstractKtInventoryPaginated.Entry<T>>

Gets all online players currently viewing a paginated inventory entry of the specified type.

getViewersPaginatedFetchedEntry

inline fun <T : AbstractKtInventoryPaginatedFetched<*, *>> getViewersPaginatedFetchedEntry(): Map<Player, AbstractKtInventoryPaginatedFetched.Entry<*, *>>

fun <T : AbstractKtInventoryPaginatedFetched<*, *>> getViewersPaginatedFetchedEntry(clazz: KClass<T>): Map<Player, AbstractKtInventoryPaginatedFetched.Entry<*, *>>

Gets all online players currently viewing a condition-fetched paginated inventory entry of the specified type.

getViewersPaginatedLazyFetchedEntry

inline fun <T : AbstractKtInventoryPaginatedLazyFetched<*, *, *>> getViewersPaginatedLazyFetchedEntry(): Map<Player, AbstractKtInventoryPaginatedLazyFetched.Entry<*, *, *>>

fun <T : AbstractKtInventoryPaginatedLazyFetched<*, *, *>> getViewersPaginatedLazyFetchedEntry(clazz: KClass<T>): Map<Player, AbstractKtInventoryPaginatedLazyFetched.Entry<*, *, *>>

Gets all online players currently viewing a lazy-fetched paginated inventory entry of the specified type.

getViewersPaginatedSequenceEntry

inline fun <T : AbstractKtInventoryPaginatedSequence<*>> getViewersPaginatedSequenceEntry(): Map<Player, AbstractKtInventoryPaginatedSequence.Entry<T>>

fun <T : AbstractKtInventoryPaginatedSequence<*>> getViewersPaginatedSequenceEntry(clazz: KClass<T>): Map<Player, AbstractKtInventoryPaginatedSequence.Entry<T>>

Gets all online players currently viewing a sequence-backed paginated inventory entry of the specified type.