com.projectkorra.projectkorra.earthbending

Class SandSpout

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.EarthAbility

com.projectkorra.projectkorra.ability.SandAbility

com.projectkorra.projectkorra.earthbending.SandSpout

All Implemented Interfaces:

Ability, SubAbility

public class SandSpout
extends SandAbility

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getAngle()
int	getBlindnessTime()
long	getCooldown()
double	getCurrentHeight()
double	getDamage()
double	getHeight()
long	getInterval()
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.
long	getTime()
boolean	isCanSpiral()
boolean	isHarmlessAbility() Determines if this ability is considered harmless against other players.
boolean	isSneakAbility() Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism.
void	progress() Causes the ability to be updated.
void	remove() Causes this CoreAbility instance to be removed, and Ability.progress() will no longer be called every tick.
static boolean	removeSpouts(org.bukkit.Location location, double radius, org.bukkit.entity.Player sourcePlayer)
void	setAngle(int angle)
void	setBlindnessTime(int blindnessTime)
void	setCanSpiral(boolean canSpiral)
void	setCurrentHeight(double currentHeight)
void	setDamage(double damage)
void	setHeight(double height)
void	setInterval(long interval)
void	setTime(long time)

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

getElement, getParentAbility

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

addTempAirBlock, displaySandParticle, getEarthbendableBlocksLength, getEarthSourceBlock, getEarthSourceBlock, getLavaSourceBlock, getLavaSourceBlock, getLavaSourceBlock, getMetalAugment, getMovedEarth, getNearbyEarthBlock, getPreventEarthbendingBlocks, getPreventPhysicsBlocks, getSubChatColor, getTargetEarthBlock, getTargetEarthBlock, getTempAirLocations, isEarthbendable, isEarthbendable, isEarthbendable, isEarthbendable, isEarthRevertOn, isExplosiveAbility, isIgniteAbility, isLavabendable, isLavabendable, isMetalbendable, isMetalbendable, isMetalbendable, isSandbendable, isSandbendable, isSandbendable, moveEarth, moveEarth, moveEarth, moveEarth, moveEarthBlock, playEarthbendingSound, playMetalbendingSound, playSandBendingSound, removeAllEarthbendedBlocks, removeRevertIndex, removeSandSpouts, removeSandSpouts, revertAirBlock, revertAirBlock, revertBlock, stopBending

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SandSpout

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

Method Detail

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

removeSpouts

public static boolean removeSpouts(org.bukkit.Location location,
                                   double radius,
                                   org.bukkit.entity.Player sourcePlayer)

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()

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

isCanSpiral

public boolean isCanSpiral()

setCanSpiral

public void setCanSpiral(boolean canSpiral)

getAngle

public int getAngle()

setAngle

public void setAngle(int angle)

getBlindnessTime

public int getBlindnessTime()

setBlindnessTime

public void setBlindnessTime(int blindnessTime)

getTime

public long getTime()

setTime

public void setTime(long time)

getInterval

public long getInterval()

setInterval

public void setInterval(long interval)

getDamage

public double getDamage()

setDamage

public void setDamage(double damage)

getHeight

public double getHeight()

setHeight

public void setHeight(double height)

getCurrentHeight

public double getCurrentHeight()

setCurrentHeight

public void setCurrentHeight(double currentHeight)