Suffocate

java.lang.Object
- com.projectkorra.projectkorra.ability.CoreAbility
- - com.projectkorra.projectkorra.ability.ElementalAbility
  - - com.projectkorra.projectkorra.ability.AirAbility
    - - com.projectkorra.projectkorra.airbending.Suffocate

All Implemented Interfaces:

Ability
```
public class Suffocate
extends AirAbility
```
Suffocate Suffocate is an air ability that causes entities to be surrounded by a sphere air that causes constant damage after a configurable delay. Suffocate also causes Blinding and Slowing affects to entities depending on how the ability is configured. While in AvatarState this ability can be used on multiple entities within a large radius. If the user is damaged while performing this ability then the ability is removed.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Suffocate.SpiralType`
`class`	`Suffocate.SuffocateSpiral` ** Animates a Spiral of air particles around a location or a targetted entity.

Constructor Summary

Constructors
Constructor and Description

Suffocate(org.bukkit.entity.Player player)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`animate()` Animates this instance of the Suffocate ability.
`static void`	`breakSuffocate(org.bukkit.entity.Entity entity)` Stops an entity from being suffocated
`void`	`breakSuffocateLocal(org.bukkit.entity.Entity entity)` Stops an entity from being suffocated
`double`	`getAnimationSpeed()`
`double`	`getBlind()`
`double`	`getBlindDelay()`
`double`	`getBlindRepeat()`
`long`	`getChargeTime()`
`double`	`getConstantAimRadius()`
`long`	`getCooldown()`
`double`	`getDamage()`
`double`	`getDamageDelay()`
`double`	`getDamageRepeat()`
`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.
`int`	`getParticleCount()`
`double`	`getRadius()`
`double`	`getRange()`
`double`	`getSlow()`
`double`	`getSlowDelay()`
`double`	`getSlowRepeat()`
`java.util.ArrayList<org.bukkit.entity.LivingEntity>`	`getTargets()`
`java.util.ArrayList<org.bukkit.scheduler.BukkitRunnable>`	`getTasks()`
`static boolean`	`isBreathbent(org.bukkit.entity.Entity entity)` Checks if an entity is being suffocated
`boolean`	`isCanSuffocateUndead()`
`static boolean`	`isChannelingSphere(org.bukkit.entity.Player player)` Determines if a player is Suffocating entities
`boolean`	`isHarmlessAbility()` Determines if this ability is considered harmless against other players.
`boolean`	`isRequireConstantAim()`
`boolean`	`isSneakAbility()` Determines if this ability uses the `PlayerToggleSneakEvent` as a controlling mechanism.
`boolean`	`isStarted()`
`void`	`progress()` Causes the ability to be updated.
`void`	`remove()` Removes this instance of the ability
`static void`	`remove(org.bukkit.entity.Player player)` Removes an instance of Suffocate if player is the one suffocating entities
`static boolean`	`removeAtLocation(org.bukkit.entity.Player causer, org.bukkit.Location loc, double radius)` Removes all instances of Suffocate at loc within the radius threshold.
`void`	`setAnimationSpeed(double animationSpeed)`
`void`	`setBlind(double blind)`
`void`	`setBlindDelay(double blindDelay)`
`void`	`setBlindRepeat(double blindRepeat)`
`void`	`setCanSuffocateUndead(boolean canSuffocateUndead)`
`void`	`setChargeTime(long chargeTime)`
`void`	`setConstantAimRadius(double constantAimRadius)`
`void`	`setCooldown(long cooldown)`
`void`	`setDamage(double damage)`
`void`	`setDamageDelay(double damageDelay)`
`void`	`setDamageRepeat(double damageRepeat)`
`void`	`setParticleCount(int particleCount)`
`void`	`setRadius(double radius)`
`void`	`setRange(double range)`
`void`	`setRequireConstantAim(boolean requireConstantAim)`
`void`	`setSlow(double slow)`
`void`	`setSlowDelay(double slowDelay)`
`void`	`setSlowRepeat(double slowRepeat)`
`void`	`setStarted(boolean started)`

Methods inherited from class com.projectkorra.projectkorra.ability.AirAbility
breakBreathbendingHold, getAirbendingParticles, getElement, isExplosiveAbility, isIgniteAbility, isWithinAirShield, playAirbendingParticles, playAirbendingParticles, playAirbendingSound, removeAirSpouts, removeAirSpouts

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

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

- Constructor Detail
  - Suffocate
```
public Suffocate(org.bukkit.entity.Player player)
```
- Method Detail
  - progress
```
public void progress()
```
    Description copied from interface: Ability
    
    Causes the ability to be updated.
  - breakSuffocate
```
public static void breakSuffocate(org.bukkit.entity.Entity entity)
```
    Stops an entity from being suffocated
  - isBreathbent
```
public static boolean isBreathbent(org.bukkit.entity.Entity entity)
```
    Checks if an entity is being suffocated
  - isChannelingSphere
```
public static boolean isChannelingSphere(org.bukkit.entity.Player player)
```
    Determines if a player is Suffocating entities
  - remove
