Package com.sucy.skill.api.player
Class PlayerSkill
java.lang.Object
com.sucy.skill.api.player.PlayerSkill
Deprecated, for removal: This API element is subject to removal in a future version.
-
Constructor Summary
ConstructorsConstructorDescriptionPlayerSkill
(PlayerSkill _skill) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCooldown
(double seconds) Deprecated.void
addLevels
(int amount) Deprecated.UsePlayerSkill.addLevels(int)
instead.org.bukkit.Material
getBind()
Deprecated.UsePlayerSkill.getBind()
instead.long
Deprecated.UsePlayerSkill.getCooldown()
instead.int
Deprecated.UsePlayerSkill.getCooldownLeft()
instead.int
getCost()
Deprecated.UsePlayerSkill.getCost()
instead.getData()
Deprecated.UsePlayerSkill.getData()
instead.int
Deprecated.UsePlayerSkill.getInvestedCost()
instead.int
getLevel()
Deprecated.UsePlayerSkill.getLevel()
instead.int
Deprecated.UsePlayerSkill.getLevelReq()
instead.double
Deprecated.UsePlayerSkill.getManaCost()
instead.Deprecated.UsePlayerSkill.getPlayerClass()
instead.Deprecated.UsePlayerSkill.getPlayerData()
instead.int
Deprecated, for removal: This API element is subject to removal in a future version.Deprecated.UsePlayerSkill.getStatus()
instead.Deprecated, for removal: This API element is subject to removal in a future version.boolean
Deprecated.UsePlayerSkill.isExternal()
instead.boolean
isMaxed()
Deprecated.UsePlayerSkill.isMaxed()
instead.boolean
Deprecated.UsePlayerSkill.isOnCooldown()
instead.boolean
Deprecated.UsePlayerSkill.isUnlocked()
instead.void
Deprecated.UsePlayerSkill.refreshCooldown()
instead.void
revert()
Deprecated.UsePlayerSkill.revert()
instead.void
setBind
(org.bukkit.Material mat) Deprecated.UsePlayerSkill.setBind(Material)
instead.void
setCooldown
(long cooldown) Deprecated.UsePlayerSkill.setCooldown(long)
instead.void
setLevel
(int level) Deprecated.UsePlayerSkill.setLevel(int)
instead.void
Deprecated.UsePlayerSkill.startCooldown()
instead.void
Deprecated.UsePlayerSkill.startPreview()
instead.void
subtractCooldown
(double seconds) Deprecated.UsePlayerSkill.subtractCooldown(double)
instead.
-
Constructor Details
-
PlayerSkill
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
getWrapped
Deprecated, for removal: This API element is subject to removal in a future version. -
isUnlocked
Deprecated.UsePlayerSkill.isUnlocked()
instead.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.UsePlayerSkill.getData()
instead.Retrieves the template data for this skill.- Returns:
- skill template data
-
getPlayerClass
Deprecated.UsePlayerSkill.getPlayerClass()
instead.Retrieves the owning player class.- Returns:
- owning player class
-
getPlayerData
Deprecated.UsePlayerSkill.getPlayerData()
instead.Retrieves the owning player's data.- Returns:
- owning player's data
-
getBind
Deprecated.UsePlayerSkill.getBind()
instead.Retrieves the material this skill is currently bound to.- Returns:
- the current material bound to or null if not bound
-
getLevel
Deprecated.UsePlayerSkill.getLevel()
instead.Retrieves the current level the player has the skill at- Returns:
- current skill level
-
isExternal
Deprecated.UsePlayerSkill.isExternal()
instead.Retrieves whether the skill was added by an external plugin- Returns:
- whether the skill was added by an external plugin
-
getCost
Deprecated.UsePlayerSkill.getCost()
instead.Retrieves the cost to upgrade the skill to the next level- Returns:
- cost to upgrade the skill to the next level
-
getInvestedCost
Deprecated.UsePlayerSkill.getInvestedCost()
instead.- Returns:
- total invested cost in the skill
-
getManaCost
Deprecated.UsePlayerSkill.getManaCost()
instead.- Returns:
- mana cost to use the skill
-
getLevelReq
Deprecated.UsePlayerSkill.getLevelReq()
instead.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.UsePlayerSkill.isOnCooldown()
instead.Checks whether the skill is currently on cooldown- Returns:
- true if on cooldown, false otherwise
-
isMaxed
Deprecated.UsePlayerSkill.isMaxed()
instead.Checks whether the skill is at its maximum level- Returns:
- true if at max level, false otherwise
-
getCooldownLeft
Deprecated.UsePlayerSkill.getCooldownLeft()
instead.Gets the current cooldown of the skill in seconds.- Returns:
- current cooldown in seconds or 0 if not on cooldown
-
getStatus
Deprecated.UsePlayerSkill.getStatus()
instead.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.UsePlayerSkill.addLevels(int)
instead.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.UsePlayerSkill.setBind(Material)
instead.Sets the bind material of the skill- Parameters:
mat
- new bind material
-
revert
Deprecated.UsePlayerSkill.revert()
instead.Reverts the skill back to level 0, locking it from casting and refunding invested skill points -
startCooldown
Deprecated.UsePlayerSkill.startCooldown()
instead.Starts the cooldown of the skill -
refreshCooldown
Deprecated.UsePlayerSkill.refreshCooldown()
instead.Refreshes the cooldown of the skill, allowing the player to cast the skill again. -
subtractCooldown
Deprecated.UsePlayerSkill.subtractCooldown(double)
instead.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.UsePlayerSkill.addCooldown(double)
instead.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.UsePlayerSkill.startPreview()
instead.Starts the skill preview effects -
setLevel
Deprecated.UsePlayerSkill.setLevel(int)
instead.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.UsePlayerSkill.setCooldown(long)
instead.Sets the cooldown of the skill- Parameters:
cooldown
- new cooldown of the skill
-
getCooldown
Deprecated.UsePlayerSkill.getCooldown()
instead.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.
-
PlayerSkill.addCooldown(double)
instead.