com.planet_ink.coffee_mud.Abilities.Thief
Class Thief_Caltrops

java.lang.Object
  com.planet_ink.coffee_mud.Abilities.StdAbility
      com.planet_ink.coffee_mud.Abilities.Thief.ThiefSkill
          com.planet_ink.coffee_mud.Abilities.Thief.Thief_Caltrops

All Implemented Interfaces:

Ability, Trap, Behavable, CMModifiable, CMObject, Environmental, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

Thief_DazzlingCaltrops, Thief_DisablingCaltrops, Thief_ImprovedCaltrops, Thief_SlickCaltrops

public class Thief_Caltrops
extends ThiefSkill
implements Trap

Field Summary

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

affected, amDestroyed, canBeUninvoked, empty, envStats, expertise, invoker, isAnAutoEffect, lastCastHelp, miscText, proficiency, savable, tickDown, unInvoked

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

TRAP_GAS, TRAP_NEEDLE, TRAP_PIT_BLADE, TRAP_SPELL

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

ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, 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_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, 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_ENCHANTMENT, DOMAIN_ENDURING, 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_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_AIRBASED, FLAG_BINDING, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_INTOXICATING, FLAG_MOVING, FLAG_NOORDERING, FLAG_PARALYZING, FLAG_SUMMONING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT

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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY, TICKS_PER_RLMIN, TIME_MILIS_PER_MUDHOUR, TIME_TICK, TIME_TICK_DOUBLE

Constructor Summary

Thief_Caltrops()

Method Summary

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	activateBomb() When called, this will cause the bomb to begin its countdown to going off, which can differ from bomb-to-bomb.
java.lang.String	caltropTypeName()
protected int	canAffectCode() Designates whether, when used as a property/effect, what sort of objects this ability can affect.
boolean	canSetTrapOn(MOB mob, Environmental E) Returns whether the given trapper is currently in a position to set this trap on the specified object.
protected int	canTargetCode() Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
int	castingQuality(MOB mob, Environmental target) Serves a purpose similar to that of the Ability abstractQuality() method, but it determines a more exact quality based on a given invoker, target, and assumes an imminent use of the skill.
int	classificationCode() Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
void	disable() Causes the trap to become disabled and inert.
boolean	disabled() Whether this trap has been disabled, as by a thief
int	getReset() Return the number of ticks after a trap has been sprung before it will automatically reset itself for another victim.
java.util.Vector	getTrapComponents() Returns a sample set of the components used to make this trap.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	invoke(MOB mob, java.util.Vector commands, Environmental givenTarget, boolean auto, int asLevel) This method is called when a player or the system invokes this skill, casts this spell, etc.
boolean	isABomb() Returns whether this trap is a bomb, with delayed effect.
boolean	maySetTrap(MOB mob, int asLevel) Returns whether the given mob, at the given level, is allowed to set this trap.
java.lang.String	name() The displayable name of this object.
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
java.lang.String	requiresToSet() A simple display string describing the conditions necesssary to get the canSetTrapOn method to return true.
void	setReset(int Reset) Sets the number of ticks to wait after a trap has been sprung, before it will automatically reset for another victim.
Trap	setTrap(MOB mob, Environmental E, int trapBonus, int qualifyingClassLevel, boolean perm) Completed the task of setting a trap on a given object.
void	spring(MOB mob) This method causes this trap to take affect against the given target.
boolean	sprung() Returns whether this trap has already been sprung (and is not yet reset)
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.
int	usageType() Returns a bitmap made up of constants defined by Ability.USAGE_*.

Methods inherited from class com.planet_ink.coffee_mud.Abilities.Thief.ThiefSkill

enchantQuality, getHighestLevelMOB, getMOBLevel

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

