GenAbility

java.lang.Object
- com.planet_ink.coffee_mud.Abilities.StdAbility
- - com.planet_ink.coffee_mud.Abilities.GenAbility

All Implemented Interfaces:

Ability, CMObject, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class GenAbility
extends StdAbility
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected Ability`	`hereEffect`
`protected boolean`	`oneTimeChecked`
`protected java.util.List<Ability>`	`postEffects`
`protected Ability`	`quietEffect`
`protected long`	`timeToNextCast`

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability
ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DESCS_, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_TECH, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CACHEINDEX_CLASSLESS, CACHEINDEX_EXPERTISE, CACHEINDEX_LASTTIME, CACHEINDEX_NORMAL, CACHEINDEX_TOTAL, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, COST_ALL, COST_NORMAL, COST_PCT, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_BUILDINGSKILL, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_COSMOLOGY, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_EDUCATIONLORE, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EPICUREAN, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_ROPEUSE, DOMAIN_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_TRAVEL, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WATERCONTROL, DOMAIN_WATERLORE, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_ADJUSTER, FLAG_AGGROFYING, FLAG_AIRBASED, FLAG_BINDING, FLAG_CASTER, FLAG_CHAOS, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ELECTRICBASED, FLAG_ENABLER, FLAG_FEARING, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_LAW, FLAG_MINDALTERING, FLAG_MODERATE, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NODISENCHANT, FLAG_NONENCHANTMENT, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_STEALING, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, POWER_COST_THRESHOLD, POWER_LEVEL_THRESHOLD, POWER_OVERRIDE_THRESHOLD, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, TICKS_ALMOST_FOREVER, TICKS_FOREVER, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_COUNT, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT, USAGEINDEX_TIMELSW, USAGEINDEX_TOTAL

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
idConverter

Fields inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility
affected, amDestroyed, canBeUninvoked, empty, invoker, isAnAutoEffect, lastCastHelp, miscText, proficiency, savable, tickDown, unInvoked

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors
Constructor Description

GenAbility()

Constructors
Constructor	Description
`GenAbility()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`abstractQuality()`	Returns a constant value notifying the system of the general quality of the skill, whether it is malicious, beneficial, indifferent, or qualifiably beneficial (ok), as well as whether it is intended to target the invoker (self) or others.
`void`	`affectCharState(MOB affectedMob, CharState affectableMaxState)`	This method is called by the recoverCharState() method on other MOB objects.
`void`	`affectCharStats(MOB affectedMob, CharStats affectableStats)`	This method is called by the recoverCharStats() method on other MOB objects.
`void`	`affectPhyStats(Physical affectedEnv, PhyStats affectableStats)`	This method is called by the recoverPhyStats() method on other Environmental objects.
`boolean`	`autoInvocation(MOB mob, boolean force)`	An autoinvocating ability is an ability which affects the mob just by having learned the ability.
`protected int`	`canAffectCode()`	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
`protected int`	`canTargetCode()`	Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
`int`	`classificationCode()`	Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
`protected void`	`cloneFix(Ability E)`
`java.lang.String`	`description()`	The basic description of this object, as shown when the item is directly LOOKed at.
`java.lang.String`	`displayText()`	Gets the raw string used to show what this object looks like in the room.
`void`	`executeMsg(Environmental myHost, CMMsg msg)`	The general message event handler for the object.
`long`	`flags()`	Returns a bitmap giving some specific information about the scope and purpose of the skill.
`protected int`	`getCodeNum(java.lang.String code)`
`protected java.util.List<Ability>`	`getEffectsDiff(Physical mob, java.util.Set<Ability> oldEffects)`
`protected java.util.Set<Ability>`	`getEffectsList(Physical mob)`
`Ability`	`getHereAffect()`
`Ability`	`getQuietAffect()`
`int`	`getSaveStatIndex()`	Returns the index into the stat codes array where extra savable fields begins.
`ScriptingEngine`	`getScripter()`
`java.lang.String`	`getStat(java.lang.String code)`	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
`java.lang.String[]`	`getStatCodes()`	Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
`protected int`	`getTicksBetweenCasts()`
`protected long`	`getTimeOfNextCast()`
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`boolean`	`invoke(MOB mob, java.util.List<java.lang.String> commands, Physical givenTarget, boolean auto, int asLevel)`	This method is called when a player or the system invokes this skill, casts this spell, etc.
`boolean`	`isAutoInvoked()`	An autoinvocating ability is an ability which affects the mob just by having learned the ability.
`protected boolean`	`isChannelingSkill()`
`boolean`	`isGeneric()`	Whether the fields of this item are set in code, or set by builders.
`int`	`maxRange()`	the modified maximum range of this object, if applicable.
`int`	`minRange()`	the modified minimum range of this object, if applicable.
`java.lang.String`	`name()`	The nice displayable name of this instance of this object
`java.lang.String`	`Name()`	The raw unmodified name of this object as stored in the database.
`CMObject`	`newInstance()`	Returns a new instance of this class.
`boolean`	`okMessage(Environmental myHost, CMMsg msg)`	The general message event previewer for the object.
`protected int`	`overrideMana()`	amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT
`boolean`	`preInvoke(MOB mob, java.util.List<java.lang.String> commands, Physical givenTarget, boolean auto, int asLevel, int secondsElapsed, double actionsRemaining)`	This method is only called when the mob invoking this skill does not have enough actions to complete it immediately.
`protected void`	`prepHereAffect(MOB mob, Physical target, int asLevel)`
`boolean`	`sameAs(Environmental E)`	Whether this object instance is functionally identical to the object passed in.
`void`	`setStat(java.lang.String code, java.lang.String val)`	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
`protected void`	`setTimeOfNextCast(long absoluteTime)`
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`java.lang.String[]`	`triggerStrings()`	A set of the command strings the user types to access this command when it is listed as a skill ability.
`void`	`unInvoke()`	If this skill is uninvokable, this method will uninvoke it, remove it as an effect on the target, and shut it down.
`int`	`usageType()`	Returns a bitmap made up of constants defined by Ability.USAGE_*.

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

