vital-items/dev.vitalframework.items/VitalItem

VitalItem

Defines an interactable item within the Vital-Framework.

@VitalItem.Info(
  name = "MyItem",
  type = Material.STONE
)
public class MyItem extends VitalItem {
  @Override
  public void onLeftClick(PlayerInteractEvent e) {
    // ...
  }

  @Override
  public void onRightClick(PlayerInteractEvent e) {
    // ...
  }

  @Override
  public void onCooldown(PlayerInteractEvent e) {
    // ...
  }

  @Override
  public void onCooldownExpire(Player player) {
    // ...
  }

  @Override
  public void onCooldownTick(Player player) {
    // ...
  }
}

Constructors

VitalItem

constructor()

Types

Info

@Component

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Info(val type: Material, val name: String, val lore: Array<String> = [], val cooldown: Int = 0, val itemFlags: Array<ItemFlag> = [], val amount: Int = 1, val glint: Boolean = false, val unbreakable: Boolean = true)

Defines the info for a VitalItem.

Properties

info

open override val info: MutableMap<Class<VitalItem.Info>, VitalItem.Info>

playerCooldown

val playerCooldown: MutableMap<UUID, Int>

The cooldowns for each player of this item. Once the cooldown for a player expires, the player will be removed from this Map.

uniqueId

val uniqueId: UUID

This id is required to identify a single VitalItem during event processing and delegation.

Functions

equals

open operator override fun equals(other: Any?): Boolean

getInfo

open fun <T : Annotation> getInfo(type: Class<T>): T

getItemStack

fun getItemStack(player: SpigotPlayer): ItemStack

Gets the ItemStack for the given player.

handleInteraction

fun handleInteraction(e: PlayerInteractEvent)

Internal function to handle the given PlayerInteractEvent for this item. This function handles all lifecycle functions of this item and the cooldown logic.

onCooldown

open fun onCooldown(e: PlayerInteractEvent)

Lifecycle function; called when this item is left- or right-clicked by a player and the player's cooldown is currently active.

onCooldownExpire

open fun onCooldownExpire(player: SpigotPlayer)

Lifecycle function; called when this item's cooldown expires for a player. This function is also called when a player doesn't have this item equipped.

onCooldownTick

open fun onCooldownTick(player: SpigotPlayer)

Lifecycle function; called when the cooldown task ticks the cooldown for this item and a given player. This function is also called when a player doesn't have this item equipped.

onLeftClick

open fun onLeftClick(e: PlayerInteractEvent)

Lifecycle function; called when this item is right-clicked by a player and the player's cooldown is not active.

onRightClick

open fun onRightClick(e: PlayerInteractEvent)

Lifecycle function; called when this item is left-clicked by a player and the player's cooldown is not active.

toString

open override fun toString(): String