Package com.planet_ink.coffee_mud.Abilities.Spells

Class Spell

java.lang.Object

com.planet_ink.coffee_mud.Abilities.StdAbility

com.planet_ink.coffee_mud.Abilities.Spells.Spell

All Implemented Interfaces:

Ability, CMObject, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

Spell_AchillesArmor, Spell_AcidArrow, Spell_AcidFog, Spell_AcidSpray, Spell_AddLimb, Spell_Advancement, Spell_Alarm, Spell_AlternateReality, Spell_AlterSubstance, Spell_AnalyzeDweomer, Spell_Anchor, Spell_AnimateItem, Spell_AnimateWeapon, Spell_AntiPlantShell, Spell_ArcaneMark, Spell_ArcanePossession, Spell_ArmsLength, Spell_AstralStep, Spell_Augury, Spell_Awe, Spell_AweOther, Spell_BaseClanEq, Spell_BigMouth, Spell_Blademouth, Spell_Blindness, Spell_Blink, Spell_Blur, Spell_Boomerang, Spell_Brainwash, Spell_Breadcrumbs, Spell_BurningHands, Spell_CauseStink, Spell_ChainLightening, Spell_ChangeSex, Spell_ChanneledMissiles, Spell_ChantShield, Spell_Charm, Spell_CharmWard, Spell_Choke, Spell_Claireaudience, Spell_Clairevoyance, Spell_ClanDonate, Spell_ClanExperience, Spell_ClanHome, Spell_ClanWard, Spell_ClarifyScroll, Spell_Clog, Spell_Clone, Spell_Cloudkill, Spell_Cogniportive, Spell_ColorSpray, Spell_CombatPrecognition, Spell_Command, Spell_ComprehendLangs, Spell_Confusion, Spell_ConjureAmmunition, Spell_ConjureNexus, Spell_ContinualLight, Spell_Counterspell, Spell_Darkness, Spell_DarknessGlobe, Spell_DarkSensitivity, Spell_Daydream, Spell_DeadenSmell, Spell_Deafness, Spell_DeathWarning, Spell_Deflection, Spell_Delay, Spell_Delirium, Spell_Delude, Spell_DemonGate, Spell_DestroyObject, Spell_DetectAmbush, Spell_DetectBombs, Spell_DetectGold, Spell_DetectHidden, Spell_DetectInvisible, Spell_DetectMagic, Spell_DetectMetal, Spell_DetectPoison, Spell_DetectScrying, Spell_DetectSentience, Spell_DetectTraps, Spell_DetectUndead, Spell_DetectWater, Spell_DetectWeaknesses, Spell_DetonateBombs, Spell_Disenchant, Spell_DisenchantWand, Spell_DisguiseSelf, Spell_DisguiseUndead, Spell_Disintegrate, Spell_Dismissal, Spell_DispelDivination, Spell_DispelMagic, Spell_DistantVision, Spell_DivineBeauty, Spell_DiviningEye, Spell_Dragonfire, Spell_Dream, Spell_Duplicate, Spell_Earthquake, Spell_ElementalStorm, Spell_EnchantArmor, Spell_EnchantArrows, Spell_EnchantWand, Spell_EnchantWeapon, Spell_EndlessRoad, Spell_Enlarge, Spell_Enlightenment, Spell_Ensnare, Spell_Enthrall, Spell_Erase, Spell_Exhaustion, Spell_Fabricate, Spell_FaerieFire, Spell_FaerieFog, Spell_FakeArmor, Spell_FakeFood, Spell_FakeSpring, Spell_FakeWeapon, Spell_Farsight, Spell_Fatigue, Spell_Fear, Spell_FeatherFall, Spell_Feeblemind, Spell_FeelTheVoid, Spell_FeignDeath, Spell_FeignInvisibility, Spell_FindDirections, Spell_FindFamiliar, Spell_Fireball, Spell_Flagportation, Spell_Flameshield, Spell_FlamingArrows, Spell_FlamingEnsnarement, Spell_FlamingSword, Spell_FleshStone, Spell_FloatingDisc, Spell_Fly, Spell_FoolsGold, Spell_ForcefulHand, Spell_Forget, Spell_ForkedLightning, Spell_Frailty, Spell_FreeMovement, Spell_Frenzy, Spell_Friends, Spell_Frost, Spell_FutureDeath, Spell_Gate, Spell_Geas, Spell_GhostSound, Spell_GiantStrength, Spell_GraceOfTheCat, Spell_GravitySlam, Spell_Grease, Spell_GreaterClaireaudience, Spell_GreaterClairevoyance, Spell_GreaterEnchantArmor, Spell_GreaterEnchantWeapon, Spell_GreaterInvisibility, Spell_GreaterLevitate, Spell_GreaterMend, Spell_GreaterScry, Spell_GroupStatus, Spell_Grow, Spell_GustOfWind, Spell_Harden, Spell_HardenBullets, Spell_Haste, Spell_HearThoughts, Spell_HeatMetal, Spell_HelpingHand, Spell_Hold, Spell_Hunger, Spell_Hungerless, Spell_IceLance, Spell_IceSheet, Spell_IceStorm, Spell_IdentifyObject, Spell_Ignite, Spell_IllusoryDisease, Spell_IllusoryWall, Spell_Immunity, Spell_Imprisonment, Spell_ImprovedHarden, Spell_ImprovedInvisibility, Spell_ImprovedPolymorph, Spell_ImprovedRepairingAura, Spell_IncreaseGravity, Spell_Infravision, Spell_InsatiableThirst, Spell_InsectPlague, Spell_Invisibility, Spell_InvisibilitySphere, Spell_IronGrip, Spell_Irritation, Spell_KeenEdge, Spell_KineticBubble, Spell_KineticPulse, Spell_Knock, Spell_KnowAlignment, Spell_KnowBliss, Spell_KnowFate, Spell_KnowOrigin, Spell_KnowPain, Spell_KnowProvince, Spell_KnowValue, Spell_Laughter, Spell_LedFoot, Spell_Levitate, Spell_Light, Spell_LightBlindness, Spell_LightenItem, Spell_Lighthouse, Spell_Lightning, Spell_LightSensitivity, Spell_LimbRack, Spell_LocateObject, Spell_LowerResists, Spell_MageArmor, Spell_MageClaws, Spell_MagicalAura, Spell_MagicBullets, Spell_MagicItem, Spell_MagicMissile, Spell_MagicMouth, Spell_Majesty, Spell_MajorGlobe, Spell_ManaBurn, Spell_ManaShield, Spell_MarkerPortal, Spell_MarkerSummoning, Spell_MassDisintegrate, Spell_MassFeatherfall, Spell_MassFly, Spell_MassHaste, Spell_MassHold, Spell_MassInvisibility, Spell_MassRepairingAura, Spell_MassSleep, Spell_MassSlow, Spell_MassWaterbreath, Spell_Meld, Spell_Mend, Spell_MeteorStorm, Spell_MindBlock, Spell_MindFog, Spell_MindLight, Spell_MinorGlobe, Spell_MinorImage, Spell_Mirage, Spell_MirrorImage, Spell_Misstep, Spell_Mute, Spell_MysticLoom, Spell_MysticShine, Spell_NaturalCommunion, Spell_Nightmare, Spell_Nondetection, Spell_ObscureSelf, Spell_PassDoor, Spell_Permanency, Spell_Phantasm, Spell_PhantomHound, Spell_PlanarBanish, Spell_PlanarBlock, Spell_PlanarBubble, Spell_PlanarBurst, Spell_PlanarDistortion, Spell_PlanarEnthrall, Spell_PlanarExtension, Spell_Planarmorph, Spell_PlanarTimer, Spell_PlanarWard, Spell_Pocket, Spell_Polymorph, Spell_PolymorphObject, Spell_PolymorphSelf, Spell_Portal, Spell_PortalOther, Spell_PrayerShield, Spell_PredictWeather, Spell_Prestidigitation, Spell_ProduceFlame, Spell_PryingEye, Spell_PurgeInvisibility, Spell_ReadMagic, Spell_RechargeWand, Spell_Refit, Spell_Reinforce, Spell_RepairingAura, Spell_Repulsion, Spell_ResistAcid, Spell_ResistArrows, Spell_ResistBludgeoning, Spell_ResistCold, Spell_ResistDisease, Spell_ResistElectricity, Spell_ResistFire, Spell_ResistGas, Spell_ResistIndignities, Spell_ResistMagicMissiles, Spell_ResistParalyzation, Spell_ResistPetrification, Spell_ResistPiercing, Spell_ResistPoison, Spell_ResistSlashing, Spell_ReverseGravity, Spell_RogueLimb, Spell_Scatter, Spell_Scribe, Spell_Scry, Spell_SeeAura, Spell_ShapeObject, Spell_Shatter, Spell_Shelter, Spell_Shield, Spell_ShockingGrasp, Spell_Shockshield, Spell_ShoddyAura, Spell_Shove, Spell_Shrink, Spell_ShrinkMouth, Spell_Silence, Spell_Simulacrum, Spell_Siphon, Spell_Sleep, Spell_Slow, Spell_SlowProjectiles, Spell_SolveMaze, Spell_Sonar, Spell_SongShield, Spell_Spellbinding, Spell_SpellTurning, Spell_SpiderClimb, Spell_Spook, Spell_SpottersOrders, Spell_SpyingStone, Spell_StinkingCloud, Spell_StoneFlesh, Spell_Stoneskin, Spell_StoreAromas, Spell_StoreSpell, Spell_Summon, Spell_SummonArmy, Spell_SummonCompanion, Spell_SummonEnemy, Spell_SummonFlyer, Spell_SummoningWard, Spell_SummonMarker, Spell_SummonMonster, Spell_SummonSteed, Spell_SuppressAroma, Spell_Telepathy, Spell_Teleport, Spell_TeleportationWard, Spell_TeleportObject, Spell_Thirstless, Spell_Timeport, Spell_TimeStop, Spell_Toadstool, Spell_Torture, Spell_Tourettes, Spell_Transformation, Spell_TrueName, Spell_TrueSight, Spell_Ugliness, Spell_Untraceable, Spell_Ventriloquate, Spell_WallOfAir, Spell_WallOfDarkness, Spell_WallOfFire, Spell_WallOfForce, Spell_WallOfIce, Spell_WallOfStone, Spell_WardArea, Spell_WatchfulHound, Spell_WaterBreathing, Spell_WaterCannon, Spell_Weaken, Spell_WeaknessAcid, Spell_WeaknessCold, Spell_WeaknessElectricity, Spell_WeaknessFire, Spell_WeaknessGas, Spell_Web, Spell_WellDressed, Spell_Wish, Spell_WizardLock, Spell_WizardsChest, Spell_WizardsMark, Spell_WordRecall, Spell_Youth