Methods inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility
abilityCode, accountForYourself, addedTickTime, adjustBeneficialTickdownTime, adjustedLevel, adjustedMaxInvokerRange, adjustMaliciousTickdownTime, affecting, amDestroyed, aPossibleAbuserOfCasterLevel, appropriateToMyFactions, beneficialAffect, beneficialSoundFizzle, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingQuality, castingTime, checkComponents, checkedCastingCost, checkTargetRange, combatCastingTime, commonTell, commonTelL, commonTelL, compareTo, copyOf, destroy, disregardsArmorCheck, enchantQuality, evalTargetItem, expertise, expirationDate, externalFiles, failureTell, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getRawTrainingCost, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTargetItemFavorMOB, getTargetItemFavorMOB, getTargetItemFavorMOB, getTickDownRemaining, getTickStatus, getTrainingCost, getVisibleRoomTarget, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, ignoreCompounding, image, iniPracticesToPractice, initializeClass, invoke, invoker, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, mayBeEnchanted, minCastWaitTime, miscTextFormat, modifyCastCode, possibleContainer, practice, practicesToPractice, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, saveCombatState, setAbilityCode, setAffectedOne, setDescription, setDisplayText, setExpirationDate, setImage, setInvoker, setMiscText, setName, setProficiency, setSavable, setTickDown, setTickDownRemaining, setTimeOfNextCast, somaticCastCode, somaticCastMask, spreadImmunity, startTickDown, teach, testUsageCost, text, unlearn, usageCost, verbalCastCode, verbalCastMask, verbalSpeakCode

- Field Detail
  - timeToNextCast
```
protected long timeToNextCast
```
  - oneTimeChecked
```
protected boolean oneTimeChecked
```
  - postEffects
```
protected java.util.List<Ability> postEffects
```
  - quietEffect
```
protected Ability quietEffect
```
  - hereEffect
```
protected Ability hereEffect
```
- Constructor Detail
  - GenAbility