abilityCode, ableOk, ableSend, accountForYourself, addBehavior, addedTickTime, addEffect, addNonUninvokableEffect, addScript, adjustedLevel, adjustedMaxInvokerRange, affectCharState, affectCharStats, affectEnvStats, affecting, amDestroyed, appropriateToMyFactions, autoInvocation, baseEnvStats, beneficialAffect, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkComponents, cloneFix, combatCastingTime, compareTo, copyOf, delBehavior, delEffect, delScript, description, destroy, displayText, disregardsArmorCheck, envStats, executeMsg, experienceLevels, expertise, expirationDate, externalFiles, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, flags, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getMaliciousTickdownTime, getSaveStatIndex, getStat, getStatCodes, getTarget, getTarget, getTarget, getTarget, getTickDownRemaining, getTickStatus, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, image, iniPracticesRequired, iniPracticesToPractice, initializeClass, iniTrainsRequired, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isStat, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, maxRange, minCastWaitTime, minRange, miscTextFormat, Name, newInstance, numBehaviors, numEffects, numScripts, overrideMana, possibleContainer, practice, practicesRequired, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargets, putInCommandlist, rawImage, recoverEnvStats, requirements, sameAs, savable, setAbilityCode, setAffectedOne, setBaseEnvStats, setDescription, setDisplayText, setExpirationDate, setImage, setInvoker, setMiscText, setName, setProficiency, setSavable, setStat, setTickDownRemaining, somanticCastCode, somanticCastMask, spreadImmunity, startTickDown, teach, text, tick, trainsRequired, unInvoke, usageCost, verbalCastCode, verbalCastMask

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

abilityCode, accountForYourself, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingTime, combatCastingTime, enchantQuality, externalFiles, flags, helpProficiency, invoke, invoker, isAutoInvoked, isNowAnAutoEffect, makeLongLasting, makeNonUninvokable, practice, practicesRequired, preInvoke, proficiency, proficiencyCheck, putInCommandlist, requirements, setAbilityCode, setAffectedOne, setInvoker, setProficiency, setSavable, startTickDown, teach, trainsRequired, unInvoke, usageCost

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

addEffect, addNonUninvokableEffect, amDestroyed, baseEnvStats, delEffect, description, destroy, displayText, envStats, expirationDate, fetchEffect, fetchEffect, image, isGeneric, maxRange, minRange, miscTextFormat, Name, numEffects, rawImage, recoverEnvStats, sameAs, savable, setBaseEnvStats, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

getTickStatus, tick

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectEnvStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener

executeMsg

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMModifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts

Constructor Detail

Thief_Caltrops

public Thief_Caltrops()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class ThiefSkill

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Environmental

The displayable name of this object. May be modified by envStats() object. Is derived from the Name().

Specified by:

name in interface Environmental

Specified by:

name in interface Tickable

Overrides:

name in class ThiefSkill

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

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 ThiefSkill

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 ThiefSkill

Returns:

a mask showing the type of objects this ability can target

See Also:

Ability

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 ThiefSkill

Returns:

ACODE_* constant classification

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 ThiefSkill

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

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

caltropTypeName

public java.lang.String caltropTypeName()

isABomb

public boolean isABomb()

Description copied from interface: Trap

Returns whether this trap is a bomb, with delayed effect.

Specified by:

isABomb in interface Trap

Returns:

true if its a bomb, false otherwise

activateBomb

public void activateBomb()

Description copied from interface: Trap

When called, this will cause the bomb to begin its countdown to going off, which can differ from bomb-to-bomb.

Specified by:

activateBomb in interface Trap

disabled

public boolean disabled()

Description copied from interface: Trap

Whether this trap has been disabled, as by a thief

Specified by:

disabled in interface Trap

Returns:

true if disabled, false otherwise

See Also:

Trap.disable()

disable

public void disable()

Description copied from interface: Trap

Causes the trap to become disabled and inert. Called usually by thief type skills.

Specified by:

disable in interface Trap

See Also:

Trap.disabled()

setReset

public void setReset(int Reset)

Description copied from interface: Trap

Sets the number of ticks to wait after a trap has been sprung, before it will automatically reset for another victim. A reset value of 0 means the trap is only useful once.

Specified by:

setReset in interface Trap

Parameters:

Reset - the number of ticks between uses

See Also:

Trap.getReset()

