Package com.planet_ink.coffee_mud.Abilities.Misc

Class InstanceArea

java.lang.Object

com.planet_ink.coffee_mud.Abilities.StdAbility

com.planet_ink.coffee_mud.Abilities.Misc.InstanceArea

All Implemented Interfaces:

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

public class InstanceArea
extends StdAbility

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	InstanceArea.InstanceAreaManager
protected static class	InstanceArea.InstSpecFlag	The special attribute flags for instances
protected static class	InstanceArea.InstVar	The definitions variables for the attributes of each instance

Field Summary

Fields

Modifier and Type	Field	Description
protected PairList<java.lang.String,java.lang.String>	behavList
protected int	bonusDmgStat
protected java.util.List<java.lang.String>	categories
protected java.lang.String	colorPrefix
protected PairList<Pair<java.lang.Integer,java.lang.Integer>,PairList<java.lang.String,java.lang.String>>	enableList
protected PairList<java.lang.String,java.lang.String>	factionList
protected int	fatigueRate
protected int	hardBumpLevel
protected static long	hardBumpTimeout
protected PairList<java.lang.String,java.lang.String>	ieffectList
protected CMath.CompiledFormula	iLevelFormula
protected static java.util.Map<Area,java.util.List<StdArea.AreaInstanceChild>>	instanceChildren
protected int	instanceLevel
protected static java.util.concurrent.atomic.AtomicInteger	instIDNum
protected java.lang.String	instTypeID
protected java.util.Map<java.lang.String,java.lang.String>	instVars
protected long	lastCasting
protected java.lang.ref.WeakReference<MOB>	leaderMob
protected CMath.CompiledFormula	levelFormula
protected PairList<java.lang.Integer,java.lang.Long>	limits
protected java.lang.ref.WeakReference<Room>	oldRoom
protected PairList<java.lang.String,java.lang.String>	pFactionList
protected PairList<java.lang.Integer,java.lang.String>	promotions
protected int	recoverRate
protected int	recoverTick
protected PairList<java.lang.String,java.lang.String>	reffectList
protected java.util.Set<java.lang.String>	reqWeapons
protected WeakArrayList<Room>	roomsDone
protected java.util.Set<InstanceArea.InstSpecFlag>	specFlags
protected java.util.Set<Area>	targetAreas
protected int	topPlayerFacVal
protected int	totalTickDown

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

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.
void	affectCharStats(MOB affected, CharStats affectableStats)	This method is called by the recoverCharStats() method on other MOB objects.
void	affectPhyStats(Physical affected, PhyStats affectableStats)	This method is called by the recoverPhyStats() method on other Environmental objects.
protected void	applyMobPrefix(MOB M, int[] eliteBump)
protected int	canTargetCode()	Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
protected java.lang.String	castingMessage(MOB mob, boolean auto)
protected void	clearVars()
protected java.lang.String	convertToMyArea(Area childA, java.lang.String parentAreaRoomID)
protected java.lang.String	convertToMyArea(java.lang.String newAreaName, java.lang.String oldRoomID)
protected void	destroyInstance(Area instA)
java.lang.String	displayText()	Gets the raw string used to show what this object looks like in the room.
protected void	doInstanceRoomColoring(Room room)
protected boolean	doneRoom(Room R)
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
protected java.lang.String	failMessage(MOB mob, boolean auto)
protected java.lang.String	findDisplayNameFor(java.lang.String playerName, java.lang.String instanceID)
protected void	fixRoom(Room room)
long	flags()	Returns a bitmap giving some specific information about the scope and purpose of the skill.
protected java.util.List<java.lang.String>	getAllInstanceKeys()
protected static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>[]>	getAllInstanceTypesMap()
protected java.util.List<CMObject>	getAreaEffectsBehavs()
protected InstanceArea	getInstanceArea(Physical P)
protected java.util.Map<java.lang.String,java.lang.String>	getInstVars(java.lang.String instTypeID)
protected Room	getOldRoom()
java.lang.String	getStat(java.lang.String code)	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
protected java.lang.String	getStrippedRoomID(java.lang.String roomID)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	invoke(MOB mob, java.util.List<java.lang.String> commands, Physical givenTarget, boolean auto, int asLevel)	This method is called when a player or the system invokes this skill, casts this spell, etc.
boolean	isApplicableKickoffFor(MOB mob, java.util.Set<MOB> mobGrp, Room targetRoom)
protected boolean	isInstanceMob(MOB M)
protected java.lang.String	listOfInstanceIDs()
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.
protected int	overrideMana()	amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT
protected void	reEffect(Physical M, java.lang.String ID, java.lang.String parms)
protected boolean	roomDone(Room R)
void	setAffectedOne(Physical P)	Sets a reference to the room, item, mob, or exit that is currently being affected by this skill.
protected void	setInstaceTypeID(java.lang.String instTypeID)
void	setMiscText(java.lang.String newText)	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.
protected void	setOldRoom(Room oldRoom)
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
void	unInvoke()	If this skill is uninvokable, this method will uninvoke it, remove it as an effect on the target, and shut it down.

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, affecting, amDestroyed, aPossibleAbuserOfCasterLevel, appropriateToMyFactions, autoInvocation, beneficialAffect, beneficialSoundFizzle, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canAffectCode, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingQuality, castingTime, checkComponents, checkedCastingCost, checkTargetRange, classificationCode, cloneFix, combatCastingTime, commonTell, commonTelL, commonTelL, compareTo, copyOf, description, destroy, disregardsArmorCheck, enchantQuality, evalTargetItem, expertise, expirationDate, externalFiles, failureTell, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getRawTrainingCost, getSaveStatIndex, 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, maliciousAffect, maliciousFizzle, maxRange, mayBeEnchanted, minCastWaitTime, minRange, miscTextFormat, modifyCastCode, Name, newInstance, possibleContainer, practice, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, sameAs, saveCombatState, setAbilityCode, setDescription, setDisplayText, setExpirationDate, setImage, setInvoker, setName, setProficiency, setSavable, setStat, setTickDown, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somaticCastCode, somaticCastMask, spreadImmunity, startTickDown, teach, testUsageCost, text, triggerStrings, unlearn, usageCost, usageType, verbalCastCode, verbalCastMask, verbalSpeakCode

