CoreAbility

java.lang.Object
- com.projectkorra.projectkorra.ability.CoreAbility

All Implemented Interfaces:

Ability

Direct Known Subclasses:

ElementalAbility
```
public abstract class CoreAbility
extends java.lang.Object
implements Ability
```
CoreAbility provides default implementation of an Ability, including methods to control the life cycle of a specific instance. CoreAbility also provides a system to load CoreAbilities within a JavaPlugin, or located in an external JarFile.

See Also:

start(), Ability.progress(), remove(), registerAddonAbilities(String), registerPluginAbilities(JavaPlugin, String)

Constructor Summary

Constructors
Constructor and Description
`CoreAbility()` The default constructor is needed to create a fake instance of each CoreAbility via reflection in `registerAbilities()`.
`CoreAbility(org.bukkit.entity.Player player)` Creates a new CoreAbility instance but does not start it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.ArrayList<CoreAbility>`	`getAbilities()` Returns a list of "fake" instances for each ability that was loaded by `registerAbilities()`
`static <T extends CoreAbility> java.util.Collection<T>`	`getAbilities(java.lang.Class<T> clazz)` Returns a Collection of all of the player created instances for a specific type of CoreAbility.
`static <T extends CoreAbility> java.util.Collection<T>`	`getAbilities(org.bukkit.entity.Player player, java.lang.Class<T> clazz)` Returns a Collection of specific CoreAbility instances that were created by the specified player.
`static java.util.List<CoreAbility>`	`getAbilitiesByElement(Element element)` Returns an List of fake instances that were loaded by `registerAbilities()` filtered by Element.
`static <T extends CoreAbility> T`	`getAbility(org.bukkit.entity.Player player, java.lang.Class<T> clazz)` Returns any T CoreAbility that has been started and not yet removed.
`static CoreAbility`	`getAbility(java.lang.String abilityName)` Returns a "fake" instance for the CoreAbility represented by abilityName.
`BendingPlayer`	`getBendingPlayer()`
`static org.bukkit.configuration.file.FileConfiguration`	`getConfig()`
`static java.lang.String`	`getDebugString()` Returns a String used to debug potential CoreAbility memory that can be caused by a developer forgetting to call `remove()`
`java.lang.String`	`getDescription()` The description of an ability is a few sentences used to describe how the player can fully utilize the ability.
`int`	`getId()`
`static org.bukkit.configuration.file.FileConfiguration`	`getLanguageConfig()`
`org.bukkit.entity.Player`	`getPlayer()` Returns the player that caused this ability to be initiated.
`static java.util.Set<org.bukkit.entity.Player>`	`getPlayers(java.lang.Class<? extends CoreAbility> clazz)` Returns a Set of all of the players that currently have an active instance of clazz.
`long`	`getStartTime()`
`static <T extends CoreAbility> boolean`	`hasAbility(org.bukkit.entity.Player player, java.lang.Class<T> clazz)` Returns true if the player has an active CoreAbility instance of type T.
`boolean`	`isEnabled()` Returns true if the ability is enabled through the config.yml.
`boolean`	`isHiddenAbility()` A hidden ability is an ability that should not be shown by commands such as /bending display and /bending help.
`boolean`	`isRemoved()`
`boolean`	`isStarted()`
`static void`	`progressAll()` Causes `Ability.progress()` to be called on every CoreAbility instance that has been started and has not been removed.
`static void`	`registerAbilities()` Scans and loads plugin CoreAbilities, and Addon CoreAbilities that are located in a Jar file inside of the /ProjectKorra/Abilities/ folder.
`static void`	`registerAddonAbilities(java.lang.String folder)` Scans all of the Jar files inside of /ProjectKorra/folder and registers all of the CoreAbility class files that were found.
`static void`	`registerPluginAbilities(org.bukkit.plugin.java.JavaPlugin plugin, java.lang.String packagePrefix)` Scans a JavaPlugin and registers CoreAbility class files.
`void`	`remove()` Causes this CoreAbility instance to be removed, and `Ability.progress()` will no longer be called every tick.
`static void`	`removeAll()` Removes every CoreAbility instance that has been started but not yet removed.
`void`	`start()` Causes the ability to begin updating every tick by calling `Ability.progress()` until `remove()` is called.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.projectkorra.projectkorra.ability.Ability
getCooldown, getElement, getLocation, getName, isExplosiveAbility, isHarmlessAbility, isIgniteAbility, isSneakAbility, progress

- Constructor Detail
  - CoreAbility
```
public CoreAbility()
```
    The default constructor is needed to create a fake instance of each CoreAbility via reflection in registerAbilities(). More specifically, registerPluginAbilities(org.bukkit.plugin.java.JavaPlugin, java.lang.String) calls getDeclaredConstructor which is only usable with a public default constructor. Reflection lets us create a list of all of the plugin's abilities when the plugin first loads.
    
    See Also:
    
    ABILITIES_BY_NAME, getAbility(String)
  - CoreAbility
```
public CoreAbility(org.bukkit.entity.Player player)
```
    Creates a new CoreAbility instance but does not start it.
    
    Parameters:
    
    player - the non-null player that created this instance
    
    See Also:
    
    start()
- Method Detail
  - start
```
public final void start()
```
    Causes the ability to begin updating every tick by calling Ability.progress() until remove() is called. This method cannot be overridden, and any code that needs to be performed before start should be handled in the constructor.
    
    See Also:
    
    getStartTime(), isStarted(), isRemoved()
  - remove
```
public void remove()
```
    Causes this CoreAbility instance to be removed, and Ability.progress() will no longer be called every tick. If this method is overridden then the new method must call super.remove(). Causes the ability to be removed from existence.
    
    Specified by:
    
    remove in interface Ability
    
    See Also:
    
    isRemoved()
  - progressAll
```
public static void progressAll()
```
    Causes Ability.progress() to be called on every CoreAbility instance that has been started and has not been removed.
  - removeAll
```
public static void removeAll()
```
    Removes every CoreAbility instance that has been started but not yet removed.
  - getAbility
```
public static <T extends CoreAbility> T getAbility(org.bukkit.entity.Player player,
                                                   java.lang.Class<T> clazz)
