com.projectkorra.projectkorra.firebending

Class FireShield

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.FireAbility

com.projectkorra.projectkorra.firebending.FireShield

All Implemented Interfaces:

Ability

public class FireShield
extends FireAbility

Constructor Summary

Constructors

Constructor and Description
FireShield(org.bukkit.entity.Player player)
FireShield(org.bukkit.entity.Player player, boolean shield)

Method Summary

Modifier and Type	Method and Description
long	getCooldown()
double	getDiscRadius()
long	getDuration()
double	getFireTicks()
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.
double	getRadius()
long	getTime()
boolean	isHarmlessAbility() Determines if this ability is considered harmless against other players.
boolean	isIgnite()
boolean	isShield()
boolean	isSneakAbility() Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism.
static boolean	isWithinShield(org.bukkit.Location loc)
void	progress() Causes the ability to be updated.
void	setCooldown(long cooldown)
void	setDiscRadius(double discRadius)
void	setDuration(long duration)
void	setFireTicks(double fireTicks)
void	setIgnite(boolean ignite)
void	setInterval(long interval)
void	setRadius(double radius)
void	setShield(boolean shield)
void	setTime(long time)

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

canFireGrief, createTempFire, getDayFactor, getDayFactor, getDayFactor, getElement, getSubChatColor, isExplosiveAbility, isIgnitable, isIgnitable, isIgniteAbility, isWithinFireShield, playCombustionSound, playFirebendingParticles, playFirebendingSound, playLightningbendingParticle, playLightningbendingParticle, removeFire, revertTempFire, 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, remove, removeAll, start

Methods inherited from class java.lang.Object

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

Constructor Detail

FireShield

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

FireShield

public FireShield(org.bukkit.entity.Player player,
                  boolean shield)

Method Detail

isWithinShield

public static boolean isWithinShield(org.bukkit.Location loc)

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

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

isShield

public boolean isShield()

setShield

public void setShield(boolean shield)

isIgnite

public boolean isIgnite()

setIgnite

public void setIgnite(boolean ignite)

getTime

public long getTime()

setTime

public void setTime(long time)

getDuration

public long getDuration()

setDuration

public void setDuration(long duration)

getInterval

public long getInterval()

setInterval

public void setInterval(long interval)

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getDiscRadius

public double getDiscRadius()

setDiscRadius

public void setDiscRadius(double discRadius)

getFireTicks

public double getFireTicks()

setFireTicks

public void setFireTicks(double fireTicks)

setCooldown

public void setCooldown(long cooldown)