Field Detail

leaderMob

protected java.lang.ref.WeakReference<MOB> leaderMob

lastCasting

protected volatile long lastCasting

oldRoom

protected java.lang.ref.WeakReference<Room> oldRoom

targetAreas

protected java.util.Set<Area> targetAreas

instVars

protected java.util.Map<java.lang.String,java.lang.String> instVars

roomsDone

protected WeakArrayList<Room> roomsDone

instanceLevel

protected int instanceLevel

instTypeID

protected java.lang.String instTypeID

colorPrefix

protected java.lang.String colorPrefix

promotions

protected PairList<java.lang.Integer,java.lang.String> promotions

categories

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

behavList

protected PairList<java.lang.String,java.lang.String> behavList

reffectList

protected PairList<java.lang.String,java.lang.String> reffectList

ieffectList

protected PairList<java.lang.String,java.lang.String> ieffectList

factionList

protected PairList<java.lang.String,java.lang.String> factionList

pFactionList

protected PairList<java.lang.String,java.lang.String> pFactionList

limits

protected PairList<java.lang.Integer,java.lang.Long> limits

bonusDmgStat

protected int bonusDmgStat

reqWeapons

protected java.util.Set<java.lang.String> reqWeapons

recoverRate

protected int recoverRate

fatigueRate

protected int fatigueRate

recoverTick

protected volatile int recoverTick

specFlags

protected java.util.Set<InstanceArea.InstSpecFlag> specFlags

hardBumpLevel

protected int hardBumpLevel

totalTickDown

protected int totalTickDown

levelFormula

protected CMath.CompiledFormula levelFormula

iLevelFormula

protected CMath.CompiledFormula iLevelFormula

topPlayerFacVal

protected int topPlayerFacVal

enableList

protected PairList<Pair<java.lang.Integer,java.lang.Integer>,PairList<java.lang.String,java.lang.String>> enableList

instanceChildren

protected static final java.util.Map<Area,java.util.List<StdArea.AreaInstanceChild>> instanceChildren

hardBumpTimeout

protected static final long hardBumpTimeout

See Also:

Constant Field Values

instIDNum

protected static final java.util.concurrent.atomic.AtomicInteger instIDNum

Constructor Detail

InstanceArea

public InstanceArea()

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

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

flags

public long flags()

Description copied from interface: Ability

Returns a bitmap giving some specific information about the scope and purpose of the skill. The bitmap is composed of FLAG_* constants from the Ability interface.

Specified by:

flags in interface Ability

Overrides:

flags in class StdAbility

Returns:

FLAG_* constant based bitmap

See Also:

Ability

overrideMana

protected int overrideMana()

Description copied from class: StdAbility

amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT

Overrides:

overrideMana in class StdAbility

Returns:

