AgisAbility (Atavism Server API

java.lang.Object
- atavism.agis.core.AgisAbility

Direct Known Subclasses:

CaptureBattleNodeAbility, CombatAbility, CombatMeleeAbility, CreateItemAbility, EffectAbility, FriendlyEffectAbility, MagicalAttackAbility, SpawnPetAbility, TeleportAbility
```
public class AgisAbility
extends java.lang.Object
```
The AgisAbility object describes an action that a mob can perform.
When an ability is triggered, a AgisAbility.State object is generated that represents the current state of that instance of the ability. It progresses through a sequence of states, dependent on the configuration of the AgisAbility object.
As each state is entered or exited, a method is called that can be overridden to create different types of abilities.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AgisAbility.AbilityResult`
`static class`	`AgisAbility.ActivationState`
`static class`	`AgisAbility.AoeType`
`static class`	`AgisAbility.Entry` From what I can tell, this class is pointless. - Andrew
`static class`	`AgisAbility.TargetSpecies`
`static class`	`AgisAbility.TargetType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`activationCost`
`protected float`	`activationCostPercentage`
`protected long`	`activationDelay`
`protected long`	`activationTime`
`protected int`	`activePulseCost`
`protected long`	`activePulseTime`
`protected int`	`ammoReq`
`protected int`	`aoe_targets_count`
`protected int`	`aoe_targets_count_type`
`protected AgisAbility.AoeType`	`aoeType`
`protected float`	`areaOfEffectAngle`
`protected float`	`areaOfEffectRadius`
`java.util.LinkedList<java.lang.Integer>`	`attackerEffectConsumption`
`java.util.LinkedList<java.lang.Integer>`	`attackerEffectReqs`
`boolean`	`autoRotateToTarget`
`protected java.lang.String`	`castingAffinity`
`protected java.lang.String`	`castingAnim`
`protected boolean`	`castingInRun`
`protected boolean`	`channelled`
`protected boolean`	`channelled_in_run`
`protected int`	`channelPulses`
`protected long`	`channelPulseTime`
`protected float`	`chunk_length`
`protected java.lang.String`	`completeAnimation`
`protected java.lang.String`	`completeSound`
`protected boolean`	`consumeOnActivation`
`protected java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`consumeReagentList`
`protected java.util.Map<java.lang.String,Cooldown>`	`cooldownMap`
`protected java.util.Map<AgisAbility.ActivationState,java.util.Set<CoordinatedEffect>>`	`coordEffectMap`
`protected java.lang.String`	`costProp`
`protected boolean`	`decrementWeaponUses`
`protected java.lang.String`	`displayName`
`protected java.lang.String`	`icon`
`protected int`	`interceptType`
`protected java.util.concurrent.locks.Lock`	`lock` AgisAbility lock
`protected int`	`maxRange`
`protected int`	`minRange`
`protected boolean`	`persistent`
`int`	`position`
`protected int`	`prediction`
`protected int`	`pulseAmmoReq`
`java.util.LinkedList<java.lang.Integer>`	`pulseAttackerEffectConsumption`
`java.util.LinkedList<java.lang.Integer>`	`pulseAttackerEffectReqs`
`protected java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`pulseConsumeReagentList`
`protected int`	`pulseCost`
`protected float`	`pulseCostPercentage`
`protected java.lang.String`	`pulseCostProp`
`protected java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`pulseReagentList`
`java.util.LinkedList<java.lang.Integer>`	`pulseTargetEffectConsumption`
`java.util.LinkedList<java.lang.Integer>`	`pulseTargetEffectReqs`
`protected java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`reagentList`
`boolean`	`reqFacingTarget`
`protected boolean`	`reqTarget`
`static int`	`RESULT_BLOCKED`
`static int`	`RESULT_CRITICAL`
`static int`	`RESULT_DODGED`
`static int`	`RESULT_EVADED`
`static int`	`RESULT_HIT`
`static int`	`RESULT_IMMUNE`
`static int`	`RESULT_MISSED`
`static int`	`RESULT_PARRIED`
`protected boolean`	`sendSkillUpChance`
`protected int`	`skillExp`
`protected int`	`skillType`
`boolean`	`skipChecks`
`protected java.util.LinkedList<java.lang.String>`	`specificTargets`
`protected float`	`speed`
`protected java.lang.String`	`stanceReq`
`protected boolean`	`startCooldownsOnActivation`
`protected boolean`	`stationary`
`boolean`	`stealthReduce`
`protected int`	`tag_to_disable`
`protected int`	`tag_to_disable_count`
`protected java.util.ArrayList<java.lang.Integer>`	`tags`
`protected java.util.LinkedList<AgisAbility.TargetSpecies>`	`targetableSpecies`
`protected int`	`targetDeath`
`java.util.LinkedList<java.lang.Integer>`	`targetEffectConsumption`
`java.util.LinkedList<java.lang.Integer>`	`targetEffectReqs`
`protected java.util.ArrayList<CombatInfo>`	`targets`
`protected java.util.HashMap<OID,java.lang.Float>`	`targetsWithDistance`
`protected AgisAbility.TargetType`	`targetType`
`protected boolean`	`toggle`
`protected java.util.ArrayList<java.lang.Integer>`	`toolList`
`protected java.lang.String`	`tooltip`
`protected boolean`	`usedAbility`
`protected boolean`	`useGlobalCooldown`
`protected int`	`vigor`
`java.lang.String`	`weaponReq`

Constructor Summary

Constructors
Constructor and Description

AgisAbility(java.lang.String name)

Constructors
Constructor and Description
`AgisAbility(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`abortAbility(AgisAbilityState state)`
`void`	`addAttackerEffectConsumption(int effectReq)`
`void`	`addAttackerEffectReq(int effectReq)`
`void`	`addConsumeReagent(java.lang.Integer reagent, java.lang.Integer count)`
`void`	`addCooldown(Cooldown cd)` Adds a cooldown to this ability.
`boolean`	`addCoordEffect(AgisAbility.ActivationState state, CoordinatedEffect effect)`
`void`	`addPulseAttackerEffectConsumption(int effectReq)`
`void`	`addPulseAttackerEffectReq(int effectReq)`
`void`	`addPulseConsumeReagent(java.lang.Integer reagent, java.lang.Integer count)`
`void`	`addPulseReagent(java.lang.Integer reagent, java.lang.Integer count)` Adds a reagent requirement to pulse in this ability.
`void`	`addPulseTargetEffectConsumption(int effectReq)`
`void`	`addPulseTargetEffectReq(int effectReq)`
`void`	`addReagent(java.lang.Integer reagent, java.lang.Integer count)` Adds a reagent requirement to this ability.
`void`	`addSpecificTarget(java.lang.String name)`
`void`	`addTag(int val)`
`void`	`addTargetableSpecies(AgisAbility.TargetSpecies species)`
`void`	`addTargetEffectConsumption(int effectReq)`
`void`	`addTargetEffectReq(int effectReq)`
`void`	`addTool(int tool)` Adds a tool requirement to this ability.
`boolean`	`autoRotateToTarget()`
`void`	`autoRotateToTarget(boolean autoRotateToTarget)`
`void`	`beginActivated(AgisAbilityState state)`
`void`	`beginActivation(AgisAbilityState state)`
`void`	`beginChannelling(AgisAbilityState state)`
`protected void`	`changeCoordinatedEffect(java.lang.String result)`
`AgisAbility.AbilityResult`	`checkAbility(CombatInfo obj, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkAbility(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state, AgisAbilityState abilityState)`
`protected AgisAbility.AbilityResult`	`checkAbilityType(CombatInfo obj, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkAmmo(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkCost(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkDeath(CombatInfo obj, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkDeath(CombatInfo obj, CombatInfo target, boolean abilityCheck)`
`protected AgisAbility.AbilityResult`	`checkEffects(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkEffects(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state, boolean abilityCheck)`
`AgisAbility.AbilityResult`	`checkEquip(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkHasAbility(CombatInfo obj, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkPosition(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state, BasicWorldNode attackerNode)`
`protected AgisAbility.AbilityResult`	`checkPulseEffects(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkPulseEffects(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state, boolean abilityCheck)`
`protected AgisAbility.AbilityResult`	`checkPulseReagent(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkRange(CombatInfo obj, CombatInfo target, BasicWorldNode casterWNode, float rangeTolerance)`
`protected AgisAbility.AbilityResult`	`checkRange(CombatInfo obj, CombatInfo target, BasicWorldNode casterWNode, float rangeTolerance, boolean abilityCheck)`
`protected AgisAbility.AbilityResult`	`checkRange(CombatInfo obj, CombatInfo target, BasicWorldNode casterWNode, float rangeTolerance, boolean abilityCheck, AgisAbilityState abilityState)`
`protected AgisAbility.AbilityResult`	`checkReady(CombatInfo obj, CombatInfo target, BasicWorldNode casterWNode)`
`protected AgisAbility.AbilityResult`	`checkReagent(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkSpecificTarget(CombatInfo caster, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkStance(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkState(CombatInfo obj, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkTarget(CombatInfo caster, CombatInfo target)` Checks if the caster's current target is a valid target for the ability.
`protected AgisAbility.AbilityResult`	`checkTargetSpecies(CombatInfo caster, CombatInfo target)`
`protected AgisAbility.AbilityResult`	`checkTool(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`protected AgisAbility.AbilityResult`	`checkVigor(CombatInfo obj, CombatInfo target, AgisAbility.ActivationState state)`
`void`	`completeActivation(AgisAbilityState state)`
`boolean`	`completeActivationCasterConsume(AgisAbilityState state)` Consume reagents, stat on Caster
`void`	`completeActivationTargetConsume(AgisAbilityState state)`
`void`	`completeChannelling(AgisAbilityState state)`
`static void`	`deactivateAbility(AgisAbilityState state)`
`void`	`endActivated(AgisAbilityState state)`
`boolean`	`equals(java.lang.Object other)` Returns if two objects are the same - tested by comparing the ability name.
`protected AgisAbilityState`	`generateState(CombatInfo source, CombatInfo target, AgisItem item, Point loc)`
`int`	`getAbilityType()`
`int`	`getActivationCost()` Returns the stat cost for successfully activating the ability.
`float`	`getActivationCostPercentage()` Returns percentage of the cost for successfully activating the ability.
`long`	`getActivationDelay()` Returns the time the ability takes to activate.
`long`	`getActivationTime()` Returns the time the ability takes to activate.
`int`	`getActiveCost()` Returns the stat cost charged for each pulse of the active phase.
`int`	`getActivePulseCost()`
`long`	`getActivePulseTime()` Returns the time in ms for each pulse of the active phase.
`int`	`getAmmoReq()`
`java.util.ArrayList<CombatInfo>`	`getAoETargets(CombatInfo caster, CombatInfo targetInfo, Point loc, float minRange, float maxRange, atavism.agis.core.AgisAbilityPulsState state)` Should this be merged up into the function above?
`java.util.ArrayList<CombatInfo>`	`getAoETargets(CombatInfo caster, CombatInfo targetInfo, Point loc, float minRange, float maxRange, AgisAbilityState state)` Should this be merged up into the function above?
`int`	`getAoeTargtetsCount()` Get the maximum number of targets on which the effects will be applied
`int`	`getAoeTargtetsCountType()`
`AgisAbility.AoeType`	`getAoEType()`
`float`	`getAreaOfEffectAngle()` If the areaOfEffectRadius is greater than zero the system will check for all possible targets in the region and try apply the effects to them.
`float`	`getAreaOfEffectRadius()`
`java.util.LinkedList<java.lang.Integer>`	`GetAttackerEffectConsumption()`
`java.util.LinkedList<java.lang.Integer>`	`GetAttackerEffectReqs()`
`int`	`getBaseExpThreshold()` -Experience system component - Not currently used Returns the default max experience that will be needed before the ability gains a level.
`java.lang.String`	`getCastingAffinity()` The casting Affinity
`java.lang.String`	`getCastingAnim()` The casting Anim is for abilities that have a cast, it determines which animation should be used.
`boolean`	`getCastingInRun()`
`boolean`	`getChannelled()`
`boolean`	`getChannelledInRun()`
`int`	`getChannelPulses()` Returns the number of pulses during the channelled phase.
`long`	`getChannelPulseTime()` Returns the time in ms for each pulse of a channelled ability.
`java.lang.String`	`getCompleteAnimation()`
`java.lang.String`	`getCompleteSound()`
`boolean`	`getConsumeOnActivation()`
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getConsumeReagentList()`
`java.util.Map<java.lang.String,Cooldown>`	`getCooldownMap()`
`java.util.Collection<CoordinatedEffect>`	`getCoordEffects(AgisAbility.ActivationState state)`
`java.lang.String`	`getCostProperty()` Returns the name of the property that stat costs are deducted from.
`boolean`	`getDecrementWeaponUses()`
`java.lang.String`	`getDisplayName()`
`int`	`getDuelID()`
`int`	`getExperiencePerUse()` -Experience system component - Not currently used Returns the amount of experience should be gained by successful use of this ability.
`java.lang.String`	`getIcon()` Returns the icon name for this ability.
`int`	`getID()`
`int`	`getInterceptType()`
`float`	`getInterruptChance()` the function returns interruption chance
`LevelingMap`	`getLevelingMap()`
`int`	`getMaxRange()` Returns the maximum range in metres for this ability.
`int`	`getMaxRank()` -Experience system component - Not currently used Returns the max rank that an ability may achieve.
`int`	`getMinRange()` Returns the minimum range in mm for this ability.
`java.lang.String`	`getName()` Returns the name of the ability.
`boolean`	`getPersistent()`
`int`	`getPositional()`
`java.util.List<CombatInfo>`	`getPotentialTargets(AgisAbilityState state)` This method gets the list of combat info objects we should lock.
`int`	`getPulseAmmoReq()`
`java.util.LinkedList<java.lang.Integer>`	`GetPulseAttackerEffectConsumption()`
`java.util.LinkedList<java.lang.Integer>`	`GetPulseAttackerEffectReqs()`
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getPulseConsumeReagentList()`
`int`	`getPulseCost()` Returns the stat cost charged for each channelling pulse.
`float`	`getPulseCostPercentage()` Returns percentage of the cost for pulse of the ability.
`java.lang.String`	`getPulseCostProperty()` Returns the name of the property that stat costs are deducted from.
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getPulseReagentList()`
`java.util.LinkedList<java.lang.Integer>`	`GetPulseTargetEffectConsumption()`
`java.util.LinkedList<java.lang.Integer>`	`GetPulseTargetEffectReqs()`
`float`	`getRangeChunkLength()` Return part of range for check in meters
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getReagentList()`
`boolean`	`getReqFacingTarget()`
`boolean`	`getReqTarget()` Returns whether a target is required for this ability to activate
`AgisSkill`	`getRequiredSkill()`
`int`	`getRequiredSkillLevel()`
`AgisEffect`	`getResultVal(java.lang.String result, boolean caster)`
`int`	`getSkillExp()`
`int`	`getSkillType()`
`boolean`	`getSkipChecks()`
`java.lang.String`	`getSlashCommand()`
`java.util.LinkedList<java.lang.String>`	`getSpecificTargets()` Returns the list of acceptable specific targets for this ability.
`float`	`getSpeed()` Return projectile speed in meters per second
`java.lang.String`	`getStance()` Returns the vigor amount added or required for the ability.
`boolean`	`getStationary()`
`boolean`	`getStealthReduce()`
`java.util.ArrayList<java.lang.Integer>`	`getTags()`
`int`	`getTagToDisable()`
`int`	`getTagToDisableCount()`
`java.util.LinkedList<AgisAbility.TargetSpecies>`	`getTargetableSpecies()` Returns the list of acceptable specific targets for this ability.
`int`	`getTargetDeath()` Returns the target type for this ability.
`java.util.LinkedList<java.lang.Integer>`	`GetTargetEffectConsumption()`
`java.util.LinkedList<java.lang.Integer>`	`GetTargetEffectReqs()`
`void`	`getTargets(AgisAbilityState state)`
`java.util.ArrayList<CombatInfo>`	`getTargets(AgisAbilityState state, atavism.agis.core.AgisAbilityPulsState pulsState)`
`AgisAbility.TargetType`	`getTargetType()` Returns the target type for this ability.
`java.util.ArrayList<java.lang.Integer>`	`getToolList()`
`java.lang.String`	`getTooltip()`
`boolean`	`getUseGlobalCooldown()`
`int`	`getVigor()` Returns the vigor amount added or required for the ability.
`java.lang.String`	`getWeaponReq()`
`int`	`hashCode()` Returns a hash of the ability name
`void`	`interrupt(AgisAbilityState state)`
`static void`	`interruptAbility(AgisAbilityState state, AgisAbility.AbilityResult reason)`
`boolean`	`isInstant()` Returns if the ability has 0 activation time.
`boolean`	`isInterruptible()` the function returns whether the ability is interruptible
`boolean`	`isToggle()`
`void`	`isToggle(boolean val)`
`void`	`pulseActivated(AgisAbilityState state)`
`void`	`pulseCaster(AgisAbilityState state)`
`void`	`pulseChannelling(AgisAbilityState state)`
`boolean`	`pulseChecking(AgisAbilityState state)`
`void`	`pulseConsumeTarget(AgisAbilityState state)`
`void`	`pulseConsumeTarget(AgisAbilityState state, java.util.ArrayList<CombatInfo> targets)`
`void`	`pulseTarget(AgisAbilityState state)`
`void`	`pulseTarget(AgisAbilityState state, java.util.ArrayList<CombatInfo> targets)`
`void`	`removeCooldown(java.lang.String id)` Removes a cooldown from this ability.
`boolean`	`removeCoordEffect(AgisAbility.ActivationState state, CoordinatedEffect effect)`
`static void`	`sendToggleInfo(AgisAbilityState state)`
`void`	`setAbilityType(int abilityType)`
`void`	`setActivationCost(int cost)` Sets the stat cost for successfully activating the ability.
`void`	`setActivationCostPercentage(float cost)` Sets percentage of the cost for successfully activating the ability.
`void`	`setActivationDelay(long time)` Sets the time the ability takes to activate.
`void`	`setActivationTime(long time)` Sets the time the ability takes to activate.
`void`	`setActiveCost(int cost)` Sets the stat cost charged for each pulse of the active phase.
`void`	`setActivePulseCost(int cost)`
`void`	`setActivePulseTime(long time)` Set the time in ms for each pulse of the active phase.
`void`	`setAmmoReq(int ammoReq)`
`void`	`setAoeTargetsCount(int value)` Set the maximum number of targets on which the effects will be applied
`void`	`setAoeTargetsCountType(int value)` Set the type of searche
`void`	`setAoETypeType(AgisAbility.AoeType type)`
`void`	`setAreaOfEffectAngle(float angle)`
`void`	`setAreaOfEffectRadius(float radius)`
`void`	`setBaseExpThreshold(int max)` -Experience system component - Not currently used Sets the default max experience that will be needed before the ability gains a level.
`void`	`setCastingAffinity(java.lang.String affinity)`
`void`	`setCastingAnim(java.lang.String anim)`
`void`	`setCastingInRun(boolean value)`
`void`	`setChannelled(boolean val)`
`void`	`setChannelledInRun(boolean val)`
`void`	`setChannelPulses(int pulses)` Sets the number of pulses during the channelled phase.
`void`	`setChannelPulseTime(long time)` Sets the time in ms for each pulse of a channelled ability.
`void`	`setCompleteAnimation(java.lang.String anim)`
`void`	`setCompleteSound(java.lang.String sound)`
`void`	`setConsumeOnActivation(boolean consumeOnActivation)`
`void`	`setConsumeReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)`
`void`	`setCooldownMap(java.util.Map<java.lang.String,Cooldown> cooldownMap)`
`void`	`setCostProperty(java.lang.String name)` Sets the name of the property that stat costs are deducted from.
`void`	`setDecrementWeaponUses(boolean decrement)`
`void`	`setDisplayName(java.lang.String displayName)`
`void`	`setDuelID(int duelID)`
`void`	`setExperiencePerUse(int xp)` -Experience system component - Not currently used Sets the amount of experience should be gained by successful use of this ability.
`void`	`setIcon(java.lang.String icon)` Sets the icon name for this ability.
`void`	`setID(int id)`
`void`	`setInterceptType(int interceptType)`
`void`	`setInterruptChance(float val)` function to set ability interruption chance
`void`	`setInterruptible(boolean val)` function to set ability is interruptible
`void`	`setLevelingMap(LevelingMap lm)`
`void`	`setMaxRange(int range)` Sets the maximum range in metres for this ability.
`void`	`setMaxRank(int rank)` -Experience system component - Not currently used Sets the max rank that an ability may achieve.
`void`	`setMinRange(int range)` Sets the minimum range in mm for this ability.
`void`	`setName(java.lang.String name)` Sets the name of the ability.
`void`	`setPersistent(boolean val)`
`void`	`setPositional(int positional)`
`void`	`setPredictionMode(int val)`
`void`	`setPulseAmmoReq(int ammoReq)`
`void`	`setPulseConsumeReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)`
`void`	`setPulseCost(int cost)` Sets the stat cost charged for each channelling pulse.
`void`	`setPulseCostPercentage(float cost)` Sets percentage of the cost for successfully activating the ability.
`void`	`setPulseCostProperty(java.lang.String name)` Sets the name of the property that stat costs are deducted from.
`void`	`setPulseReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)`
`void`	`setRangeChunkLength(float partRange)` Set part of range for check in meters
`void`	`setReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)`
`void`	`setReqFacingTarget(boolean reqFacingTarget)`
`void`	`setReqTarget(boolean req)` Sets whether a target is required for this ability to activate
`void`	`setRequiredSkill(AgisSkill skill, int level)`
`void`	`setSkillExp(int skillExp)`
`void`	`setSkillType(int skillType)`
`void`	`setSkipChecks(boolean value)`
`void`	`setSlashCommand(java.lang.String slashCommand)` exposes a way for the client to execute ability with a slash command
`void`	`setSpecificTargets(java.util.LinkedList<java.lang.String> targets)` Sets the list of acceptable specific targets for this ability.
`void`	`setSpeed(float speed)` Set projectile speed in meters per second
`void`	`setStance(java.lang.String stance)` Sets the amount of vigor to be added or required to activate the ability
`void`	`setStationary(boolean val)`
`void`	`setStealthReduce(boolean value)`
`void`	`setTagToDisable(int id)`
`void`	`setTagToDisableCount(int count)`
`void`	`setTargetableSpecies(java.util.LinkedList<AgisAbility.TargetSpecies> targets)` Sets the list of acceptable specific targets for this ability.
`void`	`setTargetDeath(int type)` Sets the target type for this ability.
`void`	`setTargetType(AgisAbility.TargetType type)` Sets the target type for this ability.
`void`	`setToolList(java.util.ArrayList<java.lang.Integer> toolList)`
`void`	`setTooltip(java.lang.String tooltip)`
`void`	`setUseGlobalCooldown(boolean val)`
`void`	`setVigor(int value)` Sets the amount of vigor to be added or required to activate the ability
`void`	`setWeaponReq(java.lang.String weaponType)`
`static java.util.HashMap<OID,java.lang.Float>`	`sortByValue(java.util.HashMap<OID,java.lang.Float> hm)`
`static void`	`startAbility(AgisAbility ability, CombatInfo source, CombatInfo target, AgisItem item)`
`static void`	`startAbility(AgisAbility ability, CombatInfo source, CombatInfo target, AgisItem item, Point loc)`
`boolean`	`startCooldownsOnActivation()`
`void`	`startCooldownsOnActivation(boolean startCooldowns)`
`java.lang.String`	`toString()` Returns the string describing this ability, useful for logging.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lock

protected transient java.util.concurrent.locks.Lock lock

AgisAbility lock

skillType
```
protected int skillType
```

activationDelay
```
protected long activationDelay
```

activationTime
```
protected long activationTime
```

activationCost
```
protected int activationCost
```

activationCostPercentage

protected float activationCostPercentage

costProp
```
protected java.lang.String costProp
```

channelPulseTime
```
protected long channelPulseTime
```

channelPulses
```
protected int channelPulses
```

pulseCost
```
protected int pulseCost
```

pulseCostProp

protected java.lang.String pulseCostProp

pulseCostPercentage
```
protected float pulseCostPercentage
```

activePulseTime
```
protected long activePulseTime
```

activePulseCost
```
protected int activePulseCost
```

icon
```
protected java.lang.String icon
```

displayName
```
protected java.lang.String displayName
```

tooltip
```
protected java.lang.String tooltip
```

interceptType
```
protected int interceptType
```

toggle
```
protected boolean toggle
```

tag_to_disable
```
protected int tag_to_disable
```

tag_to_disable_count
```
protected int tag_to_disable_count
```

cooldownMap

protected java.util.Map<java.lang.String,Cooldown> cooldownMap

startCooldownsOnActivation

protected boolean startCooldownsOnActivation

consumeOnActivation
```
protected boolean consumeOnActivation
```

weaponReq
```
public java.lang.String weaponReq
```

decrementWeaponUses
```
protected boolean decrementWeaponUses
```

reagentList

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList

consumeReagentList

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> consumeReagentList

pulseReagentList

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> pulseReagentList

pulseConsumeReagentList

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> pulseConsumeReagentList

toolList

protected java.util.ArrayList<java.lang.Integer> toolList

ammoReq
```
protected int ammoReq
```

pulseAmmoReq
```
protected int pulseAmmoReq
```

vigor
```
protected int vigor
```

stanceReq
```
protected java.lang.String stanceReq
```

castingAnim
```
protected java.lang.String castingAnim
```

castingAffinity

protected java.lang.String castingAffinity

reqTarget
```
protected boolean reqTarget
```

targetType

protected AgisAbility.TargetType targetType

specificTargets

protected java.util.LinkedList<java.lang.String> specificTargets

targetableSpecies

protected java.util.LinkedList<AgisAbility.TargetSpecies> targetableSpecies

targetDeath
```
protected int targetDeath
```

attackerEffectReqs

public java.util.LinkedList<java.lang.Integer> attackerEffectReqs

pulseAttackerEffectReqs

public java.util.LinkedList<java.lang.Integer> pulseAttackerEffectReqs

targetEffectReqs

public java.util.LinkedList<java.lang.Integer> targetEffectReqs

pulseTargetEffectReqs

public java.util.LinkedList<java.lang.Integer> pulseTargetEffectReqs

attackerEffectConsumption

public java.util.LinkedList<java.lang.Integer> attackerEffectConsumption

pulseAttackerEffectConsumption

public java.util.LinkedList<java.lang.Integer> pulseAttackerEffectConsumption

targetEffectConsumption

public java.util.LinkedList<java.lang.Integer> targetEffectConsumption

pulseTargetEffectConsumption

public java.util.LinkedList<java.lang.Integer> pulseTargetEffectConsumption

useGlobalCooldown
```
protected boolean useGlobalCooldown
```

stationary
```
protected boolean stationary
```

channelled
```
protected boolean channelled
```

channelled_in_run
```
protected boolean channelled_in_run
```

persistent
```
protected boolean persistent
```

coordEffectMap

protected java.util.Map<AgisAbility.ActivationState,java.util.Set<CoordinatedEffect>> coordEffectMap

completeAnimation

protected java.lang.String completeAnimation

completeSound

protected java.lang.String completeSound

sendSkillUpChance
```
protected boolean sendSkillUpChance
```

aoe_targets_count
```
protected int aoe_targets_count
```

aoe_targets_count_type
```
protected int aoe_targets_count_type
```

usedAbility
```
protected boolean usedAbility
```

targets

protected java.util.ArrayList<CombatInfo> targets

targetsWithDistance

protected java.util.HashMap<OID,java.lang.Float> targetsWithDistance

prediction
```
protected int prediction
```

skipChecks
```
public boolean skipChecks
```

stealthReduce
```
public boolean stealthReduce
```

RESULT_HIT
```
public static final int RESULT_HIT
```
See Also:

Constant Field Values

RESULT_CRITICAL
```
public static final int RESULT_CRITICAL
```
See Also:

Constant Field Values

RESULT_MISSED
```
public static final int RESULT_MISSED
```
See Also:

Constant Field Values

RESULT_PARRIED
```
public static final int RESULT_PARRIED
```
See Also:

Constant Field Values

RESULT_DODGED
```
public static final int RESULT_DODGED
```
See Also:

Constant Field Values

RESULT_BLOCKED
```
public static final int RESULT_BLOCKED
```
See Also:

Constant Field Values

RESULT_EVADED
```
public static final int RESULT_EVADED
```
See Also:

Constant Field Values

RESULT_IMMUNE
```
public static final int RESULT_IMMUNE
```
See Also:

Constant Field Values

Constructor Detail

AgisAbility

public AgisAbility(java.lang.String name)

Method Detail

toString
```
public java.lang.String toString()
```
Returns the string describing this ability, useful for logging.

Overrides:

toString in class java.lang.Object

Returns:

string describing ability

equals
```
public boolean equals(java.lang.Object other)
```
Returns if two objects are the same - tested by comparing the ability name. null objects are never equal to any other object including other null objects.

Overrides:

equals in class java.lang.Object

Returns:

true if abilities match

hashCode
```
public int hashCode()
```
Returns a hash of the ability name

Overrides:

hashCode in class java.lang.Object

Returns:

hash value of the object's ability name

setName
```
public void setName(java.lang.String name)
```
Sets the name of the ability. This is used to identify the ability, so it should be unique.

Parameters:

name - name for this ability.

getName
```
public java.lang.String getName()
```
Returns the name of the ability.

Returns:

name for this ability.

setID
```
public void setID(int id)
```

getID
```
public int getID()
```

setSkillType

public void setSkillType(int skillType)

getSkillType
```
public int getSkillType()
```

setAbilityType

public void setAbilityType(int abilityType)

getAbilityType
```
public int getAbilityType()
```

setDuelID
```
public void setDuelID(int duelID)
```

getDuelID
```
public int getDuelID()
```

getActivationDelay
```
public long getActivationDelay()
```
Returns the time the ability takes to activate.

Returns:

time in ms to activate the ability.

setActivationDelay
```
public void setActivationDelay(long time)
```
Sets the time the ability takes to activate.

Parameters:

time - time in ms that the ability takes to activate.

getActivationTime
```
public long getActivationTime()
```
Returns the time the ability takes to activate.

Returns:

time in ms to activate the ability.

setActivationTime
```
public void setActivationTime(long time)
```
Sets the time the ability takes to activate.

Parameters:

time - time in ms that the ability takes to activate.

isInstant
```
public boolean isInstant()
```
Returns if the ability has 0 activation time.

Returns:

true if activate time is 0.

getActivationCost
```
public int getActivationCost()
```
Returns the stat cost for successfully activating the ability.

Returns:

stat cost for activating the ability.

setActivationCost
```
public void setActivationCost(int cost)
```
Sets the stat cost for successfully activating the ability.

Parameters:

cost - stat cost for activating the ability.

getActivationCostPercentage
```
public float getActivationCostPercentage()
```
Returns percentage of the cost for successfully activating the ability.

Returns:

cost for activating the ability.

setActivationCostPercentage
```
public void setActivationCostPercentage(float cost)
```
Sets percentage of the cost for successfully activating the ability.

Parameters:

cost - cost for activating the ability.

getCostProperty
```
public java.lang.String getCostProperty()
```
Returns the name of the property that stat costs are deducted from.

Returns:

name of the property that stat costs are deducted from.

setCostProperty
```
public void setCostProperty(java.lang.String name)
```
Sets the name of the property that stat costs are deducted from.

Parameters:

name - name of the property that stat costs are deducted from.

getChannelPulseTime
```
public long getChannelPulseTime()
```
Returns the time in ms for each pulse of a channelled ability.

Returns:

time in ms for each pulse of a channelled ability.

setChannelPulseTime
```
public void setChannelPulseTime(long time)
```
Sets the time in ms for each pulse of a channelled ability.

Parameters:

time - time in ms for each pulse of a channelled ability.

getChannelPulses
```
public int getChannelPulses()
```
Returns the number of pulses during the channelled phase.

Returns:

number of pulses during the channelled phase for the ability.

setChannelPulses
```
public void setChannelPulses(int pulses)
```
Sets the number of pulses during the channelled phase.

Parameters:

pulses - number of pulses during the channelled phase for the ability.

getPulseCost
```
public int getPulseCost()
```
Returns the stat cost charged for each channelling pulse.

Returns:

stat cost charged for each channelling pulse.

setPulseCost
```
public void setPulseCost(int cost)
```
Sets the stat cost charged for each channelling pulse.

Parameters:

cost - stat cost charged for each channelling pulse.

getPulseCostProperty
```
public java.lang.String getPulseCostProperty()
```
Returns the name of the property that stat costs are deducted from.

Returns:

name of the property that stat costs are deducted from.

setPulseCostProperty
```
public void setPulseCostProperty(java.lang.String name)
```
Sets the name of the property that stat costs are deducted from.

Parameters:

name - name of the property that stat costs are deducted from.

getPulseCostPercentage
```
public float getPulseCostPercentage()
```
Returns percentage of the cost for pulse of the ability.

Returns:

cost for pulse of the ability.

setPulseCostPercentage
```
public void setPulseCostPercentage(float cost)
```
Sets percentage of the cost for successfully activating the ability.

Parameters:

cost - cost for activating the ability.

getActivePulseTime
```
public long getActivePulseTime()
```
Returns the time in ms for each pulse of the active phase.

Returns:

time in ms for each pulse of the active phase.

setActivePulseTime
```
public void setActivePulseTime(long time)
```
Set the time in ms for each pulse of the active phase.

Parameters:

time - time in ms for each pulse of the active phase.

getActiveCost
```
public int getActiveCost()
```
Returns the stat cost charged for each pulse of the active phase.

Returns:

stat cost charged for each pulse of the active phase.

getActivePulseCost
```
public int getActivePulseCost()
```

setActiveCost
```
public void setActiveCost(int cost)
```
Sets the stat cost charged for each pulse of the active phase.

Parameters:

cost - stat cost charged for each pulse of hte active phase.

setActivePulseCost

public void setActivePulseCost(int cost)

getIcon
```
public java.lang.String getIcon()
```
Returns the icon name for this ability.

Returns:

icon name for this ability.

setIcon
```
public void setIcon(java.lang.String icon)
```
Sets the icon name for this ability.

Parameters:

icon - icon name for this ability.

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getTooltip
```
public java.lang.String getTooltip()
```

setTooltip

public void setTooltip(java.lang.String tooltip)

getInterceptType
```
public int getInterceptType()
```

setInterceptType

public void setInterceptType(int interceptType)

isToggle
```
public boolean isToggle()
```

isToggle
```
public void isToggle(boolean val)
```

setTagToDisable
```
public void setTagToDisable(int id)
```

getTagToDisable
```
public int getTagToDisable()
```

setTagToDisableCount

public void setTagToDisableCount(int count)

getTagToDisableCount
```
public int getTagToDisableCount()
```

getTags

public java.util.ArrayList<java.lang.Integer> getTags()

addTag
```
public void addTag(int val)
```

getMinRange
```
public int getMinRange()
```
Returns the minimum range in mm for this ability.

Returns:

minimum range in mm for this ability.

setMinRange
```
public void setMinRange(int range)
```
Sets the minimum range in mm for this ability.

Parameters:

range - minimum range in mm for this ability.

getMaxRange
```
public int getMaxRange()
```
Returns the maximum range in metres for this ability.

Returns:

maximum range in metres for this ability.

setMaxRange
```
public void setMaxRange(int range)
```
Sets the maximum range in metres for this ability.

Parameters:

range - Maximum range in metres for this ability.

getSpeed
```
public float getSpeed()
```
Return projectile speed in meters per second

Returns:

setSpeed
```
public void setSpeed(float speed)
```
Set projectile speed in meters per second

Parameters:

speed -

getRangeChunkLength
```
public float getRangeChunkLength()
```
Return part of range for check in meters

Returns:

setRangeChunkLength
```
public void setRangeChunkLength(float partRange)
```
Set part of range for check in meters

Parameters:

speed -

getCastingInRun
```
public boolean getCastingInRun()
```

setCastingInRun

public void setCastingInRun(boolean value)

getAreaOfEffectAngle
```
public float getAreaOfEffectAngle()
```
If the areaOfEffectRadius is greater than zero the system will check for all possible targets in the region and try apply the effects to them.

Returns:

area Of Effect Radius

setAreaOfEffectAngle

public void setAreaOfEffectAngle(float angle)

getAreaOfEffectRadius
```
public float getAreaOfEffectRadius()
```

setAreaOfEffectRadius

public void setAreaOfEffectRadius(float radius)

getAoEType

public AgisAbility.AoeType getAoEType()

setAoETypeType

public void setAoETypeType(AgisAbility.AoeType type)

getReqFacingTarget
```
public boolean getReqFacingTarget()
```

setReqFacingTarget

public void setReqFacingTarget(boolean reqFacingTarget)

autoRotateToTarget
```
public boolean autoRotateToTarget()
```

autoRotateToTarget

public void autoRotateToTarget(boolean autoRotateToTarget)

getSkillExp
```
public int getSkillExp()
```

setSkillExp

public void setSkillExp(int skillExp)

setPositional

public void setPositional(int positional)

getPositional
```
public int getPositional()
```

addCooldown
```
public void addCooldown(Cooldown cd)
```
Adds a cooldown to this ability. If any of the ability's cooldowns are activate on the mob attempting to activate the ability, it will not be able to activate.

Parameters:

cd - Cooldown to add to this ability.

removeCooldown
```
public void removeCooldown(java.lang.String id)
```
Removes a cooldown from this ability.

Parameters:

id - id of the cooldown to remove.

getCooldownMap

public java.util.Map<java.lang.String,Cooldown> getCooldownMap()

setCooldownMap

public void setCooldownMap(java.util.Map<java.lang.String,Cooldown> cooldownMap)

startCooldownsOnActivation

public boolean startCooldownsOnActivation()

startCooldownsOnActivation

public void startCooldownsOnActivation(boolean startCooldowns)

getConsumeOnActivation

public boolean getConsumeOnActivation()

setConsumeOnActivation

public void setConsumeOnActivation(boolean consumeOnActivation)

setWeaponReq

public void setWeaponReq(java.lang.String weaponType)

getWeaponReq

public java.lang.String getWeaponReq()

getDecrementWeaponUses

public boolean getDecrementWeaponUses()

setDecrementWeaponUses

public void setDecrementWeaponUses(boolean decrement)

addReagent
```
public void addReagent(java.lang.Integer reagent,
                       java.lang.Integer count)
```
Adds a reagent requirement to this ability. Reagents are items that are required to be present in inventory, and are consumed when the ability completes the ACTIVATING phase.

Parameters:

reagent - name of the template the reagent was created from.

count - number of reagents.

getReagentList

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getReagentList()

setReagentList

public void setReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)

addConsumeReagent

public void addConsumeReagent(java.lang.Integer reagent,
                              java.lang.Integer count)

getConsumeReagentList

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getConsumeReagentList()

setConsumeReagentList

public void setConsumeReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)

addPulseReagent
```
public void addPulseReagent(java.lang.Integer reagent,
                            java.lang.Integer count)
```
Adds a reagent requirement to pulse in this ability. Reagents are items that are required to be present in inventory, and are consumed when the ability completes the CHANNELLING phase.

Parameters:

reagent - name of the template the reagent was created from.

count - number of reagents.

getPulseReagentList

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getPulseReagentList()

setPulseReagentList

public void setPulseReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)

addPulseConsumeReagent

public void addPulseConsumeReagent(java.lang.Integer reagent,
                                   java.lang.Integer count)

getPulseConsumeReagentList

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getPulseConsumeReagentList()

setPulseConsumeReagentList

public void setPulseConsumeReagentList(java.util.HashMap<java.lang.Integer,java.lang.Integer> reagentList)

addTool
```
public void addTool(int tool)
```
Adds a tool requirement to this ability. Tools are items that are required to be present in inventory. They are not consumed.

Parameters:

tool - name of the template the tool was created from.

getToolList

public java.util.ArrayList<java.lang.Integer> getToolList()

setToolList

public void setToolList(java.util.ArrayList<java.lang.Integer> toolList)

getAmmoReq
```
public int getAmmoReq()
```

setAmmoReq
```
public void setAmmoReq(int ammoReq)
```

getPulseAmmoReq
```
public int getPulseAmmoReq()
```

setPulseAmmoReq

public void setPulseAmmoReq(int ammoReq)

getVigor
```
public int getVigor()
```
Returns the vigor amount added or required for the ability.

Returns:

vigor amount.

setVigor
```
public void setVigor(int value)
```
Sets the amount of vigor to be added or required to activate the ability

Parameters:

value - the amount of vigor to be added or subtracted

getStance
```
public java.lang.String getStance()
```
Returns the vigor amount added or required for the ability.

Returns:

vigor amount.

setStance
```
public void setStance(java.lang.String stance)
```
Sets the amount of vigor to be added or required to activate the ability

Parameters:

stance - value the amount of vigor to be added or subtracted

getCastingAnim
```
public java.lang.String getCastingAnim()
```
The casting Anim is for abilities that have a cast, it determines which animation should be used.

Returns:

casting anim.

setCastingAnim

public void setCastingAnim(java.lang.String anim)

getCastingAffinity
```
public java.lang.String getCastingAffinity()
```
The casting Affinity

Returns:

casting Affinity.

setCastingAffinity

public void setCastingAffinity(java.lang.String affinity)

getReqTarget
```
public boolean getReqTarget()
```
Returns whether a target is required for this ability to activate

Returns:

target type for this ability.

setReqTarget
```
public void setReqTarget(boolean req)
```
Sets whether a target is required for this ability to activate

Parameters:

req - type target type for this ability.

getTargetType
```
public AgisAbility.TargetType getTargetType()
```
Returns the target type for this ability.

Returns:

target type for this ability.

setTargetType
```
public void setTargetType(AgisAbility.TargetType type)
```
Sets the target type for this ability.

Parameters:

type - target type for this ability.

getSpecificTargets
```
public java.util.LinkedList<java.lang.String> getSpecificTargets()
```
Returns the list of acceptable specific targets for this ability.

Returns:

a list of specific targets for this ability.

setSpecificTargets
```
public void setSpecificTargets(java.util.LinkedList<java.lang.String> targets)
```
Sets the list of acceptable specific targets for this ability.

Parameters:

targets: - a list of acceptable specific targets.

addSpecificTarget

public void addSpecificTarget(java.lang.String name)

getTargetableSpecies
```
public java.util.LinkedList<AgisAbility.TargetSpecies> getTargetableSpecies()
```
Returns the list of acceptable specific targets for this ability.

Returns:

a list of specific targets for this ability.

setTargetableSpecies
```
public void setTargetableSpecies(java.util.LinkedList<AgisAbility.TargetSpecies> targets)
```
Sets the list of acceptable specific targets for this ability.

Parameters:

targets: - a list of acceptable specific targets.

addTargetableSpecies

public void addTargetableSpecies(AgisAbility.TargetSpecies species)

getTargetDeath
```
public int getTargetDeath()
```
Returns the target type for this ability.

Returns:

target type for this ability.

setTargetDeath
```
public void setTargetDeath(int type)
```
Sets the target type for this ability.

Parameters:

type - target type for this ability.

addAttackerEffectReq

public void addAttackerEffectReq(int effectReq)

GetAttackerEffectReqs

public java.util.LinkedList<java.lang.Integer> GetAttackerEffectReqs()

addPulseAttackerEffectReq

public void addPulseAttackerEffectReq(int effectReq)

GetPulseAttackerEffectReqs

public java.util.LinkedList<java.lang.Integer> GetPulseAttackerEffectReqs()

addTargetEffectReq

public void addTargetEffectReq(int effectReq)

GetTargetEffectReqs

public java.util.LinkedList<java.lang.Integer> GetTargetEffectReqs()

addPulseTargetEffectReq

public void addPulseTargetEffectReq(int effectReq)

GetPulseTargetEffectReqs

public java.util.LinkedList<java.lang.Integer> GetPulseTargetEffectReqs()

addAttackerEffectConsumption

public void addAttackerEffectConsumption(int effectReq)

GetAttackerEffectConsumption

public java.util.LinkedList<java.lang.Integer> GetAttackerEffectConsumption()

addPulseAttackerEffectConsumption

public void addPulseAttackerEffectConsumption(int effectReq)

GetPulseAttackerEffectConsumption

public java.util.LinkedList<java.lang.Integer> GetPulseAttackerEffectConsumption()

addTargetEffectConsumption

public void addTargetEffectConsumption(int effectReq)

GetTargetEffectConsumption

public java.util.LinkedList<java.lang.Integer> GetTargetEffectConsumption()

addPulseTargetEffectConsumption

public void addPulseTargetEffectConsumption(int effectReq)

GetPulseTargetEffectConsumption

public java.util.LinkedList<java.lang.Integer> GetPulseTargetEffectConsumption()

getUseGlobalCooldown
```
public boolean getUseGlobalCooldown()
```

setUseGlobalCooldown

public void setUseGlobalCooldown(boolean val)

getStationary
```
public boolean getStationary()
```

setStationary

public void setStationary(boolean val)

getChannelled
```
public boolean getChannelled()
```

setChannelled

public void setChannelled(boolean val)

getChannelledInRun
```
public boolean getChannelledInRun()
```

setChannelledInRun

public void setChannelledInRun(boolean val)

getPersistent
```
public boolean getPersistent()
```

setPersistent

public void setPersistent(boolean val)

addCoordEffect

public boolean addCoordEffect(AgisAbility.ActivationState state,
                              CoordinatedEffect effect)

removeCoordEffect

public boolean removeCoordEffect(AgisAbility.ActivationState state,
                                 CoordinatedEffect effect)

getCoordEffects

public java.util.Collection<CoordinatedEffect> getCoordEffects(AgisAbility.ActivationState state)

changeCoordinatedEffect

protected void changeCoordinatedEffect(java.lang.String result)

getCompleteAnimation

public java.lang.String getCompleteAnimation()

setCompleteAnimation

public void setCompleteAnimation(java.lang.String anim)

getCompleteSound

public java.lang.String getCompleteSound()

setCompleteSound

public void setCompleteSound(java.lang.String sound)

getPotentialTargets
```
public java.util.List<CombatInfo> getPotentialTargets(AgisAbilityState state)
```
This method gets the list of combat info objects we should lock. The determination of this list must not lock any of the objects.

Parameters:

state - of Ability

Returns:

List of CombatInfo

sortByValue

public static java.util.HashMap<OID,java.lang.Float> sortByValue(java.util.HashMap<OID,java.lang.Float> hm)

getAoETargets

public java.util.ArrayList<CombatInfo> getAoETargets(CombatInfo caster,
                                                     CombatInfo targetInfo,
                                                     Point loc,
                                                     float minRange,
                                                     float maxRange,
                                                     AgisAbilityState state)

Should this be merged up into the function above?

Parameters:: caster - combat info of the caster; targetInfo - combat info of the target; loc - point from start serarch targets
Returns:: List Combat Info of the targets

getAoETargets

public java.util.ArrayList<CombatInfo> getAoETargets(CombatInfo caster,
                                                     CombatInfo targetInfo,
                                                     Point loc,
                                                     float minRange,
                                                     float maxRange,
                                                     atavism.agis.core.AgisAbilityPulsState state)

Should this be merged up into the function above?

Parameters:: caster - combat info of the caster; targetInfo - combat info of the target; loc - point from start serarch targets
Returns:: List Combat Info of the targets

beginActivation

public void beginActivation(AgisAbilityState state)

completeActivation

public void completeActivation(AgisAbilityState state)

getTargets

public void getTargets(AgisAbilityState state)

getTargets

public java.util.ArrayList<CombatInfo> getTargets(AgisAbilityState state,
                                                  atavism.agis.core.AgisAbilityPulsState pulsState)

completeActivationTargetConsume

public void completeActivationTargetConsume(AgisAbilityState state)

completeActivationCasterConsume
```
public boolean completeActivationCasterConsume(AgisAbilityState state)
```
Consume reagents, stat on Caster

Parameters:

state - of ability

beginChannelling

public void beginChannelling(AgisAbilityState state)

pulseChannelling

public void pulseChannelling(AgisAbilityState state)

pulseCaster

public void pulseCaster(AgisAbilityState state)

pulseTarget

public void pulseTarget(AgisAbilityState state)

pulseTarget

public void pulseTarget(AgisAbilityState state,
                        java.util.ArrayList<CombatInfo> targets)

pulseConsumeTarget

public void pulseConsumeTarget(AgisAbilityState state)

pulseConsumeTarget

public void pulseConsumeTarget(AgisAbilityState state,
                               java.util.ArrayList<CombatInfo> targets)

pulseChecking

public boolean pulseChecking(AgisAbilityState state)

completeChannelling

public void completeChannelling(AgisAbilityState state)

beginActivated

public void beginActivated(AgisAbilityState state)

pulseActivated

public void pulseActivated(AgisAbilityState state)

endActivated

public void endActivated(AgisAbilityState state)

interrupt

public void interrupt(AgisAbilityState state)

setSlashCommand
```
public void setSlashCommand(java.lang.String slashCommand)
```
exposes a way for the client to execute ability with a slash command

Parameters:

slashCommand - string

getSlashCommand

public java.lang.String getSlashCommand()

setRequiredSkill

public void setRequiredSkill(AgisSkill skill,
                             int level)

getRequiredSkill
```
public AgisSkill getRequiredSkill()
```

getRequiredSkillLevel
```
public int getRequiredSkillLevel()
```

checkTarget
```
protected AgisAbility.AbilityResult checkTarget(CombatInfo caster,
                                                CombatInfo target)
```
Checks if the caster's current target is a valid target for the ability.

Parameters:

caster - CombatInfo of caster

target - CombatInfo of target

Returns:

AbilityResult.SUCCESS if it is a valid target otherwise AbilityResult.INVALID_TARGET

checkTargetSpecies

protected AgisAbility.AbilityResult checkTargetSpecies(CombatInfo caster,
                                                       CombatInfo target)

checkSpecificTarget

protected AgisAbility.AbilityResult checkSpecificTarget(CombatInfo caster,
                                                        CombatInfo target)

checkState

protected AgisAbility.AbilityResult checkState(CombatInfo obj,
                                               CombatInfo target)

checkHasAbility

protected AgisAbility.AbilityResult checkHasAbility(CombatInfo obj,
                                                    CombatInfo target)

checkAbilityType

protected AgisAbility.AbilityResult checkAbilityType(CombatInfo obj,
                                                     CombatInfo target)

checkDeath

protected AgisAbility.AbilityResult checkDeath(CombatInfo obj,
                                               CombatInfo target)

checkDeath

protected AgisAbility.AbilityResult checkDeath(CombatInfo obj,
                                               CombatInfo target,
                                               boolean abilityCheck)

checkRange

protected AgisAbility.AbilityResult checkRange(CombatInfo obj,
                                               CombatInfo target,
                                               BasicWorldNode casterWNode,
                                               float rangeTolerance)

checkRange

protected AgisAbility.AbilityResult checkRange(CombatInfo obj,
                                               CombatInfo target,
                                               BasicWorldNode casterWNode,
                                               float rangeTolerance,
                                               boolean abilityCheck)

checkRange

protected AgisAbility.AbilityResult checkRange(CombatInfo obj,
                                               CombatInfo target,
                                               BasicWorldNode casterWNode,
                                               float rangeTolerance,
                                               boolean abilityCheck,
                                               AgisAbilityState abilityState)

checkReady

protected AgisAbility.AbilityResult checkReady(CombatInfo obj,
                                               CombatInfo target,
                                               BasicWorldNode casterWNode)

checkCost

protected AgisAbility.AbilityResult checkCost(CombatInfo obj,
                                              CombatInfo target,
                                              AgisAbility.ActivationState state)

checkVigor

protected AgisAbility.AbilityResult checkVigor(CombatInfo obj,
                                               CombatInfo target,
                                               AgisAbility.ActivationState state)

checkEffects

protected AgisAbility.AbilityResult checkEffects(CombatInfo obj,
                                                 CombatInfo target,
                                                 AgisAbility.ActivationState state)

checkEffects

protected AgisAbility.AbilityResult checkEffects(CombatInfo obj,
                                                 CombatInfo target,
                                                 AgisAbility.ActivationState state,
                                                 boolean abilityCheck)

checkPulseEffects

protected AgisAbility.AbilityResult checkPulseEffects(CombatInfo obj,
                                                      CombatInfo target,
                                                      AgisAbility.ActivationState state)

checkPulseEffects

protected AgisAbility.AbilityResult checkPulseEffects(CombatInfo obj,
                                                      CombatInfo target,
                                                      AgisAbility.ActivationState state,
                                                      boolean abilityCheck)

checkStance

protected AgisAbility.AbilityResult checkStance(CombatInfo obj,
                                                CombatInfo target,
                                                AgisAbility.ActivationState state)

checkPosition

protected AgisAbility.AbilityResult checkPosition(CombatInfo obj,
                                                  CombatInfo target,
                                                  AgisAbility.ActivationState state,
                                                  BasicWorldNode attackerNode)

checkEquip

public AgisAbility.AbilityResult checkEquip(CombatInfo obj,
                                            CombatInfo target,
                                            AgisAbility.ActivationState state)

checkReagent

protected AgisAbility.AbilityResult checkReagent(CombatInfo obj,
                                                 CombatInfo target,
                                                 AgisAbility.ActivationState state)

checkPulseReagent

protected AgisAbility.AbilityResult checkPulseReagent(CombatInfo obj,
                                                      CombatInfo target,
                                                      AgisAbility.ActivationState state)

checkTool

protected AgisAbility.AbilityResult checkTool(CombatInfo obj,
                                              CombatInfo target,
                                              AgisAbility.ActivationState state)

checkAmmo

protected AgisAbility.AbilityResult checkAmmo(CombatInfo obj,
                                              CombatInfo target,
                                              AgisAbility.ActivationState state)

checkAbility

public AgisAbility.AbilityResult checkAbility(CombatInfo obj,
                                              CombatInfo target)

checkAbility

protected AgisAbility.AbilityResult checkAbility(CombatInfo obj,
                                                 CombatInfo target,
                                                 AgisAbility.ActivationState state,
                                                 AgisAbilityState abilityState)

generateState

protected AgisAbilityState generateState(CombatInfo source,
                                         CombatInfo target,
                                         AgisItem item,
                                         Point loc)

startAbility

public static void startAbility(AgisAbility ability,
                                CombatInfo source,
                                CombatInfo target,
                                AgisItem item)

startAbility

public static void startAbility(AgisAbility ability,
                                CombatInfo source,
                                CombatInfo target,
                                AgisItem item,
                                Point loc)

abortAbility

public static void abortAbility(AgisAbilityState state)

deactivateAbility

public static void deactivateAbility(AgisAbilityState state)

sendToggleInfo

public static void sendToggleInfo(AgisAbilityState state)

interruptAbility

public static void interruptAbility(AgisAbilityState state,
                                    AgisAbility.AbilityResult reason)

getResultVal

public AgisEffect getResultVal(java.lang.String result,
                               boolean caster)

setAoeTargetsCount
```
public void setAoeTargetsCount(int value)
```
Set the maximum number of targets on which the effects will be applied

Parameters:

value -

getAoeTargtetsCount
```
public int getAoeTargtetsCount()
```
Get the maximum number of targets on which the effects will be applied

Parameters:

value -

setAoeTargetsCountType
```
public void setAoeTargetsCountType(int value)
```
Set the type of searche

Parameters:

value -

getAoeTargtetsCountType
```
public int getAoeTargtetsCountType()
```

setPredictionMode

public void setPredictionMode(int val)

getSkipChecks
```
public boolean getSkipChecks()
```

setSkipChecks

public void setSkipChecks(boolean value)

getStealthReduce
```
public boolean getStealthReduce()
```

setStealthReduce

public void setStealthReduce(boolean value)

getExperiencePerUse
```
public int getExperiencePerUse()
```
-Experience system component - Not currently used Returns the amount of experience should be gained by successful use of this ability.

setExperiencePerUse
```
public void setExperiencePerUse(int xp)
```
-Experience system component - Not currently used Sets the amount of experience should be gained by successful use of this ability.

setLevelingMap

public void setLevelingMap(LevelingMap lm)

getLevelingMap
```
public LevelingMap getLevelingMap()
```

getBaseExpThreshold
```
public int getBaseExpThreshold()
```
-Experience system component - Not currently used Returns the default max experience that will be needed before the ability gains a level.

setBaseExpThreshold
```
public void setBaseExpThreshold(int max)
```
-Experience system component - Not currently used Sets the default max experience that will be needed before the ability gains a level.

getMaxRank
```
public int getMaxRank()
```
-Experience system component - Not currently used Returns the max rank that an ability may achieve.

setMaxRank
```
public void setMaxRank(int rank)
```
-Experience system component - Not currently used Sets the max rank that an ability may achieve.

isInterruptible
```
public boolean isInterruptible()
```
the function returns whether the ability is interruptible

Returns:

setInterruptible
```
public void setInterruptible(boolean val)
```
function to set ability is interruptible

Parameters:

val -

getInterruptChance
```
public float getInterruptChance()
```
the function returns interruption chance

Returns:

setInterruptChance
```
public void setInterruptChance(float val)
```
function to set ability interruption chance

Parameters:

val -

Class AgisAbility

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

skillType

activationDelay

activationTime

activationCost

activationCostPercentage

costProp

channelPulseTime

channelPulses

pulseCost

pulseCostProp

pulseCostPercentage

activePulseTime

activePulseCost

icon

displayName

tooltip

interceptType

toggle

tag_to_disable

tag_to_disable_count

tags

minRange

maxRange

speed

chunk_length

castingInRun

areaOfEffectAngle

areaOfEffectRadius

aoeType

reqFacingTarget

autoRotateToTarget

skillExp

position

cooldownMap

startCooldownsOnActivation

consumeOnActivation

weaponReq

decrementWeaponUses

reagentList

consumeReagentList

pulseReagentList

pulseConsumeReagentList

toolList

ammoReq

pulseAmmoReq

vigor

stanceReq

castingAnim

castingAffinity

reqTarget

targetType

specificTargets

targetableSpecies

targetDeath

attackerEffectReqs

pulseAttackerEffectReqs

targetEffectReqs

pulseTargetEffectReqs

attackerEffectConsumption

pulseAttackerEffectConsumption

targetEffectConsumption

pulseTargetEffectConsumption

useGlobalCooldown

stationary

channelled

channelled_in_run

persistent

coordEffectMap

completeAnimation

completeSound

sendSkillUpChance

aoe_targets_count