Lightning

java.lang.Object
- com.projectkorra.projectkorra.ability.CoreAbility
- - com.projectkorra.projectkorra.ability.ElementalAbility
  - - com.projectkorra.projectkorra.ability.FireAbility
    - - com.projectkorra.projectkorra.ability.LightningAbility
      - com.projectkorra.projectkorra.firebending.Lightning

All Implemented Interfaces:: Ability, SubAbility

public class Lightning
extends LightningAbility

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Lightning.AnimationLocation` Represents a Lightning Arc Point particle animation.
`class`	`Lightning.Arc` An Arc represents a Lightning arc for the specific ability.
`class`	`Lightning.LightningParticle` A Runnable Particle that continuously displays itself until it reaches a certain time limit.
`static class`	`Lightning.State`

Constructor Summary

Constructors
Constructor and Description

Lightning(org.bukkit.entity.Player player)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`electrocute(org.bukkit.entity.LivingEntity lent)` Damages an entity, and may cause paralysis depending on the config.
`java.util.ArrayList<org.bukkit.entity.Entity>`	`getAffectedEntities()`
`java.util.ArrayList<Lightning.Arc>`	`getArcs()`
`double`	`getChainArcChance()`
`double`	`getChainRange()`
`double`	`getChargeTime()`
`long`	`getCooldown()`
`double`	`getDamage()`
`org.bukkit.Location`	`getDestination()`
`org.bukkit.Location`	`getLocation()` Specifies the Location of the ability, which may be slightly inaccurate depending on the Ability implementation.
`double`	`getMaxArcAngle()`
`double`	`getMaxChainArcs()`
`java.lang.String`	`getName()` The name of the ability is used for commands such as /bending display and /bending help.
`org.bukkit.Location`	`getOrigin()`
`double`	`getParticleRotation()`
`static int`	`getPointGeneration()`
`double`	`getRange()`
`Lightning.State`	`getState()`
`double`	`getStunChance()`
`double`	`getStunDuration()`
`double`	`getSubArcChance()`
`java.util.ArrayList<org.bukkit.scheduler.BukkitRunnable>`	`getTasks()`
`long`	`getTime()`
`double`	`getWaterArcRange()`
`int`	`getWaterArcs()`
`boolean`	`isArcOnIce()`
`boolean`	`isCharged()`
`boolean`	`isHarmlessAbility()` Determines if this ability is considered harmless against other players.
`boolean`	`isHitIce()`
`boolean`	`isHitWater()`
`boolean`	`isSelfHitClose()`
`boolean`	`isSelfHitWater()`
`boolean`	`isSneakAbility()` Determines if this ability uses the `PlayerToggleSneakEvent` as a controlling mechanism.
`void`	`progress()` Progresses the instance of this ability by 1 tick.
`void`	`removeWithTasks()` Removes the instance of this ability and cancels any current runnables
`void`	`setArcOnIce(boolean arcOnIce)`
`void`	`setChainArcChance(double chainArcChance)`
`void`	`setChainRange(double chainRange)`
`void`	`setCharged(boolean charged)`
`void`	`setChargeTime(double chargeTime)`
`void`	`setCooldown(long cooldown)`
`void`	`setDamage(double damage)`
`void`	`setDestination(org.bukkit.Location destination)`
`void`	`setHitIce(boolean hitIce)`
`void`	`setHitWater(boolean hitWater)`
`void`	`setMaxArcAngle(double maxArcAngle)`
`void`	`setMaxChainArcs(double maxChainArcs)`
`void`	`setOrigin(org.bukkit.Location origin)`
`void`	`setParticleRotation(double particleRotation)`
`void`	`setRange(double range)`
`void`	`setSelfHitClose(boolean selfHitClose)`
`void`	`setSelfHitWater(boolean selfHitWater)`
`void`	`setState(Lightning.State state)`
`void`	`setStunChance(double stunChance)`
`void`	`setStunDuration(double stunDuration)`
`void`	`setSubArcChance(double subArcChance)`
`void`	`setTime(long time)`
`void`	`setWaterArcRange(double waterArcRange)`
`void`	`setWaterArcs(int waterArcs)`

Methods inherited from class com.projectkorra.projectkorra.ability.LightningAbility
getElement, getParentAbility

Methods inherited from class com.projectkorra.projectkorra.ability.FireAbility
canFireGrief, createTempFire, getDayFactor, getDayFactor, getDayFactor, 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
  - Lightning
```
public Lightning(org.bukkit.entity.Player player)
```
- Method Detail
  - electrocute
```
public void electrocute(org.bukkit.entity.LivingEntity lent)
```
    Damages an entity, and may cause paralysis depending on the config.
    
    Parameters:
    
    lent - The LivingEntity that is being damaged
  - progress
```
public void progress()
```
    Progresses the instance of this ability by 1 tick. This is the heart of the ability, it checks if it needs to remove itself, and handles the initial Lightning Arc generation. Once all of the arcs have been created then this ability instance gets removed, but the BukkitRunnables continue until they remove themselves.
  - removeWithTasks
```
public void removeWithTasks()
```
    Removes the instance of this ability and cancels any current runnables
  - 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
  - isCharged
```
public boolean isCharged()
```
  - setCharged
```
public void setCharged(boolean charged)
```
  - isHitWater
```
public boolean isHitWater()
```
  - setHitWater
```
public void setHitWater(boolean hitWater)
```
  - isHitIce
```
public boolean isHitIce()
```
  - setHitIce
```
public void setHitIce(boolean hitIce)
```
  - isSelfHitWater
```
public boolean isSelfHitWater()
```
  - setSelfHitWater
```
public void setSelfHitWater(boolean selfHitWater)
```
  - isSelfHitClose
```
public boolean isSelfHitClose()
```
  - setSelfHitClose
```
public void setSelfHitClose(boolean selfHitClose)
```
  - isArcOnIce
```
public boolean isArcOnIce()
```
  - setArcOnIce
```
public void setArcOnIce(boolean arcOnIce)
```
  - getWaterArcs
```
public int getWaterArcs()
```
  - setWaterArcs
```
public void setWaterArcs(int waterArcs)
```
  - getRange
```
public double getRange()
```
  - setRange
```
public void setRange(double range)
```
  - getChargeTime
```
public double getChargeTime()
```
  - setChargeTime
```
public void setChargeTime(double chargeTime)
```
  - getSubArcChance
```
public double getSubArcChance()
```
  - setSubArcChance
```
public void setSubArcChance(double subArcChance)
```
  - getDamage
```
public double getDamage()
```
  - setDamage
```
public void setDamage(double damage)
```
  - getMaxChainArcs
```
public double getMaxChainArcs()
```
  - setMaxChainArcs
```
public void setMaxChainArcs(double maxChainArcs)
```
  - getChainRange
```
public double getChainRange()
```
  - setChainRange
```
public void setChainRange(double chainRange)
```
  - getWaterArcRange
```
public double getWaterArcRange()
```
  - setWaterArcRange
```
public void setWaterArcRange(double waterArcRange)
```
  - getChainArcChance
```
public double getChainArcChance()
```
  - setChainArcChance
```
public void setChainArcChance(double chainArcChance)
```
  - getStunChance
```
public double getStunChance()
```
  - setStunChance
```
public void setStunChance(double stunChance)
```
  - getStunDuration
```
public double getStunDuration()
```
  - setStunDuration
```
public void setStunDuration(double stunDuration)
```
  - getMaxArcAngle
```
public double getMaxArcAngle()
```
  - setMaxArcAngle
```
public void setMaxArcAngle(double maxArcAngle)
```
  - getParticleRotation
```
public double getParticleRotation()
```
  - setParticleRotation
```
public void setParticleRotation(double particleRotation)
```
  - getTime
```
public long getTime()
```
  - setTime
```
public void setTime(long time)
```
  - getState
```
public Lightning.State getState()
```
  - setState
```
public void setState(Lightning.State state)
```
  - getOrigin
```
public org.bukkit.Location getOrigin()
```
  - setOrigin
```
public void setOrigin(org.bukkit.Location origin)
```
  - getDestination
```
public org.bukkit.Location getDestination()
```
  - setDestination
```
public void setDestination(org.bukkit.Location destination)
```
  - getPointGeneration
```
public static int getPointGeneration()
```
  - getAffectedEntities
```
public java.util.ArrayList<org.bukkit.entity.Entity> getAffectedEntities()
```
  - getArcs
```
public java.util.ArrayList<Lightning.Arc> getArcs()
```
  - getTasks
```
public java.util.ArrayList<org.bukkit.scheduler.BukkitRunnable> getTasks()
```
  - setCooldown
```
public void setCooldown(long cooldown)
```

Class Lightning

Nested Class Summary

Constructor Summary

Method Summary

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

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

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

Lightning

Method Detail

electrocute

progress

removeWithTasks

getName

getLocation

getCooldown

isSneakAbility

isHarmlessAbility

isCharged

setCharged

isHitWater

setHitWater

isHitIce

setHitIce

isSelfHitWater

setSelfHitWater

isSelfHitClose

setSelfHitClose

isArcOnIce

setArcOnIce

getWaterArcs

setWaterArcs

getRange

setRange

getChargeTime

setChargeTime

getSubArcChance

setSubArcChance

getDamage

setDamage

getMaxChainArcs

setMaxChainArcs

getChainRange

setChainRange

getWaterArcRange

setWaterArcRange

getChainArcChance

setChainArcChance

getStunChance

setStunChance

getStunDuration

setStunDuration

getMaxArcAngle

setMaxArcAngle

getParticleRotation

setParticleRotation

getTime

setTime

getState

setState

getOrigin

setOrigin

getDestination

setDestination

getPointGeneration

getAffectedEntities

getArcs

getTasks

setCooldown