rebar

1.0.0-SNAPSHOT

rebar/io.github.pylonmc.rebar.item.base/RebarInventoryEffectItem

RebarInventoryEffectItem

interface RebarInventoryEffectItem : RebarInventoryTicker(source)

Types

object Companion

Properties

open val itemKey: NamespacedKey

abstract val tickInterval: Long

Determines the rate at which the onTick method will be called. onTick will be called at tickInterval * RebarConfig.INVENTORY_TICKER_BASE_RATE

Functions

onAddedToInventory

@MustBeInvokedByOverriders

open fun onAddedToInventory(player: Player)

Apply the effect of this item onto the player

onRemovedFromInventory

@MustBeInvokedByOverriders

open fun onRemovedFromInventory(player: Player)

Remove the effect from the player. Best-effort removal therefore is no guarantee that the player is still connected or that the RebarItem.stack is up to date with the actual ItemStack when it runs.

@MustBeInvokedByOverriders

open override fun onTick(player: Player)

Called when the item is detected in the player's inventory. will be called at tickInterval * [RebarConfig.inventoryTickerBaseRate