amount of mana/move used by this ability, overriding ini file

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

getOldRoom

protected final Room getOldRoom()

setOldRoom

protected final void setOldRoom(Room oldRoom)

setInstaceTypeID

protected void setInstaceTypeID(java.lang.String instTypeID)

clearVars

protected void clearVars()

setMiscText

public void setMiscText(java.lang.String newText)

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:

newText - either an open internal text string, or XML

getAreaEffectsBehavs

protected java.util.List<CMObject> getAreaEffectsBehavs()

reEffect

protected void reEffect(Physical M,
                        java.lang.String ID,
                        java.lang.String parms)

isInstanceMob

protected boolean isInstanceMob(MOB M)

doInstanceRoomColoring

protected void doInstanceRoomColoring(Room room)

applyMobPrefix

protected void applyMobPrefix(MOB M,
                              int[] eliteBump)

fixRoom

protected void fixRoom(Room room)

affectCharStats

public void affectCharStats(MOB affected,
                            CharStats affectableStats)

Description copied from interface: StatsAffecting

This method is called by the recoverCharStats() method on other MOB objects. It is used to transform the MOB baseCharStats() object into a finished charStats() object, both of which are objects implementing the CharStats interface. See those methods for more information.

Specified by:

affectCharStats in interface StatsAffecting

Overrides:

affectCharStats in class StdAbility

Parameters:

affected - the host of the CharStats object being affected

affectableStats - the particular CharStats object being affected

See Also:

CharStats, MOB, MOB.baseCharStats(), MOB.charStats(), MOB.recoverCharStats()

affectPhyStats

public void affectPhyStats(Physical affected,
                           PhyStats affectableStats)

Description copied from interface: StatsAffecting

This method is called by the recoverPhyStats() method on other Environmental objects. It is used to transform the Environmental basePhyStats() object into a finished phyStats() object, both of which are objects implementing the PhyStats interface. See those methods for more information.

Specified by:

affectPhyStats in interface StatsAffecting

Overrides:

affectPhyStats in class StdAbility

Parameters:

affected - the host of the PhyStats object being affected

affectableStats - the particular PhyStats object being affected

See Also:

PhyStats, Environmental, Affectable.basePhyStats(), Affectable.phyStats(), Affectable.recoverPhyStats()

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

roomDone

protected boolean roomDone(Room R)

doneRoom

protected boolean doneRoom(Room R)

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

isApplicableKickoffFor

public boolean isApplicableKickoffFor(MOB mob,
                                      java.util.Set<MOB> mobGrp,
                                      Room targetRoom)

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

getAllInstanceKeys

protected java.util.List<java.lang.String> getAllInstanceKeys()

listOfInstanceIDs

protected java.lang.String listOfInstanceIDs()

getAllInstanceTypesMap

protected static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>[]> getAllInstanceTypesMap()

getInstVars

protected java.util.Map<java.lang.String,java.lang.String> getInstVars(java.lang.String instTypeID)

destroyInstance

protected void destroyInstance(Area instA)

getStrippedRoomID

protected java.lang.String getStrippedRoomID(java.lang.String roomID)

convertToMyArea

protected java.lang.String convertToMyArea(java.lang.String newAreaName,
                                           java.lang.String oldRoomID)

convertToMyArea

protected java.lang.String convertToMyArea(Area childA,
                                           java.lang.String parentAreaRoomID)

setAffectedOne

public void setAffectedOne(Physical P)

Description copied from interface: Ability

Sets a reference to the room, item, mob, or exit that is currently being affected by this skill. Does not apply to non-affecting skills like kick, but more to auto-invoking skills and spells that affect people like sleep, and especially to properties.

Specified by:

setAffectedOne in interface Ability

Overrides:

setAffectedOne in class StdAbility

Parameters:

P - the room, mob, or item being affected

See Also:

Ability.affecting()

getInstanceArea

protected InstanceArea getInstanceArea(Physical P)

castingMessage

protected java.lang.String castingMessage(MOB mob,
                                          boolean auto)

failMessage

protected java.lang.String failMessage(MOB mob,
                                       boolean auto)

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

findDisplayNameFor

protected java.lang.String findDisplayNameFor(java.lang.String playerName,
                                              java.lang.String instanceID)

getStat

public java.lang.String getStat(java.lang.String code)

Description copied from interface: Modifiable

An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:

getStat in interface Modifiable

Overrides:

getStat in class StdAbility

Parameters:

code - the name of the field to read.

Returns:

the value of the field read

See Also:

Modifiable.getStatCodes()

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.