```
public GenAbility()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Overrides:
    
    ID in class StdAbility
    
    Returns:
    
    the name of this class
  - getQuietAffect
```
public Ability getQuietAffect()
```
  - getHereAffect
```
public Ability getHereAffect()
```
  - getScripter
```
public ScriptingEngine getScripter()
```
  - Name
```
public java.lang.String Name()
```
    Description copied from interface: Environmental
    
    The raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.
    
    Specified by:
    
    Name in interface Environmental
    
    Overrides:
    
    Name in class StdAbility
    
    Returns:
    
    the raw base name of this object on the map.
    
    See Also:
    
    Tickable.name()
  - name
```
public java.lang.String name()
```
    Description copied from interface: Tickable
    
    The nice displayable name of this instance of this object
    
    Specified by:
    
    name in interface CMObject
    
    Specified by:
    
    name in interface Tickable
    
    Overrides:
    
    name in class StdAbility
    
    Returns:
    
    the displayable name of this object instance
    
    See Also:
    
    Environmental.Name()
  - description
```
public java.lang.String description()
```
    Description copied from interface: Environmental
    
    The basic description of this object, as shown when the item is directly LOOKed at.
    
    Specified by:
    
    description in interface Environmental
    
    Overrides:
    
    description in class StdAbility
    
    Returns:
    
    the basic detail description of this object
  - displayText
```
public java.lang.String displayText()
```
    Description copied from interface: Environmental
    
    Gets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.
    
    Specified by:
    
    displayText in interface Environmental
    
    Overrides:
    
    displayText in class StdAbility
    
    Returns:
    
    the string describing how this object looks in the room
  - triggerStrings
```
public java.lang.String[] triggerStrings()
```
    Description copied from interface: Ability
    
    A set of the command strings the user types to access this command when it is listed as a skill ability.
    
    Specified by:
    
    triggerStrings in interface Ability
    
    Overrides:
    
    triggerStrings in class StdAbility
    
    Returns:
    
    an array of command invoking string words
    
    See Also:
    
    Ability.putInCommandlist()
  - maxRange
```
public int maxRange()
```
    Description copied from interface: Environmental
    
    the modified maximum range of this object, if applicable. Can refer to the size of a room, the range of a weapon, or the calculated range of a mob in combat.
    
    Specified by:
    
    maxRange in interface Environmental
    
    Overrides:
    
    maxRange in class StdAbility
    
    Returns:
    
    the maximum range
  - minRange
```
public int minRange()
```
    Description copied from interface: Environmental
    
    the modified minimum range of this object, if applicable. Can refer to the size of a room, the range of a weapon, or the calculated range of a mob in combat. Usually 0.
    
    Specified by:
    
    minRange in interface Environmental
    
    Overrides:
    
    minRange in class StdAbility
    
    Returns:
    
    the minimum range
  - isAutoInvoked
```
public boolean isAutoInvoked()
```
    Description copied from interface: Ability
    
    An autoinvocating ability is an ability which affects the mob just by having learned the ability. Dodge is an example of this. This method returns whether this skill is classified as one of those kinds of abilities.
    
    Specified by:
    
    isAutoInvoked in interface Ability
    
    Overrides:
    
    isAutoInvoked in class StdAbility
    
    Returns:
    
    whether this is an autoinvoking skill
  - flags
```
public long flags()
```
    Description copied from interface: Ability
    
    Returns a bitmap giving some specific information about the scope and purpose of the skill. The bitmap is composed of FLAG_* constants from the Ability interface.
    
    Specified by:
    
    flags in interface Ability
    
    Overrides:
    
    flags in class StdAbility
    
    Returns:
    
    FLAG_* constant based bitmap
    
    See Also:
    
    Ability
  - usageType
```
public int usageType()
```
    Description copied from interface: Ability
    
    Returns a bitmap made up of constants defined by Ability.USAGE_*. It lets the system know which of the values in the usageCost(MOB,boolean) method are relevant. It determines whether this skill requires mana, movement, hit points, or some combination of the three.
    
    Specified by:
    
    usageType in interface Ability
    
    Overrides:
    
    usageType in class StdAbility
    
    Returns:
    
    a bitmap defined by Ability.USAGE_*
    
    See Also:
    
    Ability
  - overrideMana
```
protected int overrideMana()
```
    Description copied from class: StdAbility
    
    amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT
    
    Overrides:
    
    overrideMana in class StdAbility
    
    Returns:
    
    amount of mana/move used by this ability, overriding ini file
  - classificationCode
```
public int classificationCode()
```
    Description copied from interface: Ability
    
    Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain. It is made up of the ACODE_* constants the Ability interface, and optionally the DOMAIN_* constants also defined in this interface.
    
    Specified by:
    
    classificationCode in interface Ability
    
    Overrides:
    
    classificationCode in class StdAbility
    
    Returns:
    
    ACODE_* constant classification
    
    See Also:
    
    Ability
  - canAffectCode
```
protected int canAffectCode()
```
    Description copied from class: StdAbility
    
    Designates whether, when used as a property/effect, what sort of objects this ability can affect. Uses the Ability.CAN_* constants.
    
    Overrides:
    
    canAffectCode in class StdAbility
    
    Returns:
    
    a mask showing the type of objects this ability can affect
    
    See Also:
    
    Ability
  - canTargetCode
```
protected int canTargetCode()
```
    Description copied from class: StdAbility
    
    Designates whether, when invoked as a skill, what sort of objects this ability can effectively target. Uses the Ability.CAN_* constants.
    
    Overrides:
    
    canTargetCode in class StdAbility
    
    Returns:
    
    a mask showing the type of objects this ability can target
    
    See Also:
    
    Ability
  - abstractQuality
```
public int abstractQuality()
```
    Description copied from interface: Ability
    
    Returns a constant value notifying the system of the general quality of the skill, whether it is malicious, beneficial, indifferent, or qualifiably beneficial (ok), as well as whether it is intended to target the invoker (self) or others. These constants are defined in the Ability interface and called QUALITY_*
    
    Specified by:
    
    abstractQuality in interface Ability
    
    Overrides:
    
    abstractQuality in class StdAbility
    
    Returns:
    
    Ability.QUALITY_* constant classification
    
    See Also:
    
    Ability
  - getTicksBetweenCasts
```
protected int getTicksBetweenCasts()
```
    Overrides:
    
    getTicksBetweenCasts in class StdAbility
  - getTimeOfNextCast
```
protected long getTimeOfNextCast()
```
    Overrides:
    
    getTimeOfNextCast in class StdAbility
  - setTimeOfNextCast
```
protected void setTimeOfNextCast(long absoluteTime)
```
    Overrides:
    
    setTimeOfNextCast in class StdAbility
  - isChannelingSkill
```
protected boolean isChannelingSkill()
```
  - newInstance
```
public CMObject newInstance()
```
    Description copied from interface: CMObject
    
    Returns a new instance of this class.
    
    Specified by:
    
    newInstance in interface CMObject
    
    Overrides:
    
    newInstance in class StdAbility
    
    Returns:
    
    a new instance of this class
  - cloneFix
```
protected void cloneFix(Ability E)
```
    Overrides:
    
    cloneFix in class StdAbility
  - isGeneric
```
public boolean isGeneric()
```
    Description copied from interface: Environmental
    
    Whether the fields of this item are set in code, or set by builders. Generic means that they are set by builders, in which case XML is returned by the text() method containing all of the values for all the fields.
    
    Specified by:
    
    isGeneric in interface Environmental
    
    Overrides:
    
    isGeneric in class StdAbility
    
    Returns:
    
    whether this item is modifiable by builders
    
    See Also:
    
    Environmental.text()
  - getEffectsList
```
protected java.util.Set<Ability> getEffectsList(Physical mob)
```
  - getEffectsDiff
```
protected java.util.List<Ability> getEffectsDiff(Physical mob,
                                                 java.util.Set<Ability> oldEffects)
