wtf.nucker.kitpvpplus.api.objects

Class Ability

java.lang.Object

wtf.nucker.kitpvpplus.api.objects.Ability

public abstract class Ability
extends Object

Author:

Nucker Used to add custom abilities to the plugin

Constructor Summary

Constructors

Constructor and Description
Ability(String id, org.bukkit.inventory.ItemStack abilityItem)

Method Summary

Modifier and Type	Method and Description
protected void	decreaseItem(org.bukkit.inventory.ItemStack item) Used for deacreasing the amount of the item by one
static Ability	fromInstanceAbility(wtf.nucker.kitpvpplus.objects.Ability ability) Used to transfer a plugin instance instance ability to a api instance ability
org.bukkit.inventory.ItemStack	getAbilityItem()
String	getId()
abstract void	onActivate(org.bukkit.inventory.ItemStack item, Ability ability, org.bukkit.event.player.PlayerInteractEvent event)
protected void	putOnCooldown(org.bukkit.entity.Player player, int amount) Used for putting a player on cooldown (usually after they use the ability
static wtf.nucker.kitpvpplus.objects.Ability	toInstanceAbility(Ability ability) Used to transfer an ability to the ability class in the plugin instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ability

public Ability(String id,
               org.bukkit.inventory.ItemStack abilityItem)

Method Detail

onActivate

public abstract void onActivate(org.bukkit.inventory.ItemStack item,
                                Ability ability,
                                org.bukkit.event.player.PlayerInteractEvent event)

toInstanceAbility

public static wtf.nucker.kitpvpplus.objects.Ability toInstanceAbility(Ability ability)

Used to transfer an ability to the ability class in the plugin instance

Parameters:

ability - The API version of the ability you want to transfer

Returns:

The transferred version of the ability

fromInstanceAbility

public static Ability fromInstanceAbility(wtf.nucker.kitpvpplus.objects.Ability ability)

Used to transfer a plugin instance instance ability to a api instance ability

Parameters:

ability - the plugin version of the ability

Returns:

the api verison of the plugin

getId

public String getId()

Returns:

the id of the ability

getAbilityItem

public org.bukkit.inventory.ItemStack getAbilityItem()

Returns:

the item of the ability

decreaseItem

protected void decreaseItem(org.bukkit.inventory.ItemStack item)

Used for deacreasing the amount of the item by one

Parameters:

item - the item you wan to decrease

putOnCooldown

protected void putOnCooldown(org.bukkit.entity.Player player,
                             int amount)

Used for putting a player on cooldown (usually after they use the ability

Parameters:

player - the player your putting on cooldown

amount - the amount of seconds till the cooldown ends