Package net.godlycow.org.essc.api.kit

Interface Kit

public interface Kit
A kit definition. Read only, get them from KitManager.

  • Method Details

    • getName

      String getName()
      Gets the kit name (lowercase).
      Returns:
      the kit name

    • getDisplayName

      String getDisplayName()
      Gets the display name shown in messages and GUIs.
      Returns:
      the display name

    • getRequiredPermission

      String getRequiredPermission()
      Gets the permission needed to claim this kit.
      Returns:
      the permission node

    • getCooldownInSeconds

      long getCooldownInSeconds()
      Gets the cooldown between claims in seconds, 0 means none.
      Returns:
      cooldown in seconds

    • isOneTimeUse

      boolean isOneTimeUse()
      Checks if this kit can only be claimed once ever.
      Returns:
      true if one time use

    • isGrantedOnFirstJoin

      boolean isGrantedOnFirstJoin()
      Checks if new players get this kit automatically.
      Returns:
      true if granted on first join

    • getMaximumClaimsAllowed

      int getMaximumClaimsAllowed()
      Gets how many times a player may claim this, -1 means unlimited.
      Returns:
      max claims allowed

    • getItemStacks

      List<org.bukkit.inventory.ItemStack> getItemStacks()
      Gets the items this kit gives.
      Returns:
      the kit items

    • getKitDescription

      String getKitDescription()
      Gets the description shown in GUIs.
      Returns:
      the kit description

    • isSynchronizedAcrossNetwork

      boolean isSynchronizedAcrossNetwork()
      Checks if this kit syncs across the network.
      Returns:
      true if network synced

    • getGuiSlot

      int getGuiSlot()
      Gets the slot in the kits GUI.
      Returns:
      GUI slot

    • getGuiPage

      int getGuiPage()
      Gets the page in the kits GUI.
      Returns:
      GUI page