Package com.vk2gpz.tokenenchant.api

Interface CEHandler

All Superinterfaces:
com.vk2gpz.mc.api.enchantment.ICEHandler, org.bukkit.event.Listener
All Known Subinterfaces:
TEBlockExplodeEnchant
All Known Implementing Classes:
EnchantHandler, PotionHandler
public interface CEHandler extends org.bukkit.event.Listener, com.vk2gpz.mc.api.enchantment.ICEHandler
CEHandler defines basic elements of all custom enchantments handled in TokenEnchant. It is just an interface. Two abstract classes EnchantHandler and PotionHandler implements this interface.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    CEHandler.Availability
     
    static class 
    CEHandler.CECommand
     
    static class 
    CEHandler.CEMinMax
     
    static enum 
    CEHandler.MergeMode
     
    static enum 
    CEHandler.PermissionMode
     

    Nested classes/interfaces inherited from interface com.vk2gpz.mc.api.enchantment.ICEHandler

    com.vk2gpz.mc.api.enchantment.ICEHandler.Cost

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ENCHANT_KEY
     
    static final String
    POTION_KEY
     
    static final Random
    rand
    A Random object, which can be used to get a random number.
    static final String
    WILDCARD
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAllowed(String allowed)
    This method will registerAddonClass the specified material to the list of allowable items for this CE;
    void
    addConflict(String enchantName)
    This method will registerAddonClass the specified enchant name to the list of conflicting enchant of this CE;
    default boolean
    applyOffHand()
     
    default org.bukkit.inventory.ItemStack
    applyPostDisEnchant(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemstack)
    If the custom enchantment/potion behave needs to carry out some special procedure right after an item is dis-enchanted, you can do so in this method.
    default org.bukkit.inventory.ItemStack
    applyPostEnchant(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemstack)
    If the custom enchantment/potion behave needs to carry out some special procedure right after an item is enchanted, you can do so in this method.
    default CEHandler
    applyPotion(org.bukkit.entity.Player player, int duration, int amplifier)
    Deprecated.
    CEHandler
    applyState(org.bukkit.entity.Player player, int duration, int amplifier)
    If the custom enchantment/potion behave like a regular potion effect, you should describe what sort of effect to be applied to a player in this method.
    static int
    calcScale(double chance)
     
    boolean
    canApply(org.bukkit.entity.Player player)
     
    default boolean
    canApplyPotion(org.bukkit.entity.Player player)
    Deprecated.
    default boolean
    canBreak(org.bukkit.entity.Player player, org.bukkit.block.Block block)
    Returns true if the specified player is allowed to break the specified block.
    default boolean
    canBreak(org.bukkit.entity.Player player, org.bukkit.block.Block block, List<org.bukkit.Material> blacklist)
     
    boolean
    canEnchantItem(org.bukkit.inventory.ItemStack item)
    This method checks whether this CE can be applied to the specified item or not.
    default boolean
    canExecute(org.bukkit.entity.Player p, int lvl)
     
    default boolean
    checkCooldown(org.bukkit.entity.Player p)
     
    boolean
    checkCooldown(org.bukkit.entity.Player p, int currentlevel)
     
    default void
    cleanup()
    If the custom enchantment/potion needs to carry out any data clearning up upon unloading, you should do so in here after invoking super.cleanup()
    This method will automatically be called when TokenEnchant plugin is disabled/reloaded.
    boolean
    conflictsWith(CEHandler handler)
     
    boolean
    conflictsWith(@NotNull org.bukkit.enchantments.Enchantment handler)
     
    default boolean
    execCommands(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... somedata)
     
    default void
    finalizeProcess(boolean immediate, org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... data)
     
    default void
    finalizeProcess(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... data)
     
    default boolean
    forceCustomModelData()
     
    String
    getAlias()
    Reads the alias name of this custom enchantment from config.yml if it's specified under "alias:", null otherwise.
    int
    getBase()
    It returns the base enchant level.
    default org.bukkit.Sound
    getCastingSound()
     
    default float
    getCastingSoundPitch()
     
    default float
    getCastingSoundVolume()
     
    int
    getCELevel(org.bukkit.entity.Player p)
    If a player is holding an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
    int
    getCELevel(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack itemStack)
    It returns the level of this enchantment on the specified item.
    int
    getCELevel(org.bukkit.inventory.ItemStack item)
    If a player is holding an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
    int
    getCELevelOnAllArmor(org.bukkit.entity.Player p)
    If a player is wearing an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
    int
    getCELevelOnArmor(org.bukkit.entity.Player p)
    If a player is wearing an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
    org.bukkit.configuration.file.FileConfiguration
    getConfig()
     
    default org.bukkit.configuration.file.FileConfiguration
    getConfigInstance(org.bukkit.plugin.Plugin plugin, String key, Class<?> baseClass)
     
    Set<String>
    getConflicts()
     
    int
    getCooldown()
    It returns the maximum cooldown.
    String
    getCooldownFormula()
    It returns the id for a function, which is defined in OccurrenceFormulae.js
    String
    getCostFormula()
    It returns the id for cost function, which is defined in OccurrenceFormulae.js (or CostFormulae.js, in old version)
    double[]
    getCostParams()
     
    default int
    getCustomModelData(org.bukkit.Material material)
     
    String
    getDescription()
    It returns the description of this effect.
    default String
    getDisplayName()
    returns the name used to display.
    int
    getDuration()
    This method returns the duration of a potion effect if any.
    int
    getDurationMultiplier()
    This method returns the duration multiplier of a potion effect if any.
    default org.bukkit.Sound
    getEffectSound()
     
    default float
    getEffectSoundPitch()
     
    default float
    getEffectSoundVolume()
     
    default com.vk2gpz.mc.api.enchantment.Enchantable
    getEnchantable()
     
    double
    getEnchantChance()
    It returns the enchantment chance for this effect.
    com.vk2gpz.mc.api.enchantment.EnchantmentSlotType
    getEnchantmentSlotType()
     
    com.vk2gpz.mc.api.enchantment.EnumItemSlot[]
    getEnumItemSlots()
     
    int
    getETMax()
    It returns the max enchant level for using the Enchantment Table.
    default String
    getFriendlyName()
     
    int
    getInterval()
    It returns the interval of effect increase.
    org.bukkit.enchantments.EnchantmentTarget
    getItemTarget()
     
    String
    getKey()
     
    default int
    getLevel(String lore)
    This method checks the given string and determine whehterh it starts its this enchant's name or alias, and returns the indicated level of enchantment.
    default List<String>
    getLFDescription(String... prefixformat)
    This method returns the description of this enchant in the form of String list the description will be broken up into multiple lines based on '/n'.
    default String
    getLoreEntry(int level, boolean useRoman, boolean pureRoman, String disabledString)
     
    default String
    getLoreEntry(int level, boolean pureRoman, String disabledString)
     
    default com.vk2gpz.mc.api.enchantment.ICEHandler.Cost
    getMaxCostRange()
     
    int
    getMaxLevel()
    It returns the max enchant level.
    int
    getMergeMax()
    It returns the max merged enchant level.
    CEHandler.MergeMode
    getMergeMode()
    It returns the merge mode.
    default com.vk2gpz.mc.api.enchantment.ICEHandler.Cost
    getMinCostRange()
     
    double
    getMinimumOccurrence()
    It returns the minimum chance of occurrence.
    default String
    getName()
    Returns the name of this custom enchantment/potion.
    double
    getOccurrence()
    It returns the chance of occurrence at the max level.
    String
    getOccurrenceFormula()
    It returns the id for a function, which is defined in OccurrenceFormulae.js
    List<String>
    getOldAliases()
     
    CEHandler.PermissionMode
    getPermissionMode()
    The use of permission node.
    String
    getPermissionNode()
    Given a common/alias name or official name of an enchantment, it returns the permission node of the specified PotionEffectType object.
    default int
    getPermittedMaxLevel(@NotNull org.bukkit.entity.Player p)
     
    org.bukkit.plugin.Plugin
    getPlugin()
     
    org.bukkit.potion.PotionEffectType
    getPotionEffectType()
     
    double
    getPrice()
    It returns the base price.
    com.vk2gpz.mc.enchantment.Rarity
    getRarity()
     
    default String
    getRealName(String name)
    Given a common/alias name of an enchantment, it returns the offical name of the enchantment listed under "Potions:" section in the config.yml.
    double
    getRefundRate()
    It returns the refund rate.
    default String
    getRegisteredName(String name)
     
    int
    getScale()
    It returns the scale of the encahntment level.
    default int
    getStartLevel()
     
    ITokenEnchant
    getTE()
     
    String
    getVersion()
    Returns the version of this custom enchantment
    boolean
    hasConflictWith(String enchantName)
    This method checks whether this CE conflicts with the specified enchant.
    default boolean
    isAlias(String alias)
    Returns true if the specified name is an alias.
    default boolean
    isAllowed(org.bukkit.entity.Player p)
    A utility method to return whether the specified player has the permission or not.
    static boolean
    isAllowed(org.bukkit.permissions.Permissible p, String perm)
    A utility method to return whether the specified player has the specified permission or not.
    default boolean
    isAvailable(CEHandler.Availability availability)
     
    default boolean
    isCursed()
     
    boolean
    isEnabled()
     
    default boolean
    isEnchantTabled()
    Deprecated.
    default boolean
    isFishing()
    Deprecated.
    default boolean
    isHidden()
     
    default boolean
    isInstant()
    Returns true always.
    default boolean
    isLoot()
    Deprecated.
    default boolean
    isRefundable()
    It returns whether this enchant is refundable or nor
    boolean
    isRegistered()
     
    default boolean
    isTreasure()
    Deprecated.
    boolean
    isValid(org.bukkit.Location location)
    Returns true if the specified player is allowed to use the specified enchantment at the specified location.
    default boolean
    isVanilla()
     
    default boolean
    isVillagerTrade()
    Deprecated.
    void
    loadConfig()
    If the custom enchantment/potion needs to load any configuration informaiton from config.yml, config loading process should be written in this method.
    default void
    playCastingSound(org.bukkit.Location location)
     
    default boolean
    playEffectSoundPlayerOnly()
     
    default void
    playSound(org.bukkit.entity.Player player, org.bukkit.Location location)
     
    default void
    playSound(org.bukkit.Location location)
     
    default void
    registerAlias(Map<String,String> map)
     
    void
    remove(org.bukkit.entity.Player player)
     
    void
    removeAllowed(String allowed)
    This method will remove the specified material from the list of allowable items for this CE;
    void
    removeConflict(String enchantName)
    This method will remove the specified enchant name from the list of conflict.
    default void
    removePotion(org.bukkit.entity.Player player)
    Deprecated.
    default boolean
    removePotion(org.bukkit.entity.Player player, int level)
    Deprecated.
    boolean
    removeState(org.bukkit.entity.Player player, int level)
     
    default boolean
    requirFullArmor()
     
    void
    resetCooldown(org.bukkit.entity.Player p)
     
    default void
    sendMessage(org.bukkit.entity.Player p, String message)
     
    void
    setCustomModelDataMap(Map<org.bukkit.Material,Integer> cmd_map)
     
    void
    setForceCustomModelData(boolean force)
     
    void
    setPotionEffectType(org.bukkit.potion.PotionEffectType potionEffectType)
     
    default boolean
    shouldProceed(org.bukkit.entity.Player p, int lvl, org.bukkit.Location loc)
     
    default boolean
    showDescription()
     
    default boolean
    useActionBar()
    This method returns true if this CE is to use the action bar for messaging.
    boolean
    useRomanNumeral()
     

    Methods inherited from interface com.vk2gpz.mc.api.enchantment.ICEHandler

    getEnchantment, getSupportedItems, setEnchantment

  • Field Details

  • Method Details

    • getKey

      String getKey()

    • getConfig

      org.bukkit.configuration.file.FileConfiguration getConfig()

    • getPlugin

      org.bukkit.plugin.Plugin getPlugin()

    • getTE

      ITokenEnchant getTE()

    • getName

      default String getName()
      Returns the name of this custom enchantment/potion.
      Specified by:
      getName in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Returns:
      the name of this custom enchantment/potion.

    • getLoreEntry

      default String getLoreEntry(int level, boolean useRoman, boolean pureRoman, String disabledString)

    • getLoreEntry

      default String getLoreEntry(int level, boolean pureRoman, String disabledString)

    • getVersion

      String getVersion()
      Returns the version of this custom enchantment
      Returns:
      the version of this custom enchantment

    • isEnabled

      boolean isEnabled()

    • checkCooldown

      boolean checkCooldown(org.bukkit.entity.Player p, int currentlevel)

    • resetCooldown

      void resetCooldown(org.bukkit.entity.Player p)

    • isCursed

      default boolean isCursed()

    • addAllowed

      void addAllowed(String allowed)
      This method will registerAddonClass the specified material to the list of allowable items for this CE;
      Parameters:
      allowed - allowed material name

    • removeAllowed

      void removeAllowed(String allowed)
      This method will remove the specified material from the list of allowable items for this CE;
      Parameters:
      allowed - allowed material name

    • canEnchantItem

      boolean canEnchantItem(org.bukkit.inventory.ItemStack item)
      This method checks whether this CE can be applied to the specified item or not.
      Specified by:
      canEnchantItem in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Parameters:
      item - The item to be examined.
      Returns:
      true if this CE can be applied to thhe specified item

    • addConflict

      void addConflict(String enchantName)
      This method will registerAddonClass the specified enchant name to the list of conflicting enchant of this CE;
      Parameters:
      enchantName - enchant name to be registered

    • removeConflict

      void removeConflict(String enchantName)
      This method will remove the specified enchant name from the list of conflict.
      Parameters:
      enchantName - enchant name to be removed.

    • hasConflictWith

      boolean hasConflictWith(String enchantName)
      This method checks whether this CE conflicts with the specified enchant.
      Parameters:
      enchantName - The item to be examined.
      Returns:
      true if this CE conflicts with the specified enchant.

    • getConflicts

      Set<String> getConflicts()

    • isAlias

      default boolean isAlias(String alias)
      Returns true if the specified name is an alias.
      Parameters:
      alias - a name to be checked.
      Returns:
      true if the specified alias represents this custom enchantment.

    • getDisplayName

      default String getDisplayName()
      returns the name used to display.
      Returns:
      the name used to display.

    • getFriendlyName

      default String getFriendlyName()
      Specified by:
      getFriendlyName in interface com.vk2gpz.mc.api.enchantment.ICEHandler

    • getStartLevel

      default int getStartLevel()
      Specified by:
      getStartLevel in interface com.vk2gpz.mc.api.enchantment.ICEHandler

    • getItemTarget

      org.bukkit.enchantments.EnchantmentTarget getItemTarget()

    • conflictsWith

      boolean conflictsWith(@NotNull @NotNull org.bukkit.enchantments.Enchantment handler)
      Specified by:
      conflictsWith in interface com.vk2gpz.mc.api.enchantment.ICEHandler

    • conflictsWith

      boolean conflictsWith(CEHandler handler)

    • getAlias

      String getAlias()
      Reads the alias name of this custom enchantment from config.yml if it's specified under "alias:", null otherwise.
      Returns:
      the alias name of this custom enchantment from config.yml if it's specified under "alias:", null otherwise.

    • getOldAliases

      List<String> getOldAliases()

    • getRegisteredName

      default String getRegisteredName(String name)

    • getRealName

      default String getRealName(String name)
      Given a common/alias name of an enchantment, it returns the offical name of the enchantment listed under "Potions:" section in the config.yml.
      Parameters:
      name - common/alias name of the enchantment.
      Returns:
      the official name of the enchantment.

    • isValid

      boolean isValid(org.bukkit.Location location)
      Returns true if the specified player is allowed to use the specified enchantment at the specified location. This method checks "world" names where the enchantment is allowed or not.
      Parameters:
      location - the location where this enchantment is used.
      Returns:
      true if the specified player is allowed to use the specified enchantment at the specified location.

    • getPermissionNode

      String getPermissionNode()
      Given a common/alias name or official name of an enchantment, it returns the permission node of the specified PotionEffectType object.
      Returns:
      the permission node.

    • getPermissionMode

      CEHandler.PermissionMode getPermissionMode()
      The use of permission node. ENCHANT : a user with a permission can enchant and use an item. USE : a user with a permission can use the enchantment but not apply the enchantment..
      Returns:
      the permission mode.

    • getEnchantChance

      double getEnchantChance()
      It returns the enchantment chance for this effect.
      Returns:
      the enchantment chance.

    • showDescription

      default boolean showDescription()

    • getDescription

      String getDescription()
      It returns the description of this effect.
      Returns:
      the description.

    • getLFDescription

      default List<String> getLFDescription(String... prefixformat)
      This method returns the description of this enchant in the form of String list the description will be broken up into multiple lines based on '/n'.
      Parameters:
      prefixformat - format.
      Returns:
      the description of this enchantment.

    • getMergeMode

      CEHandler.MergeMode getMergeMode()
      It returns the merge mode.
      Returns:
      the merge node.

    • getMaxLevel

      int getMaxLevel()
      It returns the max enchant level.
      Specified by:
      getMaxLevel in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Returns:
      the max enchant level.

    • getScale

      int getScale()
      It returns the scale of the encahntment level.
      Returns:
      the scale of the encahntment level.

    • getMergeMax

      int getMergeMax()
      It returns the max merged enchant level.
      Returns:
      the max merged enchant level.

    • getETMax

      int getETMax()
      It returns the max enchant level for using the Enchantment Table.
      Returns:
      the max enchantment table enchant level.

    • getInterval

      int getInterval()
      It returns the interval of effect increase.
      Returns:
      the interval value.

    • getBase

      int getBase()
      It returns the base enchant level.
      Returns:
      the interval value.

    • getPrice

      double getPrice()
      It returns the base price.
      Returns:
      the base price.

    • getCostFormula

      String getCostFormula()
      It returns the id for cost function, which is defined in OccurrenceFormulae.js (or CostFormulae.js, in old version)
      Returns:
      the id for cost function, which is defined in OccurrenceFormulae.js (or CostFormulae.js, in old version)

    • getCostParams

      double[] getCostParams()

    • isRefundable

      default boolean isRefundable()
      It returns whether this enchant is refundable or nor
      Returns:
      true if it is refundable

    • getRefundRate

      double getRefundRate()
      It returns the refund rate.
      Returns:
      the refund rate. if it is a negative value, it is not refundable.

    • getOccurrenceFormula

      String getOccurrenceFormula()
      It returns the id for a function, which is defined in OccurrenceFormulae.js
      Returns:
      the id for a function, which is defined in OccurrenceFormulae.js

    • getCooldownFormula

      String getCooldownFormula()
      It returns the id for a function, which is defined in OccurrenceFormulae.js
      Returns:
      the id for a function, which is defined in OccurrenceFormulae.js

    • getCELevel

      int getCELevel(org.bukkit.inventory.ItemStack item)
      If a player is holding an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
      Parameters:
      item - An ItemStack object the player has.
      Returns:
      return the level of enchantment.

    • getCELevel

      int getCELevel(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack itemStack)
      It returns the level of this enchantment on the specified item. If a player has a permission node indicating the encant ment level, the returned level will be capped at that value.
      Parameters:
      p - Player whose item is examined for the specified enchant.
      itemStack - an item, to be examined.
      Returns:
      return the level of this enchantment on the item with palyer's permisison level.

    • getCELevel

      int getCELevel(org.bukkit.entity.Player p)
      If a player is holding an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
      Parameters:
      p - Player whose item is examined for the specified enchant.
      Returns:
      return the level of this enchantment.

    • getCELevelOnArmor

      int getCELevelOnArmor(org.bukkit.entity.Player p)
      If a player is wearing an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
      Parameters:
      p - Player whose armor is examined for the specified enchant.
      Returns:
      return the level of this enchantment.

    • getCELevelOnAllArmor

      int getCELevelOnAllArmor(org.bukkit.entity.Player p)
      If a player is wearing an item with the effect represented by the specified CEHandler, it returns the level of this enchantment.
      Parameters:
      p - Player whose armor is examined for the specified enchant.
      Returns:
      return the level of this enchantment.

    • applyPostEnchant

      default org.bukkit.inventory.ItemStack applyPostEnchant(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemstack)
      If the custom enchantment/potion behave needs to carry out some special procedure right after an item is enchanted, you can do so in this method.
      Parameters:
      player - A player whom this potion will be applied to
      itemstack - the itemstack the player has just enchanted.
      Returns:
      itemstack the itemstack the player has just enchanted.

    • applyPostDisEnchant

      default org.bukkit.inventory.ItemStack applyPostDisEnchant(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemstack)
      If the custom enchantment/potion behave needs to carry out some special procedure right after an item is dis-enchanted, you can do so in this method.
      Parameters:
      player - A player whom this potion will be applied to
      itemstack - the itemstack the player has just enchanted.
      Returns:
      itemstack the itemstack the player has just enchanted.

    • getOccurrence

      double getOccurrence()
      It returns the chance of occurrence at the max level.
      Returns:
      the occurrence at the max level.

    • getMinimumOccurrence

      double getMinimumOccurrence()
      It returns the minimum chance of occurrence.
      Returns:
      the minimum occurrence.

    • checkCooldown

      default boolean checkCooldown(org.bukkit.entity.Player p)

    • getCooldown

      int getCooldown()
      It returns the maximum cooldown.
      Returns:
      the maximum cooldown.

    • shouldProceed

      default boolean shouldProceed(org.bukkit.entity.Player p, int lvl, org.bukkit.Location loc)

    • canExecute

      default boolean canExecute(org.bukkit.entity.Player p, int lvl)

    • isVanilla

      default boolean isVanilla()

    • getPotionEffectType

      org.bukkit.potion.PotionEffectType getPotionEffectType()

    • setPotionEffectType

      void setPotionEffectType(org.bukkit.potion.PotionEffectType potionEffectType)

    • isRegistered

      boolean isRegistered()

    • getConfigInstance

      default org.bukkit.configuration.file.FileConfiguration getConfigInstance(org.bukkit.plugin.Plugin plugin, String key, Class<?> baseClass)

    • canBreak

      default boolean canBreak(org.bukkit.entity.Player player, org.bukkit.block.Block block)
      Returns true if the specified player is allowed to break the specified block.
      Parameters:
      player - the player to be checked.
      block - to be checked.
      Returns:
      true if the specified player is allowed to break the specified block, false otherwise.

    • canBreak

      default boolean canBreak(org.bukkit.entity.Player player, org.bukkit.block.Block block, List<org.bukkit.Material> blacklist)

    • isAllowed

      default boolean isAllowed(org.bukkit.entity.Player p)
      A utility method to return whether the specified player has the permission or not.
      Parameters:
      p - a plaer to be checked.
      Returns:
      true if the player has the permission, false otherwise

    • isInstant

      default boolean isInstant()
      Returns true always.
      Returns:
      true

    • isAllowed

      static boolean isAllowed(org.bukkit.permissions.Permissible p, String perm)
      A utility method to return whether the specified player has the specified permission or not.
      Parameters:
      p - a plaer to be checked.
      perm - a permission node to be checked.
      Returns:
      true if the player has the permission, false otherwise

    • loadConfig

      void loadConfig()
      If the custom enchantment/potion needs to load any configuration informaiton from config.yml, config loading process should be written in this method.

      This method will automatically be called when TokenEnchant plugin is loaded.

    • cleanup

      default void cleanup()
      If the custom enchantment/potion needs to carry out any data clearning up upon unloading, you should do so in here after invoking super.cleanup()
      This method will automatically be called when TokenEnchant plugin is disabled/reloaded.

    • registerAlias

      default void registerAlias(Map<String,String> map)

    • applyPotion

      @Deprecated default CEHandler applyPotion(org.bukkit.entity.Player player, int duration, int amplifier)
      Deprecated.
      If the custom enchantment/potion behave like a regular potion effect, you should describe what sort of effect to be applied to a player in this method. This method will automatically be called when a player hold an item with this enchantment.
      Parameters:
      player - A player whom this potion will be applied to
      duration - A duration of this potion effect being applied to
      amplifier - An amplifier of this potion effect being applied to
      Returns:
      this CEHandler, if this CEHandler did apply a PotionEffectType.

    • applyState

      CEHandler applyState(org.bukkit.entity.Player player, int duration, int amplifier)
      If the custom enchantment/potion behave like a regular potion effect, you should describe what sort of effect to be applied to a player in this method. This method will automatically be called when a player hold an item with this enchantment.
      Parameters:
      player - A player whom this potion will be applied to
      duration - A duration of this potion effect being applied to
      amplifier - An amplifier of this potion effect being applied to
      Returns:
      this CEHandler, if this CEHandler did apply a PotionEffectType.

    • canApplyPotion

      @Deprecated default boolean canApplyPotion(org.bukkit.entity.Player player)
      Deprecated.

    • canApply

      boolean canApply(org.bukkit.entity.Player player)

    • removePotion

      @Deprecated default void removePotion(org.bukkit.entity.Player player)
      Deprecated.
      If the custom enchantment/potion behave like a regular potion effect, you should describe how the custom potion effects should be disabled in this method. This method will automatically be called when a player no longer hold an item with this enchantment.
      Parameters:
      player - A player whom this potion will be applied to

    • remove

      void remove(org.bukkit.entity.Player player)

    • removePotion

      @Deprecated default boolean removePotion(org.bukkit.entity.Player player, int level)
      Deprecated.

    • removeState

      boolean removeState(org.bukkit.entity.Player player, int level)

    • getDuration

      int getDuration()
      This method returns the duration of a potion effect if any.
      Returns:
      the duration of a potion effect if any.

    • getDurationMultiplier

      int getDurationMultiplier()
      This method returns the duration multiplier of a potion effect if any.
      Returns:
      the duration multiplier of a potion effect if any.

    • getRarity

      com.vk2gpz.mc.enchantment.Rarity getRarity()
      Returns:
      the rarity of the enchantment

    • isAvailable

      default boolean isAvailable(CEHandler.Availability availability)

    • isTreasure

      @Deprecated default boolean isTreasure()
      Deprecated.
      Checks if this enchantment is a treasure enchantment. Treasure enchantments can only be received via looting, trading, or fishing.
      Specified by:
      isTreasure in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Returns:
      true if the enchantment is a treasure enchantment

    • isEnchantTabled

      @Deprecated default boolean isEnchantTabled()
      Deprecated.
      Checks if this enchantment is available for the enchantment table.
      Returns:
      true if the enchantment is abailable for the enchantment table.

    • isLoot

      @Deprecated default boolean isLoot()
      Deprecated.
      Checks if this enchantment is available for the loot chest.
      Returns:
      true if the enchantment is abailable for the loot chest.

    • isVillagerTrade

      @Deprecated default boolean isVillagerTrade()
      Deprecated.
      Checks if this enchantment is available for the villager trade.
      Returns:
      true if the enchantment is abailable for the villager trade.

    • isFishing

      @Deprecated default boolean isFishing()
      Deprecated.
      Checks if this enchantment is available for the fishing.
      Returns:
      true if the enchantment is abailable for the fishing.

    • getEnchantmentSlotType

      com.vk2gpz.mc.api.enchantment.EnchantmentSlotType getEnchantmentSlotType()
      Specified by:
      getEnchantmentSlotType in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Returns:
      the EnchantmentSlotType

    • getEnumItemSlots

      com.vk2gpz.mc.api.enchantment.EnumItemSlot[] getEnumItemSlots()
      Returns:
      the array of EnumItemSlot

    • getLevel

      default int getLevel(String lore)
      This method checks the given string and determine whehterh it starts its this enchant's name or alias, and returns the indicated level of enchantment.
      Parameters:
      lore - a string which might start with this CE's name or alias.
      Returns:
      the level of enchant indicated in the specified string, otherwise -1 indicating no enchantment

    • useActionBar

      default boolean useActionBar()
      This method returns true if this CE is to use the action bar for messaging.
      Returns:
      true if this CE is to use the action bar for messaging.

    • sendMessage

      default void sendMessage(org.bukkit.entity.Player p, String message)

    • applyOffHand

      default boolean applyOffHand()

    • isHidden

      default boolean isHidden()

    • forceCustomModelData

      default boolean forceCustomModelData()

    • setForceCustomModelData

      void setForceCustomModelData(boolean force)

    • getCustomModelData

      default int getCustomModelData(org.bukkit.Material material)

    • setCustomModelDataMap

      void setCustomModelDataMap(Map<org.bukkit.Material,Integer> cmd_map)

    • getEffectSound

      default org.bukkit.Sound getEffectSound()

    • getEffectSoundVolume

      default float getEffectSoundVolume()

    • getEffectSoundPitch

      default float getEffectSoundPitch()

    • playEffectSoundPlayerOnly

      default boolean playEffectSoundPlayerOnly()

    • playSound

      default void playSound(org.bukkit.Location location)

    • playSound

      default void playSound(org.bukkit.entity.Player player, org.bukkit.Location location)

    • getCastingSound

      default org.bukkit.Sound getCastingSound()

    • getCastingSoundVolume

      default float getCastingSoundVolume()

    • getCastingSoundPitch

      default float getCastingSoundPitch()

    • playCastingSound

      default void playCastingSound(org.bukkit.Location location)

    • useRomanNumeral

      boolean useRomanNumeral()

    • execCommands

      default boolean execCommands(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... somedata)

    • finalizeProcess

      default void finalizeProcess(boolean immediate, org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... data)

    • finalizeProcess

      default void finalizeProcess(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack item, int level, org.bukkit.Location loc, Object... data)

    • calcScale

      static int calcScale(double chance)

    • requirFullArmor

      default boolean requirFullArmor()

    • getPermittedMaxLevel

      default int getPermittedMaxLevel(@NotNull @NotNull org.bukkit.entity.Player p)

    • getMinCostRange

      default com.vk2gpz.mc.api.enchantment.ICEHandler.Cost getMinCostRange()
      Specified by:
      getMinCostRange in interface com.vk2gpz.mc.api.enchantment.ICEHandler

    • getMaxCostRange

      default com.vk2gpz.mc.api.enchantment.ICEHandler.Cost getMaxCostRange()
      Specified by:
      getMaxCostRange in interface com.vk2gpz.mc.api.enchantment.ICEHandler

    • getEnchantable

      default com.vk2gpz.mc.api.enchantment.Enchantable getEnchantable()
      Specified by:
      getEnchantable in interface com.vk2gpz.mc.api.enchantment.ICEHandler
      Returns:
      the Enchantable