public class Spell
extends StdAbility

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	CHAIN_LENGTH

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
Spell()

Method Summary

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.
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.
java.lang.String	displayText()	Gets the raw string used to show what this object looks like in the room.
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.
Ability	maliciousAffect(MOB mob, Physical target, int asLevel, int tickAdjustmentFromStandard, int additionAffectCheckCode)
java.lang.String	name()	The nice displayable name of this instance of this object
protected static boolean	spellArmorCheck(StdAbility A, MOB mob, boolean auto)
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.

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, affectCharState, affectCharStats, affecting, affectPhyStats, amDestroyed, aPossibleAbuserOfCasterLevel, appropriateToMyFactions, autoInvocation, beneficialAffect, beneficialSoundFizzle, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingQuality, castingTime, checkComponents, checkedCastingCost, checkTargetRange, cloneFix, combatCastingTime, commonTell, commonTelL, commonTelL, compareTo, copyOf, description, destroy, disregardsArmorCheck, enchantQuality, evalTargetItem, executeMsg, expertise, expirationDate, externalFiles, failureTell, flags, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getRawTrainingCost, getSaveStatIndex, getStat, getStatCodes, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTargetItemFavorMOB, getTargetItemFavorMOB, getTargetItemFavorMOB, getTickDownRemaining, getTicksBetweenCasts, getTickStatus, getTimeOfNextCast, getTrainingCost, getVisibleRoomTarget, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, ignoreCompounding, image, iniPracticesToPractice, initializeClass, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousFizzle, maxRange, mayBeEnchanted, minCastWaitTime, minRange, miscTextFormat, modifyCastCode, Name, newInstance, okMessage, overrideMana, possibleContainer, practice, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, sameAs, saveCombatState, setAbilityCode, setAffectedOne, setDescription, setDisplayText, setExpirationDate, setImage, setInvoker, setMiscText, setName, setProficiency, setSavable, setStat, setTickDown, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somaticCastCode, somaticCastMask, spreadImmunity, startTickDown, teach, testUsageCost, text, tick, unInvoke, unlearn, usageCost, usageType, verbalCastCode, verbalCastMask, verbalSpeakCode

Field Detail

CHAIN_LENGTH

protected static final int CHAIN_LENGTH

See Also:

Constant Field Values

Constructor Detail

Spell

public Spell()

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

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()

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

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

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()

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

maliciousAffect

public Ability maliciousAffect(MOB mob,
                               Physical target,
                               int asLevel,
                               int tickAdjustmentFromStandard,
                               int additionAffectCheckCode)

Overrides:

maliciousAffect in class StdAbility

spellArmorCheck

protected static boolean spellArmorCheck(StdAbility A,
                                         MOB mob,
                                         boolean auto)

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.