getReset

public int getReset()

Description copied from interface: Trap

Return the number of ticks after a trap has been sprung before it will automatically reset itself for another victim. A value of 0 means the trap is only useful once.

Specified by:

getReset in interface Trap

Returns:

the number of ticks between resets

See Also:

Trap.setReset(int)

maySetTrap

public boolean maySetTrap(MOB mob,
                          int asLevel)

Description copied from interface: Trap

Returns whether the given mob, at the given level, is allowed to set this trap. This is where level restrictions are enforced, though no messages should be given.

Specified by:

maySetTrap in interface Trap

Parameters:

mob - the trap setter to check

asLevel - the level of the trapper, compared to this traps internal level

Returns:

true if the given trapper is allowed to set this trap, false otherwise

See Also:

Trap.canSetTrapOn(MOB, Environmental), Trap.setTrap(MOB, Environmental, int, int, boolean)

canSetTrapOn

public boolean canSetTrapOn(MOB mob,
                            Environmental E)

Description copied from interface: Trap

Returns whether the given trapper is currently in a position to set this trap on the specified object. Error messages should be delivered to the trapper if any internal checks aren't made. Required materials or conditions are checked here

Specified by:

canSetTrapOn in interface Trap

Parameters:

mob - the trapper

E - the object this trap will be set upon

Returns:

true if the trapper has everything he needs to proceed, false otherwise

See Also:

Trap.maySetTrap(MOB, int), Trap.setTrap(MOB, Environmental, int, int, boolean)

getTrapComponents

public java.util.Vector getTrapComponents()

Description copied from interface: Trap

Returns a sample set of the components used to make this trap.

Specified by:

getTrapComponents in interface Trap

Returns:

a vector of item objects

requiresToSet

public java.lang.String requiresToSet()

Description copied from interface: Trap

A simple display string describing the conditions necesssary to get the canSetTrapOn method to return true.

Specified by:

requiresToSet in interface Trap

Returns:

a descriptive text for this trap.

See Also:

Trap.canSetTrapOn(MOB, Environmental)

setTrap

public Trap setTrap(MOB mob,
                    Environmental E,
                    int trapBonus,
                    int qualifyingClassLevel,
                    boolean perm)

Description copied from interface: Trap

Completed the task of setting a trap on a given object. If any materials are required, this method will consume them. If it is a bomb, it will still require activation, however. This wil also set the reset time based on the given classlevel and qualifyingClassLevel of the trapper.

Specified by:

setTrap in interface Trap

Parameters:

mob - the trapper

E - the object to set the trap on

trapBonus - any bonus to the traps effectiveness (0 is normal)

qualifyingClassLevel - the class-level at which the trapper qualified for this trap

Returns:

the Trap object denoting the trap just added to the target object

sprung

public boolean sprung()

Description copied from interface: Trap

Returns whether this trap has already been sprung (and is not yet reset)

Specified by:

sprung in interface Trap

Returns:

true if it has been sprung, false otherwise.

See Also:

Trap.spring(MOB)

spring

public void spring(MOB mob)

Description copied from interface: Trap

This method causes this trap to take affect against the given target. The type of effect can differ from trap to trap.

Specified by:

spring in interface Trap

Parameters:

mob - the target of the effect

See Also:

Trap.sprung()

castingQuality

public int castingQuality(MOB mob,
                          Environmental target)

Description copied from interface: Ability

Serves a purpose similar to that of the Ability abstractQuality() method, but it determines a more exact quality based on a given invoker, target, and assumes an imminent use of the skill. For this reason, the QUALITY_OK_* constants should be avoided in favor of the other Ability.QUALITY_* constants.

Specified by:

castingQuality in interface Ability

Overrides:

castingQuality in class StdAbility

Parameters:

mob - the person to use the skill

target - the potential target -- may be invoker

Returns:

Ability.QUALITY_* constant classification

See Also:

Ability, Ability.abstractQuality()

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

invoke

public boolean invoke(MOB mob,
                      java.util.Vector commands,
                      Environmental 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: