com.projectkorra.projectkorra.firebending

Class FireCombo

java.lang.Object

com.projectkorra.projectkorra.ability.CoreAbility

com.projectkorra.projectkorra.ability.ElementalAbility

com.projectkorra.projectkorra.ability.FireAbility

com.projectkorra.projectkorra.firebending.FireCombo

All Implemented Interfaces:

Ability, ComboAbility

Direct Known Subclasses:

FireCombo.FireKick, FireCombo.FireSpin, FireCombo.FireWheel, FireCombo.JetBlast, FireCombo.JetBlaze

public class FireCombo
extends FireAbility
implements ComboAbility

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FireCombo.FireComboStream
class	FireCombo.FireKick
class	FireCombo.FireSpin
class	FireCombo.FireWheel
class	FireCombo.JetBlast
class	FireCombo.JetBlaze

Constructor Summary

Constructors

Constructor and Description
FireCombo(org.bukkit.entity.Player player, java.lang.String ability)

Method Summary

Modifier and Type	Method and Description
void	collision(org.bukkit.entity.LivingEntity entity, org.bukkit.util.Vector direction, FireCombo.FireComboStream fstream)
java.lang.Object	createNewComboInstance(org.bukkit.entity.Player player) Creates a new instance of the combo from a specific player.
java.lang.String	getAbility()
java.util.ArrayList<org.bukkit.entity.LivingEntity>	getAffectedEntities()
static java.util.ArrayList<java.lang.String>	getBlockableAbilities()
ClickType	getClickType()
java.util.ArrayList<ComboManager.AbilityInformation>	getCombination() Returns the list of abilities which constitute the combo.
long	getCooldown()
double	getDamage()
org.bukkit.Location	getDestination()
org.bukkit.util.Vector	getDirection()
static java.util.ArrayList<FireCombo>	getFireCombo(org.bukkit.entity.Player player, ClickType type) Returns all of the FireCombos created by a specific player but filters the abilities based on shift or click.
double	getFireTicks()
double	getHeight()
java.lang.String	getInstructions() Accessor Method to get the instructions for using this combo.
double	getKnockback()
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()
int	getProgressCounter()
double	getRadius()
double	getRange()
double	getSpeed()
java.util.ArrayList<FireCombo.FireComboStream>	getTasks()
long	getTime()
boolean	isFirstTime()
boolean	isHarmlessAbility() Determines if this ability is considered harmless against other players.
boolean	isHiddenAbility() A hidden ability is an ability that should not be shown by commands such as /bending display and /bending help.
boolean	isSneakAbility() Determines if this ability uses the PlayerToggleSneakEvent as a controlling mechanism.
void	progress() Causes the ability to be updated.
void	remove() Removes this instance of FireCombo, cleans up any blocks that are remaining in totalBlocks, and cancels any remaining tasks.
static boolean	removeAroundPoint(org.bukkit.entity.Player player, java.lang.String ability, org.bukkit.Location loc, double radius)
void	setAbility(java.lang.String ability)
void	setClickType(ClickType clickType)
void	setCooldown(long cooldown)
void	setDamage(double damage)
void	setDestination(org.bukkit.Location destination)
void	setDirection(org.bukkit.util.Vector direction)
void	setFireTicks(double fireTicks)
void	setFirstTime(boolean firstTime)
void	setHeight(double height)
void	setKnockback(double knockback)
void	setLocation(org.bukkit.Location location)
void	setOrigin(org.bukkit.Location origin)
void	setProgressCounter(int progressCounter)
void	setRadius(double radius)
void	setRange(double range)
void	setSpeed(double speed)
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, 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

FireCombo

public FireCombo(org.bukkit.entity.Player player,
                 java.lang.String ability)

Method Detail

getFireCombo

public static java.util.ArrayList<FireCombo> getFireCombo(org.bukkit.entity.Player player,
                                                          ClickType type)

Returns all of the FireCombos created by a specific player but filters the abilities based on shift or click.

