Ability

All Known Implementing Classes:

AcrobatStance, AirAbility, AirBlast, AirBubble, AirBurst, AirCombo, AirCombo.AirStream, AirCombo.AirSweep, AirCombo.Twister, AirFlight, AirScooter, AirShield, AirSpout, AirSuction, AirSwipe, AvatarAbility, AvatarState, Blaze, BlazeArc, BlazeRing, BloodAbility, Bloodbending, Catapult, ChiAbility, ChiCombo, ChiCombo.Immobilize, Collapse, CollapseWall, Combustion, CombustionAbility, CoreAbility, EarthAbility, EarthArmor, EarthBlast, EarthGrab, EarthSmash, EarthTunnel, ElementalAbility, Extraction, FireAbility, FireBlast, FireBlastCharged, FireBurst, FireCombo, FireCombo.FireKick, FireCombo.FireSpin, FireCombo.FireWheel, FireCombo.JetBlast, FireCombo.JetBlaze, FireJet, FireShield, FlightAbility, HealingAbility, HealingWaters, HeatControlCook, HeatControlExtinguish, HeatControlMelt, HeatControlSolidify, HighJump, IceAbility, IceBlast, IceSpikeBlast, IceSpikePillar, IceSpikePillarField, Illumination, LavaAbility, LavaFlow, LavaSurge, LavaSurgeWall, LavaSurgeWave, Lightning, LightningAbility, MetalAbility, MetalClips, OctopusForm, Paralyze, PhaseChangeFreeze, PhaseChangeMelt, PlantAbility, PlantArmor, PlantRegrowth, QuickStrike, RaiseEarth, RaiseEarthWall, RapidPunch, Ripple, SandAbility, SandSpout, Shockwave, Smokescreen, SpiritualAbility, Suffocate, SurgeWall, SurgeWave, SwiftKick, Tornado, Torrent, TorrentWave, Tremorsense, WallOfFire, WarriorStance, WaterAbility, WaterArms, WaterArmsFreeze, WaterArmsSpear, WaterArmsWhip, WaterBubble, WaterCombo, WaterCombo.IceBullet, WaterCombo.IceWave, WaterManipulation, WaterReturn, WaterSpout, WaterSpoutWave
```
public interface Ability
```
The Ability interface defines the set of methods that any CoreAbility, AddonAbility, ComboAbility, or MultiAbility should implement. CoreAbility provides a default implementation for a few of these methods, but most will need to be specified by each Ability individually.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCooldown()`
`java.lang.String`	`getDescription()` The description of an ability is a few sentences used to describe how the player can fully utilize the ability.
`Element`	`getElement()` Specifies the Element used to represent this type of ability, favoring SubElements over Elements.
`org.bukkit.Location`	`getLocation()` Specifies the Location of the ability, which may be slightly inaccurate depending on the Ability implementation.
`java.lang.String`	`getName()` The name of the ability is used for commands such as /bending display and /bending help.
`org.bukkit.entity.Player`	`getPlayer()` Returns the player that caused this ability to be initiated.
`boolean`	`isEnabled()` Returns true if the ability is enabled through the config.yml.
`boolean`	`isExplosiveAbility()` Determines if this ability can cause explosions.
`boolean`	`isHarmlessAbility()` Determines if this ability is considered harmless against other players.
`boolean`	`isHiddenAbility()` A hidden ability is an ability that should not be shown by commands such as /bending display and /bending help.
`boolean`	`isIgniteAbility()` Determines if this ability can ignite blocks.
`boolean`	`isSneakAbility()` Determines if this ability uses the `PlayerToggleSneakEvent` as a controlling mechanism.
`void`	`progress()` Causes the ability to be updated.
`void`	`remove()` Causes the ability to be removed from existence.

- Method Detail
  - progress
```
void progress()
```
    Causes the ability to be updated.
  - remove
```
void remove()
```
    Causes the ability to be removed from existence.
  - isSneakAbility
```
boolean isSneakAbility()
```
    Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism. Currently WaterPassive will not work while the player has a sneak ability bound.
    
    Returns:
    
    true if the ability uses sneak as a controlling mechanism
  - isHarmlessAbility
```
boolean isHarmlessAbility()
```
    Determines if this ability is considered harmless against other players. A harmless ability cannot manipulate another player. For example: AirPassive, WaterSpout, AirSpout, and FireJet.
    
    Returns:
    
    true if the ability is harmless and should be allowed in both PvP and non-PvP zones
  - isIgniteAbility
```
boolean isIgniteAbility()
```
    Determines if this ability can ignite blocks. For example: Blaze, FireBlast, and FireBurst.
  - isExplosiveAbility
```
boolean isExplosiveAbility()
```
    Determines if this ability can cause explosions. For example: FireBlastCharged
  - isHiddenAbility
```
boolean isHiddenAbility()
```
    A hidden ability is an ability that should not be shown by commands such as /bending display and /bending help. For example: Combos, MultiAbility sub abilities, and helper abilities.
    
    Returns:
    
    true if the ability should not be displayed to the players
  - isEnabled
```
boolean isEnabled()
```
    Returns true if the ability is enabled through the config.yml. Usually the Enabled option follows the format Abilities.ElementName.AbilityName.Enabled.
  - getCooldown
```
long getCooldown()
```
    Returns:
    
    the cooldown for the ability
  - getPlayer
```
org.bukkit.entity.Player getPlayer()
```
    Returns the player that caused this ability to be initiated. The player can be null in certain circumstances, for example when calling CoreAbility.getAbility(String), or if an ability decided to set player to null.
    
    Returns:
    
    the player that this ability belongs to
  - getName
```
java.lang.String getName()
```
    The name of the ability is used for commands such as /bending display and /bending help. The name is also used for determining the tag for cooldowns BendingPlayer.addCooldown(Ability), therefore if two abilities have the same name they will also share cooldowns. If two classes share the same name (SurgeWall/SurgeWave) but need to have independent cooldowns, then BendingPlayer.addCooldown(String, long) should be called explicitly.
    
    Returns:
    
    Returns the name of the ability
  - getDescription
```
java.lang.String getDescription()
```
    The description of an ability is a few sentences used to describe how the player can fully utilize the ability. In most cases the description will be specified in the config.yml file and will be retrieved by accessing the FileConfiguration via CoreAbility.getConfig().
    
    Returns:
    
    the description for this ability
    
    See Also:
    
    HelpCommand, CoreAbility.getDescription()
  - getElement
```
Element getElement()
```
    Specifies the Element used to represent this type of ability, favoring SubElements over Elements. For example, a LightningAbility would return Element.LIGHTNING instead of Element.FIRE.
    
    Returns:
    
    the most accurate Element that this ability belongs to
    
    See Also:
    
    Element.SubElement.getParentElement()
  - getLocation
```
org.bukkit.Location getLocation()
```
    Specifies the Location of the ability, which may be slightly inaccurate depending on the Ability implementation. For example, a TorrentWave could not be fully specified by a single location, while it is possible for an EarthBlast. The location is useful for making sure that the player is currently in the same world as the ability.
    
    Returns:
    
    the location of the Ability
    
    See Also:
    
    BendingPlayer.canBend(CoreAbility)

Interface Ability

Method Summary

Method Detail

progress

remove

isSneakAbility

isHarmlessAbility

isIgniteAbility

isExplosiveAbility

isHiddenAbility

isEnabled

getCooldown

getPlayer

getName

getDescription

getElement

getLocation