```
  - prepHereAffect
```
protected void prepHereAffect(MOB mob,
                              Physical target,
                              int asLevel)
```
  - invoke
```
public boolean invoke(MOB mob,
                      java.util.List<java.lang.String> commands,
                      Physical givenTarget,
                      boolean auto,
                      int asLevel)
```
    Description copied from interface: Ability
    
    This method is called when a player or the system invokes this skill, casts this spell, etc. Calls the more complete invoke method without an empty command strings vector unless target is non-null, in which case the vector will contain the name of the target.
    
    Specified by:
    
    invoke in interface Ability
    
    Overrides:
    
    invoke in class StdAbility
    
    Parameters:
    
    mob - the player or mob invoking the skill
    
    commands - the parameters entered for the skill (minus trigger word)
    
    givenTarget - null, unless being auto-invoked. Represents an override target.
    
    auto - false if player enters command, true if system invokes the command
    
    asLevel - -1, unless being auto-invoked, when it is the level to invoke it at.
    
    Returns:
    
    whether the skill successfully invoked.
  - preInvoke
```
public boolean preInvoke(MOB mob,
                         java.util.List<java.lang.String> commands,
                         Physical givenTarget,
                         boolean auto,
                         int asLevel,
                         int secondsElapsed,
                         double actionsRemaining)
