com.projectkorra.projectkorra.chiblocking

Class ChiCombo

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.ChiAbility

com.projectkorra.projectkorra.chiblocking.ChiCombo

All Implemented Interfaces:

Ability, ComboAbility

Direct Known Subclasses:

ChiCombo.Immobilize

public class ChiCombo
extends ChiAbility
implements ComboAbility

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ChiCombo.Immobilize

Constructor Summary

Constructors

Constructor and Description
ChiCombo(org.bukkit.entity.Player player, java.lang.String ability)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createNewComboInstance(org.bukkit.entity.Player player) Creates a new instance of the combo from a specific player.
java.util.ArrayList<ComboManager.AbilityInformation>	getCombination() Returns the list of abilities which constitute the combo.
long	getCooldown()
long	getDuration()
java.lang.String	getInstructions() Accessor Method to get the instructions for using this combo.
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.
static java.util.Map<org.bukkit.entity.Entity,java.lang.Long>	getParalyzedEntities()
org.bukkit.entity.Entity	getTarget()
static void	handleParalysis() Checks the status of all paralyzed entities.
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.
static boolean	isParalyzed(org.bukkit.entity.Entity entity) Checks if an entity is paralyzed by a ChiCombo.
static boolean	isParalyzed(org.bukkit.entity.Player player) Convenience method to see if a Player is paralyzed by a ChiCombo.
boolean	isSneakAbility() Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism.
void	progress() Causes the ability to be updated.
void	setCooldown(long cooldown)
void	setDuration(long duration)
void	setName(java.lang.String name)
void	setTarget(org.bukkit.entity.Entity target)

Methods inherited from class com.projectkorra.projectkorra.ability.ChiAbility

getElement, isExplosiveAbility, isIgniteAbility

Methods inherited from class com.projectkorra.projectkorra.ability.ElementalAbility

getTransparentMaterial, getTransparentMaterialSet, isDay, isEarth, isEarth, isFullMoon, isIce, isIce, isLava, isLava, isLunarEclipse, isMeltable, isMetal, isMetal, isMetalBlock, isNegativeEffect, isNeutralEffect, isNight, isPlant, isPlant, isPositiveEffect, isSand, isSand, isSnow, isSnow, isSolarEclipse, isSozinsComet, isTransparent, isTransparent, isTransparent, isUndead, isWater, isWater

Methods inherited from class com.projectkorra.projectkorra.ability.CoreAbility

getAbilities, getAbilities, getAbilities, getAbilitiesByElement, getAbility, getAbility, getBendingPlayer, getConfig, getDebugString, getDescription, getId, getLanguageConfig, getPlayer, getPlayers, getStartTime, hasAbility, isEnabled, isRemoved, isStarted, progressAll, registerAbilities, registerAddonAbilities, registerPluginAbilities, remove, removeAll, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ChiCombo

public ChiCombo(org.bukkit.entity.Player player,
                java.lang.String ability)

Method Detail

isParalyzed

public static boolean isParalyzed(org.bukkit.entity.Player player)

Convenience method to see if a Player is paralyzed by a ChiCombo. Calls isParalyzed(Entity) with the Player casted to an Entity.

Parameters:

player - The player to check if they're paralyzed

Returns:

True if the player is paralyzed, false otherwise

isParalyzed

public static boolean isParalyzed(org.bukkit.entity.Entity entity)

Checks if an entity is paralyzed by a ChiCombo.

Parameters:

entity - The entity to check if they're paralyzed

Returns:

True if the entity is paralyzed, false otherwise

handleParalysis

public static void handleParalysis()

Checks the status of all paralyzed entities. If their paralysis has expired, it removes them from paralyzedEntities and removes the instance of the combo from instances.

getName

public java.lang.String getName()

Description copied from interface: Ability

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.

Specified by:

getName in interface Ability

Returns:

Returns the name of the ability

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

Specified by:

progress in interface Ability

getLocation

public org.bukkit.Location getLocation()

Description copied from interface: Ability

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.

Specified by:

getLocation in interface Ability

Returns:

the location of the Ability

See Also:

BendingPlayer.canBend(CoreAbility)

getCooldown

public long getCooldown()

Specified by:

getCooldown in interface Ability

Returns:

the cooldown for the ability

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

Overrides:

isHiddenAbility in class CoreAbility

Returns:

true if the ability should not be displayed to the players

isSneakAbility

public boolean isSneakAbility()

Description copied from interface: Ability

Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism. Currently WaterPassive will not work while the player has a sneak ability bound.

Specified by:

isSneakAbility in interface Ability

Returns:

true if the ability uses sneak as a controlling mechanism

isHarmlessAbility

public boolean isHarmlessAbility()

Description copied from interface: Ability

Determines if this ability is considered harmless against other players. A harmless ability cannot manipulate another player. For example: AirPassive, WaterSpout, AirSpout, and FireJet.

Specified by:

isHarmlessAbility in interface Ability

Returns:

true if the ability is harmless and should be allowed in both PvP and non-PvP zones

getInstructions

public java.lang.String getInstructions()

Description copied from interface: ComboAbility

Accessor Method to get the instructions for using this combo.

Specified by:

getInstructions in interface ComboAbility

Returns:

The steps for the combo.

createNewComboInstance

public java.lang.Object createNewComboInstance(org.bukkit.entity.Player player)

Description copied from interface: ComboAbility

Creates a new instance of the combo from a specific player. ProjectKorra's ComboModuleManager will use this method once the combo steps have been used by the player.

Specified by:

createNewComboInstance in interface ComboAbility

Parameters:

player - The player using the combo.

Returns:

A new instance of the ability.

getCombination

public java.util.ArrayList<ComboManager.AbilityInformation> getCombination()

Description copied from interface: ComboAbility

Returns the list of abilities which constitute the combo.

Specified by:

getCombination in interface ComboAbility

Returns:

An ArrayList containing the combo's steps.

getDuration

public long getDuration()

setDuration

public void setDuration(long duration)

getTarget

public org.bukkit.entity.Entity getTarget()

setTarget

public void setTarget(org.bukkit.entity.Entity target)

getParalyzedEntities

public static java.util.Map<org.bukkit.entity.Entity,java.lang.Long> getParalyzedEntities()

setCooldown

public void setCooldown(long cooldown)

setName

public void setName(java.lang.String name)