com.projectkorra.projectkorra.firebending

Class Illumination

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.FireAbility

com.projectkorra.projectkorra.firebending.Illumination

All Implemented Interfaces:

Ability

public class Illumination
extends FireAbility

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TempBlock	getBlock()
static java.util.Map<TempBlock,org.bukkit.entity.Player>	getBlocks()
long	getCooldown()
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.
byte	getNormalData()
org.bukkit.Material	getNormalType()
double	getRange()
boolean	isHarmlessAbility() Determines if this ability is considered harmless against other players.
static boolean	isIlluminationTorch(org.bukkit.block.Block block) Returns whether the block provided is a torch created by Illumination
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.
void	setBlock(TempBlock block)
void	setCooldown(long cooldown)
void	setNormalData(byte normalData)
void	setNormalType(org.bukkit.Material normalType)
void	setRange(double range)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Illumination

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

Method Detail

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

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

getNormalData

public byte getNormalData()

setNormalData

public void setNormalData(byte normalData)

getRange

public double getRange()

setRange

public void setRange(double range)

getNormalType

public org.bukkit.Material getNormalType()

setNormalType

public void setNormalType(org.bukkit.Material normalType)

getBlock

public TempBlock getBlock()

setBlock

public void setBlock(TempBlock block)

getBlocks

public static java.util.Map<TempBlock,org.bukkit.entity.Player> getBlocks()

isIlluminationTorch

public static boolean isIlluminationTorch(org.bukkit.block.Block block)

Returns whether the block provided is a torch created by Illumination

Parameters:

block - The block being tested

setCooldown

public void setCooldown(long cooldown)