```
    Returns any T CoreAbility that has been started and not yet removed. May return null if no such ability exists.
    
    Parameters:
    
    player - the player that created the CoreAbility instance
    
    clazz - the class of the type of CoreAbility
    
    Returns:
    
    a CoreAbility instance or null
  - getAbility
```
public static CoreAbility getAbility(java.lang.String abilityName)
```
    Returns a "fake" instance for the CoreAbility represented by abilityName. This method does not look into CoreAbility instances that were created by Players, instead this method looks at the CoreAbilities that were created via Reflection by registerAbilities() when the plugin was first loaded.
    These "fake" instances have a null player, but methods such as Ability.getName(), and Ability.getElement() will still work, as will checking the type of the ability with instanceof.
    CoreAbility coreAbil = getAbility(someString);
    if (coreAbil instanceof FireAbility && coreAbil.isSneakAbility())
    
    Parameters:
    
    abilityName - the name of a loaded CoreAbility
    
    Returns:
    
    a "fake" CoreAbility instance, or null if no such ability exists
  - getAbilities
```
public static java.util.ArrayList<CoreAbility> getAbilities()
```
    Returns a list of "fake" instances for each ability that was loaded by registerAbilities()
  - getAbilities
```
public static <T extends CoreAbility> java.util.Collection<T> getAbilities(java.lang.Class<T> clazz)
```
    Returns a Collection of all of the player created instances for a specific type of CoreAbility.
    
    Parameters:
    
    clazz - the class for the type of CoreAbilities
    
    Returns:
    
    a Collection of real instances
  - getAbilities
```
public static <T extends CoreAbility> java.util.Collection<T> getAbilities(org.bukkit.entity.Player player,
                                                                           java.lang.Class<T> clazz)
```
    Returns a Collection of specific CoreAbility instances that were created by the specified player.
    
    Parameters:
    
    player - the player that created the instances
    
    clazz - the class for the type of CoreAbilities
    
    Returns:
    
    a Collection of real instances
  - getAbilitiesByElement
```
public static java.util.List<CoreAbility> getAbilitiesByElement(Element element)
```
    Returns an List of fake instances that were loaded by registerAbilities() filtered by Element.
    
    Parameters:
    
    element - the Element of the loaded abilities
    
    Returns:
    
    a list of fake CoreAbility instances
  - hasAbility
```
public static <T extends CoreAbility> boolean hasAbility(org.bukkit.entity.Player player,
                                                         java.lang.Class<T> clazz)
