WaterArmsWhip

java.lang.Object
- com.projectkorra.projectkorra.ability.CoreAbility
- - com.projectkorra.projectkorra.ability.ElementalAbility
  - - com.projectkorra.projectkorra.ability.WaterAbility
    - - com.projectkorra.projectkorra.waterbending.WaterArmsWhip

All Implemented Interfaces:: Ability

public class WaterArmsWhip
extends WaterAbility

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WaterArmsWhip.Whip
Whip Enum value for deciding what ability should be executed.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WaterArmsWhip.Whip` Whip Enum value for deciding what ability should be executed.

Constructor Summary

Constructors
Constructor and Description

WaterArmsWhip(org.bukkit.entity.Player player, WaterArmsWhip.Whip ability)

Constructors
Constructor and Description
`WaterArmsWhip(org.bukkit.entity.Player player, WaterArmsWhip.Whip ability)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkValidEntities()`
`WaterArmsWhip.Whip`	`getAbility()`
`int`	`getActiveLength()`
`WaterArms.Arm`	`getArm()`
`long`	`getCooldown()`
`org.bukkit.Location`	`getEnd()`
`static java.util.HashMap<org.bukkit.entity.LivingEntity,WaterArmsWhip>`	`getGrabbedEntities()`
`org.bukkit.entity.LivingEntity`	`getGrabbedEntity()`
`long`	`getHoldTime()`
`int`	`getInitLength()`
`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.
`double`	`getPlayerHealth()`
`double`	`getPullMultiplier()`
`double`	`getPunchDamage()`
`int`	`getPunchLength()`
`int`	`getPunchLengthFullMoon()`
`int`	`getPunchLengthNight()`
`long`	`getTime()`
`long`	`getUsageCooldown()`
`WaterArms`	`getWaterArms()`
`int`	`getWhipLength()`
`int`	`getWhipLengthFullMoon()`
`int`	`getWhipLengthNight()`
`int`	`getWhipLengthWeak()`
`int`	`getWhipSpeed()`
`boolean`	`isGrabbed()`
`boolean`	`isGrappled()`
`boolean`	`isGrappleRespectRegions()`
`boolean`	`isHarmlessAbility()` Determines if this ability is considered harmless against other players.
`boolean`	`isHasDamaged()`
`boolean`	`isReverting()`
`boolean`	`isSneakAbility()` Determines if this ability uses the `PlayerToggleSneakEvent` as a controlling mechanism.
`boolean`	`isUsageCooldownEnabled()`
`void`	`progress()` Causes the ability to be updated.
`static void`	`progressAllCleanup()`
`void`	`remove()` Causes this CoreAbility instance to be removed, and `Ability.progress()` will no longer be called every tick.
`static void`	`removeAllCleanup()`
`void`	`setAbility(WaterArmsWhip.Whip ability)`
`void`	`setActiveLength(int activeLength)`
`void`	`setArm(WaterArms.Arm arm)`
`void`	`setEnd(org.bukkit.Location end)`
`void`	`setGrabbed(boolean grabbed)`
`void`	`setGrabbedEntity(org.bukkit.entity.LivingEntity grabbedEntity)`
`void`	`setGrappled(boolean grappled)`
`void`	`setGrappleRespectRegions(boolean grappleRespectRegions)`
`void`	`setHasDamaged(boolean hasDamaged)`
`void`	`setHoldTime(long holdTime)`
`void`	`setInitLength(int initLength)`
`void`	`setPlayerHealth(double playerHealth)`
`void`	`setPullMultiplier(double pullMultiplier)`
`void`	`setPunchDamage(double punchDamage)`
`void`	`setPunchLength(int punchLength)`
`void`	`setPunchLengthFullMoon(int punchLengthFullMoon)`
`void`	`setPunchLengthNight(int punchLengthNight)`
`void`	`setReverting(boolean reverting)`
`void`	`setTime(long time)`
`void`	`setUsageCooldown(long usageCooldown)`
`void`	`setUsageCooldownEnabled(boolean usageCooldownEnabled)`
`void`	`setWaterArms(WaterArms waterArms)`
`void`	`setWhipLength(int whipLength)`
`void`	`setWhipLengthFullMoon(int whipLengthFullMoon)`
`void`	`setWhipLengthNight(int whipLengthNight)`
`void`	`setWhipLengthWeak(int whipLengthWeak)`
`void`	`setWhipSpeed(int whipSpeed)`

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, 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, isHiddenAbility, isRemoved, isStarted, progressAll, registerAbilities, registerAddonAbilities, registerPluginAbilities, removeAll, start

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

- Constructor Detail
  - WaterArmsWhip
```
public WaterArmsWhip(org.bukkit.entity.Player player,
                     WaterArmsWhip.Whip ability)
```
- Method Detail
  - progress
```
public void progress()
```
    Description copied from interface: Ability
    
    Causes the ability to be updated.
  - checkValidEntities
```
public static void checkValidEntities()
```
  - remove
```
public void remove()
```
    Description copied from class: CoreAbility
    
    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
    
    Overrides:
    
    remove in class CoreAbility
    
    See Also:
    
    CoreAbility.isRemoved()
  - progressAllCleanup
```
public static void progressAllCleanup()
```
  - removeAllCleanup
```
public static void removeAllCleanup()
```
  - 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.
    
    Returns:
    
    Returns the name of the 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.
    
    Returns:
    
    the location of the Ability
    
    See Also:
    
    BendingPlayer.canBend(CoreAbility)
  - getCooldown
```
public long getCooldown()
```
    Returns:
    
    the cooldown for the ability
  - 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.
    
    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.
    
    Returns:
    
    true if the ability is harmless and should be allowed in both PvP and non-PvP zones
  - isReverting
