com.projectkorra.projectkorra.airbending

Class AirSuction

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.AirAbility

com.projectkorra.projectkorra.airbending.AirSuction

All Implemented Interfaces:

Ability

public class AirSuction
extends AirAbility

Constructor Summary

Constructors

Constructor and Description
AirSuction(org.bukkit.entity.Player player)

Method Summary

Modifier and Type	Method and Description
long	getCooldown()
org.bukkit.util.Vector	getDirection()
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.
org.bukkit.Location	getOrigin()
static java.util.Map<org.bukkit.entity.Player,org.bukkit.Location>	getOrigins()
int	getParticleCount()
double	getPushFactor()
double	getRadius()
double	getRange()
static int	getSelectParticles()
static double	getSelectRange()
double	getSpeed()
int	getTicks()
boolean	isHarmlessAbility() Determines if this ability is considered harmless against other players.
boolean	isHasOtherOrigin()
boolean	isSneakAbility() Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism.
void	progress() Causes the ability to be updated.
static void	progressOrigins()
static boolean	removeAirSuctionsAroundPoint(org.bukkit.Location location, double radius)
void	setCooldown(long cooldown)
void	setDirection(org.bukkit.util.Vector direction)
void	setHasOtherOrigin(boolean hasOtherOrigin)
void	setLocation(org.bukkit.Location location)
void	setOrigin(org.bukkit.Location origin)
static void	setOrigin(org.bukkit.entity.Player player)
void	setParticleCount(int particleCount)
void	setPushFactor(double pushFactor)
void	setRadius(double radius)
void	setRange(double range)
void	setSpeed(double speed)
void	setTicks(int ticks)

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, 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

AirSuction

public AirSuction(org.bukkit.entity.Player player)

Method Detail

progressOrigins

public static void progressOrigins()

setOrigin

public static void setOrigin(org.bukkit.entity.Player player)

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

removeAirSuctionsAroundPoint

public static boolean removeAirSuctionsAroundPoint(org.bukkit.Location location,
                                                   double radius)

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

getOrigin

public org.bukkit.Location getOrigin()

setOrigin

public void setOrigin(org.bukkit.Location origin)

getDirection

public org.bukkit.util.Vector getDirection()

setDirection

public void setDirection(org.bukkit.util.Vector direction)

isHasOtherOrigin

public boolean isHasOtherOrigin()

setHasOtherOrigin

public void setHasOtherOrigin(boolean hasOtherOrigin)

getTicks

public int getTicks()

setTicks

public void setTicks(int ticks)

getParticleCount

public int getParticleCount()

setParticleCount

public void setParticleCount(int particleCount)

getSpeed

public double getSpeed()

setSpeed

public void setSpeed(double speed)

getRange

public double getRange()

setRange

public void setRange(double range)

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getPushFactor

public double getPushFactor()

setPushFactor

public void setPushFactor(double pushFactor)

setLocation

public void setLocation(org.bukkit.Location location)

setCooldown

public void setCooldown(long cooldown)

getOrigins

public static java.util.Map<org.bukkit.entity.Player,org.bukkit.Location> getOrigins()

getSelectParticles

public static int getSelectParticles()

getSelectRange

public static double getSelectRange()