WaterArms

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

All Implemented Interfaces:: Ability

public class WaterArms
extends WaterAbility

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WaterArms.Arm
Arm Enum value for deciding which arm is being used.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WaterArms.Arm` Arm Enum value for deciding which arm is being used.

Constructor Summary

Constructors
Constructor and Description

WaterArms(org.bukkit.entity.Player player)

Constructors
Constructor and Description
`WaterArms(org.bukkit.entity.Player player)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canDisplayActiveArm()`
`boolean`	`canLightningDamage()`
`void`	`displayBoundMsg(int slot)`
`boolean`	`displayLeftArm()` Displays the left arm.
`boolean`	`displayRightArm()` Displays the right arm.
`WaterArms.Arm`	`getActiveArm()` Returns the active arm of the player.
`org.bukkit.Location`	`getActiveArmEnd()`
`static java.util.Map<org.bukkit.block.Block,java.lang.Long>`	`getBlockRevertTimes()`
`long`	`getCooldown()`
`int`	`getFreezeSlot()`
`int`	`getInitLength()`
`long`	`getLastClickTime()`
`boolean`	`getLeftArmConsumed()`
`org.bukkit.Location`	`getLeftArmEnd()` Returns the location of the tip of the left arm assuming it is fully extended.
`java.lang.Integer`	`getLengthReduction()`
`double`	`getLightningDamage()`
`org.bukkit.Location`	`getLocation()` Specifies the Location of the ability, which may be slightly inaccurate depending on the Ability implementation.
`java.lang.Integer`	`getMaxIceBlasts()`
`java.lang.Integer`	`getMaxPunches()`
`java.lang.Integer`	`getMaxUses()`
`java.lang.String`	`getName()` The name of the ability is used for commands such as /bending display and /bending help.
`boolean`	`getRightArmConsumed()`
`org.bukkit.Location`	`getRightArmEnd()` Returns the location of the tip of the right arm, assuming it is fully extended.
`int`	`getSelectedSlot()`
`java.lang.String`	`getSneakMsg()`
`int`	`getSourceGrabRange()`
`static java.lang.Integer[]`	`getUnbreakables()`
`org.bukkit.World`	`getWorld()`
`boolean`	`isCanUsePlantSource()`
`boolean`	`isCooldownLeft()`
`boolean`	`isCooldownRight()`
`java.lang.Boolean`	`isFullSource()`
`boolean`	`isHarmlessAbility()` Determines if this ability is considered harmless against other players.
`boolean`	`isLeftArmCooldown()`
`boolean`	`isLightningEnabled()`
`boolean`	`isLightningKill()`
`boolean`	`isRightArmCooldown()`
`boolean`	`isSneakAbility()` Determines if this ability uses the `PlayerToggleSneakEvent` as a controlling mechanism.
`static boolean`	`isUnbreakable(org.bukkit.block.Block block)`
`void`	`prepareCancel()`
`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`	`setActiveArm(WaterArms.Arm activeArm)`
`void`	`setActiveArmCooldown(boolean cooldown)`
`void`	`setCanLightningDamage(boolean lightningEnabled)`
`void`	`setCanUsePlantSource(boolean canUsePlantSource)`
`void`	`setCooldown(long cooldown)`
`void`	`setCooldownLeft(boolean cooldownLeft)`
`void`	`setCooldownRight(boolean cooldownRight)`
`void`	`setFreezeSlot(int freezeSlot)`
`void`	`setFullSource(boolean fullSource)`
`void`	`setInitLength(int initLength)`
`void`	`setLastClickTime(long lastClickTime)`
`void`	`setLeftArmConsumed(boolean consumed)`
`void`	`setLeftArmCooldown(boolean cooldown)`
`void`	`setLengthReduction(int lengthReduction)`
`void`	`setLightningDamage(double lightningDamage)`
`void`	`setLightningEnabled(boolean lightningEnabled)`
`void`	`setLightningKill(boolean lightningKill)`
`void`	`setMaxIceBlasts(int maxIceBlasts)`
`void`	`setMaxPunches(int maxPunches)`
`void`	`setMaxUses(int maxUses)`
`void`	`setRightArmConsumed(boolean consumed)`
`void`	`setRightArmCooldown(boolean cooldown)`
`void`	`setSelectedSlot(int selectedSlot)`
`void`	`setSneakMsg(java.lang.String sneakMsg)`
`void`	`setSourceGrabRange(int sourceGrabRange)`
`void`	`setWorld(org.bukkit.World world)`
`void`	`switchActiveArm()` Switches the active arm of a player.
`WaterArms.Arm`	`switchPreferredArm()` Switches to the most suitable arm for the player.

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
  - WaterArms
```
public WaterArms(org.bukkit.entity.Player player)
```
- Method Detail
  - progress
```
public void progress()
```
    Description copied from interface: Ability
    
    Causes the ability to be updated.
  - displayRightArm
```
public boolean displayRightArm()
```
    Displays the right arm. Returns false if the arm cannot be fully displayed.
    
    Returns:
    
    false If arm cannot be fully displayed
  - displayLeftArm
```
public boolean displayLeftArm()
```
    Displays the left arm. Returns false if the arm cannot be fully displayed.
    
    Returns:
    
    false If the arm cannot be fully displayed.
  - getRightArmEnd
```
public org.bukkit.Location getRightArmEnd()
```
    Returns the location of the tip of the right arm, assuming it is fully extended. Use the displayRightArm() check to see if it is fully extended.
    
    Returns:
    
    location of the tip of the right arm
  - getLeftArmEnd
```
public org.bukkit.Location getLeftArmEnd()
```
    Returns the location of the tip of the left arm assuming it is fully extended. Use the displayLeftArm() check to see if it is fully extended.
    
    Returns:
    
    location of the tip of the left arm
  - 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()
  - prepareCancel
```
public void prepareCancel()
```
  - progressAllCleanup
```
public static void progressAllCleanup()
```
  - removeAllCleanup
```
public static void removeAllCleanup()
```
  - isUnbreakable
```
public static boolean isUnbreakable(org.bukkit.block.Block block)
```
  - displayBoundMsg
```
public void displayBoundMsg(int slot)
```
  - getActiveArm
```
public WaterArms.Arm getActiveArm()
```
    Returns the active arm of the player.
    
    Returns:
    
    WaterArms.Arm of the player
  - switchActiveArm
```
public void switchActiveArm()
```
    Switches the active arm of a player.
  - switchPreferredArm
```
public WaterArms.Arm switchPreferredArm()
```
    Switches to the most suitable arm for the player.
    
    Returns:
    
    the WaterArms.Arm that was swapped to
  - canDisplayActiveArm
```
public boolean canDisplayActiveArm()
```
  - getActiveArmEnd
```
public org.bukkit.Location getActiveArmEnd()
```
  - isFullSource
```
public java.lang.Boolean isFullSource()
```
  - getLeftArmConsumed
```
public boolean getLeftArmConsumed()
```
  - setLeftArmConsumed
```
public void setLeftArmConsumed(boolean consumed)
```
  - getRightArmConsumed
```
public boolean getRightArmConsumed()
```
  - setRightArmConsumed
```
public void setRightArmConsumed(boolean consumed)
```
  - getLengthReduction
```
public java.lang.Integer getLengthReduction()
```
  - setLengthReduction
```
public void setLengthReduction(int lengthReduction)
```
  - getMaxPunches
```
public java.lang.Integer getMaxPunches()
```
  - setMaxPunches
```
public void setMaxPunches(int maxPunches)
```
  - getMaxUses
```
public java.lang.Integer getMaxUses()
```
  - setMaxUses
```
public void setMaxUses(int maxUses)
```
  - getMaxIceBlasts
```
public java.lang.Integer getMaxIceBlasts()
```
  - setMaxIceBlasts
```
public void setMaxIceBlasts(int maxIceBlasts)
```
  - canLightningDamage
```
public boolean canLightningDamage()
```
  - setCanLightningDamage
```
public void setCanLightningDamage(boolean lightningEnabled)
```
  - getLightningDamage
```
public double getLightningDamage()
```
  - setLightningDamage
```
public void setLightningDamage(double lightningDamage)
```
  - isLeftArmCooldown
```
public boolean isLeftArmCooldown()
```
  - setLeftArmCooldown
```
public void setLeftArmCooldown(boolean cooldown)
```
  - isRightArmCooldown
```
public boolean isRightArmCooldown()
```
  - setRightArmCooldown
```
public void setRightArmCooldown(boolean cooldown)
```
  - setActiveArmCooldown
```
public void setActiveArmCooldown(boolean cooldown)
```
  - getCooldown
```
public long getCooldown()
```
    Returns:
    
    the cooldown for the ability
  - setCooldown
```
public void setCooldown(long cooldown)
```
  - 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)
  - 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
  - isCooldownLeft
```
public boolean isCooldownLeft()
```
  - setCooldownLeft
```
public void setCooldownLeft(boolean cooldownLeft)
```
  - isCooldownRight
```
public boolean isCooldownRight()
```
  - setCooldownRight
```
public void setCooldownRight(boolean cooldownRight)
```
  - isCanUsePlantSource
```
public boolean isCanUsePlantSource()
```
  - setCanUsePlantSource
```
public void setCanUsePlantSource(boolean canUsePlantSource)
```
  - isLightningEnabled
```
public boolean isLightningEnabled()
```
  - setLightningEnabled
```
public void setLightningEnabled(boolean lightningEnabled)
```
  - isLightningKill
```
public boolean isLightningKill()
```
  - setLightningKill
```
public void setLightningKill(boolean lightningKill)
```
  - getInitLength
```
public int getInitLength()
```
  - setInitLength
```
public void setInitLength(int initLength)
```
  - getSourceGrabRange
```
public int getSourceGrabRange()
```
  - setSourceGrabRange
```
public void setSourceGrabRange(int sourceGrabRange)
```
  - getSelectedSlot
```
public int getSelectedSlot()
```
  - setSelectedSlot
```
public void setSelectedSlot(int selectedSlot)
```
  - getFreezeSlot
```
public int getFreezeSlot()
```
  - setFreezeSlot
```
public void setFreezeSlot(int freezeSlot)
```
  - getLastClickTime
```
public long getLastClickTime()
```
  - setLastClickTime
```
public void setLastClickTime(long lastClickTime)
```
  - getWorld
```
public org.bukkit.World getWorld()
```
  - setWorld
```
public void setWorld(org.bukkit.World world)
```
  - getSneakMsg
```
public java.lang.String getSneakMsg()
```
  - setSneakMsg
```
public void setSneakMsg(java.lang.String sneakMsg)
```
  - getBlockRevertTimes
```
public static java.util.Map<org.bukkit.block.Block,java.lang.Long> getBlockRevertTimes()
```
  - getUnbreakables
```
public static java.lang.Integer[] getUnbreakables()
```
  - setFullSource
```
public void setFullSource(boolean fullSource)
```
  - setActiveArm
```
public void setActiveArm(WaterArms.Arm activeArm)
```

Class WaterArms

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

WaterArms

Method Detail

progress

displayRightArm

displayLeftArm

getRightArmEnd

getLeftArmEnd

remove

prepareCancel

progressAllCleanup

removeAllCleanup

isUnbreakable

displayBoundMsg

getActiveArm

switchActiveArm

switchPreferredArm

canDisplayActiveArm

getActiveArmEnd

isFullSource

getLeftArmConsumed

setLeftArmConsumed

getRightArmConsumed

setRightArmConsumed

getLengthReduction

setLengthReduction

getMaxPunches

setMaxPunches

getMaxUses

setMaxUses

getMaxIceBlasts

setMaxIceBlasts

canLightningDamage

setCanLightningDamage

getLightningDamage

setLightningDamage

isLeftArmCooldown

setLeftArmCooldown

isRightArmCooldown

setRightArmCooldown

setActiveArmCooldown

getCooldown

setCooldown

getName

getLocation

isSneakAbility

isHarmlessAbility

isCooldownLeft

setCooldownLeft

isCooldownRight

setCooldownRight

isCanUsePlantSource

setCanUsePlantSource

isLightningEnabled

setLightningEnabled

isLightningKill

setLightningKill

getInitLength

setInitLength

getSourceGrabRange

setSourceGrabRange

getSelectedSlot

setSelectedSlot

getFreezeSlot

setFreezeSlot

getLastClickTime

setLastClickTime

getWorld

setWorld

getSneakMsg

setSneakMsg

getBlockRevertTimes