```
public boolean isReverting()
```
  - setReverting
```
public void setReverting(boolean reverting)
```
  - isHasDamaged
```
public boolean isHasDamaged()
```
  - setHasDamaged
```
public void setHasDamaged(boolean hasDamaged)
```
  - isGrappled
```
public boolean isGrappled()
```
  - setGrappled
```
public void setGrappled(boolean grappled)
```
  - isGrabbed
```
public boolean isGrabbed()
```
  - setGrabbed
```
public void setGrabbed(boolean grabbed)
```
  - isGrappleRespectRegions
```
public boolean isGrappleRespectRegions()
```
  - setGrappleRespectRegions
```
public void setGrappleRespectRegions(boolean grappleRespectRegions)
```
  - isUsageCooldownEnabled
```
public boolean isUsageCooldownEnabled()
```
  - setUsageCooldownEnabled
```
public void setUsageCooldownEnabled(boolean usageCooldownEnabled)
```
  - getWhipLength
```
public int getWhipLength()
```
  - setWhipLength
```
public void setWhipLength(int whipLength)
```
  - getWhipLengthWeak
```
public int getWhipLengthWeak()
```
  - setWhipLengthWeak
```
public void setWhipLengthWeak(int whipLengthWeak)
```
  - getWhipLengthNight
```
public int getWhipLengthNight()
```
  - setWhipLengthNight
```
public void setWhipLengthNight(int whipLengthNight)
```
  - getWhipLengthFullMoon
```
public int getWhipLengthFullMoon()
```
  - setWhipLengthFullMoon
```
public void setWhipLengthFullMoon(int whipLengthFullMoon)
```
  - getInitLength
```
public int getInitLength()
```
  - setInitLength
```
public void setInitLength(int initLength)
```
  - getPunchLength
```
public int getPunchLength()
```
  - setPunchLength
```
public void setPunchLength(int punchLength)
```
  - getPunchLengthNight
```
public int getPunchLengthNight()
```
  - setPunchLengthNight
```
public void setPunchLengthNight(int punchLengthNight)
```
  - getPunchLengthFullMoon
```
public int getPunchLengthFullMoon()
```
  - setPunchLengthFullMoon
```
public void setPunchLengthFullMoon(int punchLengthFullMoon)
```
  - getActiveLength
```
public int getActiveLength()
```
  - setActiveLength
```
public void setActiveLength(int activeLength)
```
  - getWhipSpeed
```
public int getWhipSpeed()
```
  - setWhipSpeed
```
public void setWhipSpeed(int whipSpeed)
```
  - getHoldTime
```
public long getHoldTime()
```
  - setHoldTime
```
public void setHoldTime(long holdTime)
```
  - getUsageCooldown
```
public long getUsageCooldown()
```
  - setUsageCooldown
```
public void setUsageCooldown(long usageCooldown)
```
  - getTime
```
public long getTime()
```
  - setTime
```
public void setTime(long time)
```
  - getPullMultiplier
```
public double getPullMultiplier()
```
  - setPullMultiplier
```
public void setPullMultiplier(double pullMultiplier)
```
  - getPunchDamage
```
public double getPunchDamage()
```
  - setPunchDamage
```
public void setPunchDamage(double punchDamage)
```
  - getPlayerHealth
```
public double getPlayerHealth()
```
  - setPlayerHealth
```
public void setPlayerHealth(double playerHealth)
```
  - getArm
```
public WaterArms.Arm getArm()
```
  - setArm
```
public void setArm(WaterArms.Arm arm)
```
  - getAbility
```
public WaterArmsWhip.Whip getAbility()
```
  - setAbility
```
public void setAbility(WaterArmsWhip.Whip ability)
```
  - getGrabbedEntity
```
public org.bukkit.entity.LivingEntity getGrabbedEntity()
```
  - setGrabbedEntity
```
public void setGrabbedEntity(org.bukkit.entity.LivingEntity grabbedEntity)
```
  - getEnd
```
public org.bukkit.Location getEnd()
```
  - setEnd
```
public void setEnd(org.bukkit.Location end)
```
  - getWaterArms
```
public WaterArms getWaterArms()
```
  - setWaterArms
```
public void setWaterArms(WaterArms waterArms)
```
  - getGrabbedEntities
```
public static java.util.HashMap<org.bukkit.entity.LivingEntity,WaterArmsWhip> getGrabbedEntities()
```

Class WaterArmsWhip

Nested Class Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

WaterArmsWhip

Method Detail

progress

checkValidEntities

remove

progressAllCleanup

removeAllCleanup

getName

getLocation

getCooldown

isSneakAbility

isHarmlessAbility

isReverting

setReverting

isHasDamaged

setHasDamaged

isGrappled

setGrappled

isGrabbed

setGrabbed

isGrappleRespectRegions

setGrappleRespectRegions

isUsageCooldownEnabled

setUsageCooldownEnabled

getWhipLength

setWhipLength

getWhipLengthWeak

setWhipLengthWeak

getWhipLengthNight

setWhipLengthNight

getWhipLengthFullMoon

setWhipLengthFullMoon

getInitLength

setInitLength

getPunchLength

setPunchLength

getPunchLengthNight

setPunchLengthNight

getPunchLengthFullMoon

setPunchLengthFullMoon

getActiveLength

setActiveLength

getWhipSpeed

setWhipSpeed

getHoldTime

setHoldTime

getUsageCooldown

setUsageCooldown

getTime

setTime

getPullMultiplier

setPullMultiplier

getPunchDamage

setPunchDamage

getPlayerHealth

setPlayerHealth

getArm

setArm

getAbility

setAbility

getGrabbedEntity

setGrabbedEntity

getEnd

setEnd

getWaterArms

setWaterArms

getGrabbedEntities