```
public static void remove(org.bukkit.entity.Player player)
```
    Removes an instance of Suffocate if player is the one suffocating entities
  - removeAtLocation
```
public static boolean removeAtLocation(org.bukkit.entity.Player causer,
                                       org.bukkit.Location loc,
                                       double radius)
```
    Removes all instances of Suffocate at loc within the radius threshold. The location of a Suffocate is defined at the benders location, not the location of the entities being suffocated.
    
    Parameters:
    
    causer - The player causing this instance to be removed
  - animate
```
public void animate()
```
    Animates this instance of the Suffocate ability. Depending on the specific time (dt) the ability will create a different set of SuffocationSpirals.
  - breakSuffocateLocal
```
public void breakSuffocateLocal(org.bukkit.entity.Entity entity)
```
    Stops an entity from being suffocated
  - remove
```
public void remove()
```
    Removes this instance of the ability
    
    Specified by:
    
    remove in interface Ability
    
    Overrides:
    
    remove in class CoreAbility
    
    See Also:
    
    CoreAbility.isRemoved()
  - 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
  - isStarted
```
public boolean isStarted()
```
    Overrides:
    
    isStarted in class CoreAbility
  - setStarted
```
public void setStarted(boolean started)
```
  - isRequireConstantAim
```
public boolean isRequireConstantAim()
```
  - setRequireConstantAim
```
public void setRequireConstantAim(boolean requireConstantAim)
```
  - isCanSuffocateUndead
```
public boolean isCanSuffocateUndead()
```
  - setCanSuffocateUndead
```
public void setCanSuffocateUndead(boolean canSuffocateUndead)
```
  - getParticleCount
```
public int getParticleCount()
```
  - setParticleCount
```
public void setParticleCount(int particleCount)
```
  - getChargeTime
```
public long getChargeTime()
```
  - setChargeTime
```
public void setChargeTime(long chargeTime)
```
  - getRange
```
public double getRange()
```
  - setRange
```
public void setRange(double range)
```
  - getRadius
```
public double getRadius()
```
  - setRadius
```
public void setRadius(double radius)
```
  - getDamage
```
public double getDamage()
```
  - setDamage
```
public void setDamage(double damage)
```
  - getDamageDelay
```
public double getDamageDelay()
```
  - setDamageDelay
```
public void setDamageDelay(double damageDelay)
```
  - getDamageRepeat
```
public double getDamageRepeat()
```
  - setDamageRepeat
```
public void setDamageRepeat(double damageRepeat)
```
  - getSlow
```
public double getSlow()
```
  - setSlow
```
public void setSlow(double slow)
```
  - getSlowRepeat
```
public double getSlowRepeat()
```
  - setSlowRepeat
```
public void setSlowRepeat(double slowRepeat)
```
  - getSlowDelay
```
public double getSlowDelay()
```
  - setSlowDelay
```
public void setSlowDelay(double slowDelay)
```
  - getConstantAimRadius
```
public double getConstantAimRadius()
```
  - setConstantAimRadius
```
public void setConstantAimRadius(double constantAimRadius)
```
  - getBlind
```
public double getBlind()
```
  - setBlind
```
public void setBlind(double blind)
```
  - getBlindDelay
```
public double getBlindDelay()
```
  - setBlindDelay
```
public void setBlindDelay(double blindDelay)
```
  - getBlindRepeat
```
public double getBlindRepeat()
```
  - setBlindRepeat
```
public void setBlindRepeat(double blindRepeat)
```
  - getAnimationSpeed
```
public double getAnimationSpeed()
```
  - setAnimationSpeed
```
public void setAnimationSpeed(double animationSpeed)
```
  - getTasks
```
public java.util.ArrayList<org.bukkit.scheduler.BukkitRunnable> getTasks()
```
  - getTargets
```
public java.util.ArrayList<org.bukkit.entity.LivingEntity> getTargets()
```
  - setCooldown
```
public void setCooldown(long cooldown)
```

Class Suffocate

Nested Class Summary

Constructor Summary

Method Summary

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

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

Suffocate

Method Detail

progress

breakSuffocate

isBreathbent

isChannelingSphere

remove

removeAtLocation

animate

breakSuffocateLocal

remove

getName

getLocation

getCooldown

isSneakAbility

isHarmlessAbility

isStarted

setStarted

isRequireConstantAim

setRequireConstantAim

isCanSuffocateUndead

setCanSuffocateUndead

getParticleCount

setParticleCount

getChargeTime

setChargeTime

getRange

setRange

getRadius

setRadius

getDamage

setDamage

getDamageDelay

setDamageDelay

getDamageRepeat

setDamageRepeat

getSlow

setSlow

getSlowRepeat

setSlowRepeat

getSlowDelay

setSlowDelay

getConstantAimRadius

setConstantAimRadius

getBlind

setBlind

getBlindDelay

setBlindDelay

getBlindRepeat

setBlindRepeat

getAnimationSpeed

setAnimationSpeed

getTasks

getTargets

setCooldown