```
    Description copied from interface: Ability
    
    This method is only called when the mob invoking this skill does not have enough actions to complete it immediately. The method is called when the command is entered, and every second afterwards until the invoker has enough actions to complete it. At completion time, invoke is called.
    
    Specified by:
    
    preInvoke in interface Ability
    
    Overrides:
    
    preInvoke in class StdAbility
    
    Parameters:
    
    mob - the player or mob invoking the skill
    
    commands - the parameters entered for the skill (minus trigger word)
    
    givenTarget - null, unless being auto-invoked. Represents an override target.
    
    auto - false if player enters command, true if system invokes the command
    
    asLevel - -1, unless being auto-invoked, when it is the level to invoke it at.
    
    secondsElapsed - 0 at first, and increments every second
    
    actionsRemaining - number of free actions the player is defficient.
    
    Returns:
    
    whether the skill should be allowed to invoke. false cancels altogether.
    
    See Also:
    
    Ability.invoke(MOB, List, Physical, boolean, int)
  - executeMsg
```
public void executeMsg(Environmental myHost,
                       CMMsg msg)
```
    Description copied from interface: MsgListener
    
    The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.
    
    Specified by:
    
    executeMsg in interface MsgListener
    
    Overrides:
    
    executeMsg in class StdAbility
    
    Parameters:
    
    myHost - either the initiator of the event, or the host of this object
    
    msg - the CMMsg that needs to be executed
    
    See Also:
    
    CMMsg
  - affectPhyStats
```
public void affectPhyStats(Physical affectedEnv,
                           PhyStats affectableStats)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverPhyStats() method on other Environmental objects. It is used to transform the Environmental basePhyStats() object into a finished phyStats() object, both of which are objects implementing the PhyStats interface. See those methods for more information.
    
    Specified by:
    
    affectPhyStats in interface StatsAffecting
    
    Overrides:
    
    affectPhyStats in class StdAbility
    
    Parameters:
    
    affectedEnv - the host of the PhyStats object being affected
    
    affectableStats - the particular PhyStats object being affected
    
    See Also:
    
    PhyStats, Environmental, Affectable.basePhyStats(), Affectable.phyStats(), Affectable.recoverPhyStats()
  - affectCharStats
```
public void affectCharStats(MOB affectedMob,
                            CharStats affectableStats)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverCharStats() method on other MOB objects. It is used to transform the MOB baseCharStats() object into a finished charStats() object, both of which are objects implementing the CharStats interface. See those methods for more information.
    
    Specified by:
    
    affectCharStats in interface StatsAffecting
    
    Overrides:
    
    affectCharStats in class StdAbility
    
    Parameters:
    
    affectedMob - the host of the CharStats object being affected
    
    affectableStats - the particular CharStats object being affected
    
    See Also:
    
    CharStats, MOB, MOB.baseCharStats(), MOB.charStats(), MOB.recoverCharStats()
  - affectCharState
```
public void affectCharState(MOB affectedMob,
                            CharState affectableMaxState)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverCharState() method on other MOB objects. It is used to transform the MOB baseCharState() object into a finished charState() object, both of which are objects implementing the CharState interface. See those methods for more information.
    
    Specified by:
    
    affectCharState in interface StatsAffecting
    
    Overrides:
    
    affectCharState in class StdAbility
    
    Parameters:
    
    affectedMob - the host of the CharState object being affected
    
    affectableMaxState - the particular CharState object being affected
    
    See Also:
    
    CharState, MOB, MOB.baseState(), MOB.curState(), MOB.recoverMaxState()
  - okMessage
```
public boolean okMessage(Environmental myHost,
                         CMMsg msg)
```
    Description copied from interface: MsgListener
    
    The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.
    
    Specified by:
    
    okMessage in interface MsgListener
    
    Overrides:
    
    okMessage in class StdAbility
    
    Parameters:
    
    myHost - either the initiator of the event, or the host of this object
    
    msg - the CMMsg that wants to be executed
    
    Returns:
    
    whether this message is allowed to execute
    
    See Also:
    
    CMMsg, CMMsg.source()
  - unInvoke
