com.planet_ink.coffee_mud.Abilities.Traps
Class StdTrap

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

All Implemented Interfaces:

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

Direct Known Subclasses:

StdBomb, Trap_AcidSpray, Trap_Avalanche, Trap_BearTrap, Trap_Boomerang, Trap_Boulders, Trap_CaveIn, Trap_CrushingRoom, Trap_Darkfall, Trap_ElectricShock, Trap_FloodRoom, Trap_Gluey, Trap_Greasy, Trap_Ignition, Trap_Infected, Trap_Launcher, Trap_MonsterCage, Trap_Needle, Trap_NeedlePrick, Trap_Noise, Trap_PoisonGas, Trap_Popper, Trap_RoomPit, Trap_SleepGas, Trap_Snare, Trap_Spark, Trap_SpellBlast, Trap_SporeTrap, Trap_Tripline, Trap_Vanishing, Trap_WeaponSwing

public class StdTrap
extends StdAbility
implements Trap

Field Summary

protected int	ableCode
protected boolean	disabled
protected java.util.List<java.lang.String>	newMessaging
protected int	reset
PairVector<MOB,java.lang.Integer>	safeDirs
protected boolean	sprung
static java.lang.String[]	TRIGGER

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

StdTrap()

Method Summary

int	abilityCode() Returns an optional numeric value whose purpose is entirely contextual.
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.
int	baseDestructTime(int level)
int	baseRejuvTime(int level)
protected int	canAffectCode() Designates whether, when used as a property/effect, what sort of objects this ability can affect.
protected boolean	canInvokeTrapOn(MOB invoker, MOB target)
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.
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
protected void	destroyResources(Room room, int resource, int number)
void	disable() Causes the trap to become disabled and inert.
boolean	disabled() Whether this trap has been disabled, as by a thief
boolean	doesSaveVsTraps(MOB target)
int	enchantQuality() Identical to abstractQuality() method, but returns a quality based on how the skill or spell behaves as a spell effect on a weapon or on armor.
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
protected RawMaterial	findFirstResource(Room room, int resource)
protected RawMaterial	findMostOfMaterial(Room room, int material)
protected int	findNumberOfResource(Room room, RawMaterial resource)
int	getReset() Return the number of ticks after a trap has been sprung before it will automatically reset itself for another victim.
PairVector<MOB,java.lang.Integer>	getSafeDirs()
java.util.List<Item>	getTrapComponents() Returns a sample set of the components used to make this trap.
boolean	getTravelThroughFlag()
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.
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	isLocalExempt(MOB target)
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
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	resetTrap(MOB mob) Causes the trap to become reset and unsprung.
void	setAbilityCode(int code) Sets an optional numeric value whose purpose is entirely contextual.
void	setInvoker(MOB mob) Sets or changes the mob that invoked or initated the skill or effect.
void	setMiscText(java.lang.String text) For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
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)
java.lang.String	text() For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.
protected int	trapLevel()
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 com.planet_ink.coffee_mud.Abilities.StdAbility

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, description, destroy, displayText, disregardsArmorCheck, evalTargetItem, 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, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, maxRange, minCastWaitTime, minRange, miscTextFormat, Name, newInstance, overrideMana, possibleContainer, practice, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, sameAs, saveCombatState, setAffectedOne, setDescription, setDisplayText, setExpirationDate, setImage, setName, setProficiency, setSavable, setStat, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somanticCastCode, somanticCastMask, spreadImmunity, startTickDown, teach, unInvoke, 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

accountForYourself, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkedCastingCost, combatCastingTime, externalFiles, flags, getTrainingCost, helpProficiency, invoke, isAutoInvoked, isNowAnAutoEffect, makeLongLasting, makeNonUninvokable, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, requirements, setAffectedOne, setProficiency, startTickDown, teach, unInvoke, 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, setName

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

amDestroyed, destroy, isSavable, setSavable

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

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

TRIGGER

public static final java.lang.String[] TRIGGER

sprung

protected boolean sprung

reset

protected int reset

ableCode

protected int ableCode

disabled

protected boolean disabled

newMessaging

protected java.util.List<java.lang.String> newMessaging

safeDirs

public PairVector<MOB,java.lang.Integer> safeDirs

Constructor Detail

StdTrap

public StdTrap()

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

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

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

enchantQuality

public int enchantQuality()

Description copied from interface: Ability

Identical to abstractQuality() method, but returns a quality based on how the skill or spell behaves as a spell effect on a weapon or on armor. This helps decide whether this skill is appropriate in those roles. These constants are defined in the Ability interface and called QUALITY_*

Specified by:

enchantQuality in interface Ability

Overrides:

enchantQuality in class StdAbility

Returns:

Ability.QUALITY_* constant classification

See Also:

Ability.abstractQuality(), 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

trapLevel

protected int trapLevel()

setAbilityCode

public void setAbilityCode(int code)

Description copied from interface: Ability

Sets an optional numeric value whose purpose is entirely contextual. For many skills, this reflects some sort of enhancement. Default is 0.

Specified by:

setAbilityCode in interface Ability

Overrides:

setAbilityCode in class StdAbility

Parameters:

code - the optional numeric value or enhancement

abilityCode

public int abilityCode()

Description copied from interface: Ability

Returns an optional numeric value whose purpose is entirely contextual. For many skills, this reflects some sort of enhancement. Default is 0.

Specified by:

abilityCode in interface Ability

Overrides:

abilityCode in class StdAbility

Returns:

the current optional numeric value or enhancement

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

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)

baseRejuvTime

public int baseRejuvTime(int level)

baseDestructTime

public int baseDestructTime(int level)

getTravelThroughFlag

public boolean getTravelThroughFlag()

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

doesSaveVsTraps

public boolean doesSaveVsTraps(MOB target)

isLocalExempt

public boolean isLocalExempt(MOB target)

canInvokeTrapOn

protected boolean canInvokeTrapOn(MOB invoker,
                                  MOB target)

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)

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

setMiscText

public void setMiscText(java.lang.String text)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class StdAbility

Parameters:

text - either an open internal text string, or XML

text

public java.lang.String text()

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

text in interface Environmental

Overrides:

text in class StdAbility

Returns:

either an open internal text string, or XML

getSafeDirs

public PairVector<MOB,java.lang.Integer> getSafeDirs()

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Overrides:

copyOf in class StdAbility

Returns:

a clone of this object

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

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

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

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)

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)

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)

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

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

setInvoker

public void setInvoker(MOB mob)

Description copied from interface: Ability

Sets or changes the mob that invoked or initated the skill or effect.

Specified by:

setInvoker in interface Ability

Overrides:

setInvoker in class StdAbility

Parameters:

mob - the invoker mob

See Also:

MOB, Ability.invoker()

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

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)

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

findFirstResource

protected RawMaterial findFirstResource(Room room,
                                        int resource)

findMostOfMaterial

protected RawMaterial findMostOfMaterial(Room room,
                                         int material)

destroyResources

protected void destroyResources(Room room,
                                int resource,
                                int number)

findNumberOfResource

protected int findNumberOfResource(Room room,
                                   RawMaterial resource)

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.