removeAroundPoint

public static boolean removeAroundPoint(org.bukkit.entity.Player player,
                                        java.lang.String ability,
                                        org.bukkit.Location loc,
                                        double radius)

collision

public void collision(org.bukkit.entity.LivingEntity entity,
                      org.bukkit.util.Vector direction,
                      FireCombo.FireComboStream fstream)

progress

public void progress()

Description copied from interface: Ability

Causes the ability to be updated.

Specified by:

progress in interface Ability

remove

public void remove()

Removes this instance of FireCombo, cleans up any blocks that are remaining in totalBlocks, and cancels any remaining tasks.

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.

Specified by:

getName in interface Ability

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.

Specified by:

getLocation in interface Ability

Returns:

the location of the Ability

See Also:

BendingPlayer.canBend(CoreAbility)

getCooldown

public long getCooldown()

Specified by:

getCooldown in interface Ability

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.

Specified by:

isSneakAbility in interface Ability

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.

Specified by:

isHarmlessAbility in interface Ability

Returns:

true if the ability is harmless and should be allowed in both PvP and non-PvP zones

getInstructions

public java.lang.String getInstructions()

Description copied from interface: ComboAbility

Accessor Method to get the instructions for using this combo.

Specified by:

getInstructions in interface ComboAbility

Returns:

The steps for the combo.

createNewComboInstance

public java.lang.Object createNewComboInstance(org.bukkit.entity.Player player)

Description copied from interface: ComboAbility

Creates a new instance of the combo from a specific player. ProjectKorra's ComboModuleManager will use this method once the combo steps have been used by the player.

Specified by:

createNewComboInstance in interface ComboAbility

Parameters:

player - The player using the combo.

Returns:

A new instance of the ability.

getCombination

public java.util.ArrayList<ComboManager.AbilityInformation> getCombination()

Description copied from interface: ComboAbility

Returns the list of abilities which constitute the combo.

Specified by:

getCombination in interface ComboAbility

Returns:

An ArrayList containing the combo's steps.

isHiddenAbility

public boolean isHiddenAbility()

Description copied from interface: Ability

A hidden ability is an ability that should not be shown by commands such as /bending display and /bending help. For example: Combos, MultiAbility sub abilities, and helper abilities.

Specified by:

isHiddenAbility in interface Ability

Overrides:

isHiddenAbility in class CoreAbility

Returns:

true if the ability should not be displayed to the players

isFirstTime

public boolean isFirstTime()

setFirstTime

public void setFirstTime(boolean firstTime)

getProgressCounter

public int getProgressCounter()

setProgressCounter

public void setProgressCounter(int progressCounter)

getTime

public long getTime()

setTime

public void setTime(long time)

getDamage

public double getDamage()

setDamage

public void setDamage(double damage)

getSpeed

public double getSpeed()

setSpeed

public void setSpeed(double speed)

getRange

public double getRange()

setRange

public void setRange(double range)

getKnockback

public double getKnockback()

setKnockback

public void setKnockback(double knockback)

getFireTicks

public double getFireTicks()

setFireTicks

public void setFireTicks(double fireTicks)

getHeight

public double getHeight()

setHeight

public void setHeight(double height)

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getClickType

public ClickType getClickType()

setClickType

public void setClickType(ClickType clickType)

getAbility

public java.lang.String getAbility()

setAbility

public void setAbility(java.lang.String ability)

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)

getDirection

public org.bukkit.util.Vector getDirection()

setDirection

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

getBlockableAbilities

public static java.util.ArrayList<java.lang.String> getBlockableAbilities()

getAffectedEntities

public java.util.ArrayList<org.bukkit.entity.LivingEntity> getAffectedEntities()

getTasks

public java.util.ArrayList<FireCombo.FireComboStream> getTasks()

setCooldown

public void setCooldown(long cooldown)

setLocation

public void setLocation(org.bukkit.Location location)