```
public void unInvoke()
```
    Description copied from interface: Ability
    
    If this skill is uninvokable, this method will uninvoke it, remove it as an effect on the target, and shut it down.
    
    Specified by:
    
    unInvoke in interface Ability
    
    Overrides:
    
    unInvoke in class StdAbility
    
    See Also:
    
    Ability.canBeUninvoked()
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class StdAbility
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - autoInvocation
```
public boolean autoInvocation(MOB mob,
                              boolean force)
```
    Description copied from interface: Ability
    
    An autoinvocating ability is an ability which affects the mob just by having learned the ability. Dodge is an example of this. This method is called to initiate this, and is called whenever a mob gains this skill as a new Ability. This method will add the ability to the mob as an effect.
    
    Specified by:
    
    autoInvocation in interface Ability
    
    Overrides:
    
    autoInvocation in class StdAbility
    
    Parameters:
    
    mob - the player or npc mob who has this ability
    
    force - if the skill has default-off settings, this overrides to ON
    
    Returns:
    
    whether the ability autoinvoked correctly
    
    See Also:
    
    Ability.isAutoInvoked(), Ability.isNowAnAutoEffect()
  - getSaveStatIndex
```
public int getSaveStatIndex()
```
    Description copied from interface: Modifiable
    
    Returns the index into the stat codes array where extra savable fields begins. This number is always the same as getStatCodes().length unless there are extra fields which need to be saved in xml for generic objects. This method is used by editors for post-build user-defined fields.
    
    Specified by:
    
    getSaveStatIndex in interface Modifiable
    
    Overrides:
    
    getSaveStatIndex in class StdAbility
    
    Returns:
    
    the index into getStatCodes()
    
    See Also:
    
    Modifiable.getStatCodes(), Modifiable.getStat(String), Modifiable.setStat(String, String)
  - getStatCodes
```
public java.lang.String[] getStatCodes()
```
    Description copied from interface: Modifiable
    
    Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
    
    Specified by:
    
    getStatCodes in interface Modifiable
    
    Overrides:
    
    getStatCodes in class StdAbility
    
    Returns:
    
    list of the fields which may be set.
    
    See Also:
    
    Modifiable.getStat(String), Modifiable.setStat(String, String)
  - getCodeNum
```
protected int getCodeNum(java.lang.String code)
```
    Overrides:
    
    getCodeNum in class StdAbility
  - getStat
```
public java.lang.String getStat(java.lang.String code)
```
    Description copied from interface: Modifiable
    
    An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.
    
    Specified by:
    
    getStat in interface Modifiable
    
    Overrides:
    
    getStat in class StdAbility
    
    Parameters:
    
    code - the name of the field to read.
    
    Returns:
    
    the value of the field read
    
    See Also:
    
    Modifiable.getStatCodes()
  - setStat
```
public void setStat(java.lang.String code,
                    java.lang.String val)
```
    Description copied from interface: Modifiable
    
    An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.
    
    Specified by:
    
    setStat in interface Modifiable
    
    Overrides:
    
    setStat in class StdAbility
    
    Parameters:
    
    code - the name of the field to set
    
    val - the value to set the field to
    
    See Also:
    
    Modifiable.getStatCodes()
  - sameAs
```
public boolean sameAs(Environmental E)
```
    Description copied from interface: Environmental
    
    Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.
    
    Specified by:
    
    sameAs in interface Environmental
    
    Overrides:
    
    sameAs in class StdAbility
    
    Parameters:
    
    E - the object to compare this one to
    
    Returns:
    
    whether this object is the same as the one passed in
    
    See Also:
    
    Modifiable.getStatCodes(), Modifiable.getStat(String)

Class GenAbility

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Fields inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility

Field Detail

timeToNextCast

oneTimeChecked

postEffects

quietEffect

hereEffect

Constructor Detail

GenAbility

Method Detail

ID

getQuietAffect

getHereAffect

getScripter

Name

name

description

displayText

triggerStrings

maxRange

minRange

isAutoInvoked

flags

usageType

overrideMana

classificationCode

canAffectCode

canTargetCode

abstractQuality

getTicksBetweenCasts

getTimeOfNextCast

setTimeOfNextCast

isChannelingSkill

newInstance

cloneFix

isGeneric

getEffectsList

getEffectsDiff

prepHereAffect

invoke

preInvoke

executeMsg

affectPhyStats

affectCharStats

affectCharState

okMessage

unInvoke

tick

autoInvocation

getSaveStatIndex

getStatCodes

getCodeNum

getStat

setStat

sameAs