com.planet_ink.coffee_mud.Abilities.Traps
Class Trap_Trap

java.lang.Object
  com.planet_ink.coffee_mud.Abilities.StdAbility
      com.planet_ink.coffee_mud.Abilities.Traps.Trap_Trap

All Implemented Interfaces:

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

Direct Known Subclasses:

Trap_Enter, Trap_ExitRoom, Trap_Get, Trap_Open, Trap_Unlock

public class Trap_Trap
extends StdAbility
implements Trap

Field Summary

protected static MOB	benefactor
protected Room	myPit
protected Room	myPitUp
protected int	reset
protected boolean	sprung

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.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_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_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_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_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, 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_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ENABLER, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_MINDALTERING, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, 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_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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Trap_Trap()

Method Summary

void	activateBomb() When called, this will cause the bomb to begin its countdown to going off, which can differ from bomb-to-bomb.
void	blade(MOB mob)
protected int	canAffectCode() Designates whether, when used as a property/effect, what sort of objects this ability can affect.
boolean	canReSetTrap(MOB mob) Returns whether the given mob, at the given level, is allowed to re-set this trap.
boolean	canSetTrapOn(MOB mob, Physical P) 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	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
void	fallInPit(MOB mob)
void	gas(MOB mob)
int	getReset() Return the number of ticks after a trap has been sprung before it will automatically reset itself for another victim.
java.util.List<Item>	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.
MOB	invoker() Always returns the mob that invoked or initiated the skill or effect.
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 nice displayable name of this instance of this object
void	needle(MOB mob)
java.lang.String	requiresToSet() A simple display string describing the conditions necesssary to get the canSetTrapOn method to return true.
void	resetTrap(MOB mob) Causes the trap to become reset and unsprung.
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, Physical P, int trapBonus, int qualifyingClassLevel, boolean perm) Completed the task of setting a trap on a given object.
void	spring(MOB target) 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)
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.
protected int	trapType()
void	unInvoke() If this skill is uninvokable, this method will uninvoke it, remove it as an effect on the target, and shut it down.
void	victimOfSpell(MOB mob)

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

abilityCode, abstractQuality, accountForYourself, addedTickTime, adjustBeneficialTickdownTime, adjustedLevel, adjustedMaxInvokerRange, adjustMaliciousTickdownTime, affectCharState, affectCharStats, affecting, affectPhyStats, amDestroyed, appropriateToMyFactions, autoInvocation, beneficialAffect, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingQuality, castingTime, checkComponents, checkedCastingCost, cloneFix, combatCastingTime, compareTo, copyOf, description, destroy, displayText, disregardsArmorCheck, enchantQuality, evalTargetItem, executeMsg, experienceLevels, expertise, expirationDate, externalFiles, 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, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, image, iniPracticesToPractice, initializeClass, invoke, invoke, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, maxRange, minCastWaitTime, minRange, miscTextFormat, 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, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somanticCastCode, somanticCastMask, spreadImmunity, startTickDown, teach, text, triggerStrings, usageCost, usageType, verbalCastCode, verbalCastMask, verbalSpeakCode

Methods inherited from class java.lang.Object

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

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

abilityCode, abstractQuality, accountForYourself, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkedCastingCost, combatCastingTime, enchantQuality, externalFiles, flags, getTrainingCost, helpProficiency, invoke, invoke, isAutoInvoked, isNowAnAutoEffect, makeLongLasting, makeNonUninvokable, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, requirements, setAbilityCode, setAffectedOne, setInvoker, setProficiency, startTickDown, teach, triggerStrings, usageCost, usageType

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

description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

getTickStatus

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

affectCharState, affectCharStats, affectPhyStats

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

executeMsg, okMessage

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

amDestroyed, destroy, isSavable, setSavable

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.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Field Detail

benefactor

protected static MOB benefactor

sprung

protected boolean sprung

myPit

protected Room myPit

myPitUp

protected Room myPitUp

reset

protected int reset

Constructor Detail

Trap_Trap

public Trap_Trap()

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

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

trapType

protected int trapType()

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

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

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)

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, Physical), Trap.setTrap(MOB, Physical, int, int, boolean)

canSetTrapOn

public boolean canSetTrapOn(MOB mob,
                            Physical P)

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

P - 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, Physical, int, int, boolean)

canReSetTrap

public boolean canReSetTrap(MOB mob)

Description copied from interface: Trap

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

Specified by:

canReSetTrap in interface Trap

Parameters:

mob - the trap setter to check

Returns:

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

See Also:

Trap.canSetTrapOn(MOB, Physical), Trap.resetTrap(MOB)

getTrapComponents

public java.util.List<Item> 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, Physical)

setTrap

public Trap setTrap(MOB mob,
                    Physical P,
                    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

P - 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

perm - true to make the trap reset after being triggered or disarmed, false to destroy

Returns:

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

gas

public void gas(MOB mob)

needle

public void needle(MOB mob)

blade

public void blade(MOB mob)

victimOfSpell

public void victimOfSpell(MOB mob)

fallInPit

public void fallInPit(MOB mob)

invoker

public MOB invoker()

Description copied from interface: Ability

Always returns the mob that invoked or initiated the skill or effect.

Specified by:

invoker in interface Ability

Overrides:

invoker in class StdAbility

Returns:

the invoker mob

See Also:

MOB, Ability.setInvoker(MOB)

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

spring

public void spring(MOB target)

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:

target - the target of the effect

See Also:

Trap.sprung()

resetTrap

public void resetTrap(MOB mob)

Description copied from interface: Trap

Causes the trap to become reset and unsprung. Called usually by thief type skills.

Specified by:

resetTrap in interface Trap

Parameters:

mob - the person resetting the trap

See Also:

Trap.canReSetTrap(MOB)

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