Class PlayerSkill

java.lang.Object
com.sucy.skill.api.player.PlayerSkill

@Deprecated(forRemoval=true) public class PlayerSkill extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
  • Constructor Details

    • PlayerSkill

      public PlayerSkill(PlayerSkill _skill)
      Deprecated, for removal: This API element is subject to removal in a future version.
  • Method Details

    • getWrapped

      public PlayerSkill getWrapped()
      Deprecated, for removal: This API element is subject to removal in a future version.
    • isUnlocked

      @Deprecated public boolean isUnlocked()
      Deprecated.
      Checks whether the skill is currently unlocked for the player. This requires the skill to be at least level 1.
      Returns:
      true if unlocked, false otherwise
    • getData

      @Deprecated public Skill getData()
      Deprecated.
      Retrieves the template data for this skill.
      Returns:
      skill template data
    • getPlayerClass

      @Deprecated public PlayerClass getPlayerClass()
      Deprecated.
      Retrieves the owning player class.
      Returns:
      owning player class
    • getPlayerData

      @Deprecated public PlayerData getPlayerData()
      Deprecated.
      Retrieves the owning player's data.
      Returns:
      owning player's data
    • getBind

      @Deprecated public org.bukkit.Material getBind()
      Deprecated.
      Retrieves the material this skill is currently bound to.
      Returns:
      the current material bound to or null if not bound
    • getLevel

      @Deprecated public int getLevel()
      Deprecated.
      Retrieves the current level the player has the skill at
      Returns:
      current skill level
    • isExternal

      @Deprecated public boolean isExternal()
      Deprecated.
      Retrieves whether the skill was added by an external plugin
      Returns:
      whether the skill was added by an external plugin
    • getCost

      @Deprecated public int getCost()
      Deprecated.
      Retrieves the cost to upgrade the skill to the next level
      Returns:
      cost to upgrade the skill to the next level
    • getInvestedCost

      @Deprecated public int getInvestedCost()
      Deprecated.
      Returns:
      total invested cost in the skill
    • getManaCost

      @Deprecated public double getManaCost()
      Deprecated.
      Returns:
      mana cost to use the skill
    • getLevelReq

      @Deprecated public int getLevelReq()
      Deprecated.
      Retrieves the level requirement of the skill to get to the next level
      Returns:
      the level requirement to get to the next level
    • isOnCooldown

      @Deprecated public boolean isOnCooldown()
      Deprecated.
      Checks whether the skill is currently on cooldown
      Returns:
      true if on cooldown, false otherwise
    • isMaxed

      @Deprecated public boolean isMaxed()
      Deprecated.
      Checks whether the skill is at its maximum level
      Returns:
      true if at max level, false otherwise
    • getCooldownLeft

      @Deprecated public int getCooldownLeft()
      Deprecated.
      Gets the current cooldown of the skill in seconds.
      Returns:
      current cooldown in seconds or 0 if not on cooldown
    • getStatus

      @Deprecated public SkillStatus getStatus()
      Deprecated.
      Retrieves the current ready status of the skill which could be on cooldown, missing mana, or ready.
      Returns:
      the ready status of the skill
    • addLevels

      @Deprecated public void addLevels(int amount)
      Deprecated.
      Adds levels to the skill. This will not update passive effects. To level up/down the skill properly, use the upgrade and downgrade methods in PlayerData.
      Parameters:
      amount - number of levels to add
    • setBind

      @Deprecated public void setBind(org.bukkit.Material mat)
      Deprecated.
      Sets the bind material of the skill
      Parameters:
      mat - new bind material
    • revert

      @Deprecated public void revert()
      Deprecated.
      Reverts the skill back to level 0, locking it from casting and refunding invested skill points
    • startCooldown

      @Deprecated public void startCooldown()
      Deprecated.
      Starts the cooldown of the skill
    • refreshCooldown

      @Deprecated public void refreshCooldown()
      Deprecated.
      Refreshes the cooldown of the skill, allowing the player to cast the skill again.
    • subtractCooldown

      @Deprecated public void subtractCooldown(double seconds)
      Deprecated.
      Subtracts from the current cooldown time, shortening the time until it can be cast again.
      Parameters:
      seconds - number of seconds to subtract from the cooldown
    • addCooldown

      @Deprecated public void addCooldown(double seconds)
      Deprecated.
      Adds to the current cooldown time, lengthening the time until it can be cast again.
      Parameters:
      seconds - number of seconds to add to the cooldown
    • startPreview

      @Deprecated public void startPreview()
      Deprecated.
      Starts the skill preview effects
    • setLevel

      @Deprecated public void setLevel(int level)
      Deprecated.
      Sets the level of the skill. This will not update passive effects. To level up/down the skill properly, use the upgrade and downgrade methods in PlayerData.
      Parameters:
      level - new level of the skill
    • setCooldown

      @Deprecated public void setCooldown(long cooldown)
      Deprecated.
      Sets the cooldown of the skill
      Parameters:
      cooldown - new cooldown of the skill
    • getCooldown

      @Deprecated public long getCooldown()
      Deprecated.
      Gets the cooldown of the skill
      Returns:
      the cooldown of the skill
    • getPoints

      public int getPoints()
      Deprecated, for removal: This API element is subject to removal in a future version.