```
    Returns true if the player has an active CoreAbility instance of type T.
    
    Parameters:
    
    player - the player that created the T instance
    
    clazz - the class for the type of CoreAbility
  - getPlayers
```
public static java.util.Set<org.bukkit.entity.Player> getPlayers(java.lang.Class<? extends CoreAbility> clazz)
```
    Returns a Set of all of the players that currently have an active instance of clazz.
    
    Parameters:
    
    clazz - the clazz for the type of CoreAbility
  - registerAbilities
```
public static void registerAbilities()
```
    Scans and loads plugin CoreAbilities, and Addon CoreAbilities that are located in a Jar file inside of the /ProjectKorra/Abilities/ folder.
  - registerPluginAbilities
```
public static void registerPluginAbilities(org.bukkit.plugin.java.JavaPlugin plugin,
                                           java.lang.String packagePrefix)
```
    Scans a JavaPlugin and registers CoreAbility class files.
    
    Parameters:
    
    plugin - a JavaPlugin containing CoreAbility class files
    
    packagePrefix - a prefix of the package name, used to increase performance
    
    See Also:
    
    getAbilities(), getAbility(String)
  - registerAddonAbilities
```
public static void registerAddonAbilities(java.lang.String folder)
```
    Scans all of the Jar files inside of /ProjectKorra/folder and registers all of the CoreAbility class files that were found.
    
    Parameters:
    
    folder - the name of the folder to scan
    
    See Also:
    
    getAbilities(), getAbility(String)
  - getStartTime
```
public long getStartTime()
```
  - isStarted
```
public boolean isStarted()
```
  - isRemoved
```
public boolean isRemoved()
```
  - getBendingPlayer
```
public BendingPlayer getBendingPlayer()
```
  - getId
```
public int getId()
```
  - isHiddenAbility
```
public boolean isHiddenAbility()
```
    Description copied from interface: Ability
    
    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.
    
    Specified by:
    
    isHiddenAbility in interface Ability
    
    Returns:
    
    true if the ability should not be displayed to the players
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Ability
    
    Returns true if the ability is enabled through the config.yml. Usually the Enabled option follows the format Abilities.ElementName.AbilityName.Enabled.
    
    Specified by:
    
    isEnabled in interface Ability
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Ability
    
    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 getConfig().
    
    Specified by:
    
    getDescription in interface Ability
    
    Returns:
    
    the description for this ability
    
    See Also:
    
    HelpCommand, getDescription()
  - getPlayer
```
public org.bukkit.entity.Player getPlayer()
```
    Description copied from interface: Ability
    
    Returns the player that caused this ability to be initiated. The player can be null in certain circumstances, for example when calling getAbility(String), or if an ability decided to set player to null.
    
    Specified by:
    
    getPlayer in interface Ability
    
    Returns:
    
    the player that this ability belongs to
  - getConfig
```
public static org.bukkit.configuration.file.FileConfiguration getConfig()
```
    Returns:
    
    the current FileConfiguration for the plugin
  - getLanguageConfig
```
public static org.bukkit.configuration.file.FileConfiguration getLanguageConfig()
```
    Returns:
    
    the language.yml for the plugin
  - getDebugString
```
public static java.lang.String getDebugString()
```
    Returns a String used to debug potential CoreAbility memory that can be caused by a developer forgetting to call remove()

Class CoreAbility

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.projectkorra.projectkorra.ability.Ability

Constructor Detail

CoreAbility

CoreAbility

Method Detail

start

remove

progressAll

removeAll

getAbility

getAbility

getAbilities

getAbilities

getAbilities

getAbilitiesByElement

hasAbility

getPlayers

registerAbilities

registerPluginAbilities

registerAddonAbilities

getStartTime

isStarted

isRemoved

getBendingPlayer

getId

isHiddenAbility

isEnabled

getDescription

getPlayer

getConfig

getLanguageConfig

getDebugString