Package com.planet_ink.coffee_mud.Abilities

Class StdPlanarAbility

java.lang.Object

com.planet_ink.coffee_mud.Abilities.StdAbility

com.planet_ink.coffee_mud.Abilities.StdPlanarAbility

All Implemented Interfaces:

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

Direct Known Subclasses:

Chant_PlaneWalking, Prayer_PlanarTravel, Spell_Planeshift

public class StdPlanarAbility
extends StdAbility
implements PlanarAbility

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.PlanarAbility

PlanarAbility.PlanarSpecFlag, PlanarAbility.PlanarVar

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alwaysRandomArea
protected PairList<java.lang.String,java.lang.String>	behavList
protected int	bonusDmgStat
protected java.util.List<java.lang.String>	categories
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 long	lastCasting
protected CMath.CompiledFormula	levelFormula
protected java.lang.ref.WeakReference<Room>	oldRoom
protected java.util.List<java.lang.String>	opposed
protected int	planarLevel
protected java.lang.String	planarName
protected java.lang.String	planarPrefix
protected Area	planeArea
protected static java.util.concurrent.atomic.AtomicInteger	planeIDNum
protected java.util.Map<java.lang.String,java.lang.String>	planeVars
protected PairList<java.lang.Integer,java.lang.String>	promotions
protected java.util.Map<java.lang.String,long[]>	recentVisits
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<PlanarAbility.PlanarSpecFlag>	specFlags

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

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.
java.lang.String	addOrEditPlane(java.lang.String planeName, java.lang.String rule)	Creates a new, or edits an existing plane.
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 boolean	alterPlaneLine(java.lang.String planeName, java.lang.String fileName, java.lang.String rule)
void	applyMobPrefix(MOB M, int[] eliteBump)	Applies the prefix and random promotions string to the given mob according to the parsed configuration for the current plane.
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)
void	clearVars()
protected java.lang.String	convertToMyArea(java.lang.String Name, java.lang.String roomID)
boolean	deletePlane(java.lang.String planeName)	Removes a plane of existence, forever.
protected void	destroyPlane()
void	destroyPlane(Area planeA)	Completely destroyed the given plane of existence, kicking all players inside it back to the starting room they came from.
protected void	doneRoom(Room R)
void	doPlanarRoomColoring(Room room)	Applies the room display and description coloring to the given room according to the rules of this plane.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
protected java.lang.String	failMessage(MOB mob, boolean auto)
void	fixRoom(Room room)
long	flags()	Returns a bitmap giving some specific information about the scope and purpose of the skill.
java.util.List<java.lang.String>	getAllPlaneKeys()	Return the list of all non prime-material planes.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getAllPlanesMap()
java.util.List<CMObject>	getAreaEffectsBehavs()	Calculates the area effects and behaviors, not including absorb lists, which would affect the planar area.
PairList<java.lang.String,java.lang.String>	getBehavList()	Get the list of behaviors and parms for this plane
int	getBonusDmgStat()	Get the CharStat STAT_* ID of the stat that gives bonus damage on this plane
java.util.List<java.lang.String>	getCategories()	Get the categories that apply to this plane
PairList<Pair<java.lang.Integer,java.lang.Integer>,PairList<java.lang.String,java.lang.String>>	getEnableList()	Get the bonus ability list for this plane.
PairList<java.lang.String,java.lang.String>	getFactionList()	Get the list of faction ids and values for this plane
int	getFatigueRate()	Get the extra fatigue ticks for players on this plane
int	getHardBumpLevel()	The xtra difficulty level of this plane
CMath.CompiledFormula	getLevelFormula()	Get the mob/item level adjustment formula for this plane.
Room	getOldRoom()	Get the return room when leaving/entering this plane
java.util.List<java.lang.String>	getOpposed()	Get the planes that oppose this plane
protected PlanarAbility	getPlanarAbility(Physical P)
int	getPlanarLevel()	Get the current level of this plane
java.lang.String	getPlanarName()	Get the name of the current plane
java.lang.String	getPlanarPrefix()	The chosen-from-a-list prefix to use on mobs in this plane
java.util.Map<java.lang.String,java.lang.String>	getPlanarVars(java.lang.String planeName)	Get the definition for the given plane
java.util.Map<java.lang.String,java.lang.String>	getPlaneVars()	Get the key/pair definitions for this plane
PairList<java.lang.Integer,java.lang.String>	getPromotions()	Get the pct change and name of available mob promotions for this plane
int	getRecoverRate()	Get the number of extra recover ticks for players on this plane
PairList<java.lang.String,java.lang.String>	getReffectList()	Get the list of room effects and args for this plane
java.util.Set<java.lang.String>	getReqWeapons()	Get the seq of required weapon flags for hurting things in this plane.
java.util.Set<PlanarAbility.PlanarSpecFlag>	getSpecFlags()	Get the special attribute flags for this plane
protected java.lang.String	getStrippedRoomID(java.lang.String roomID)
protected static java.util.List<java.lang.String>	getTransitionPlaneKeys()
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	isPlanarMob(MOB M)	Returns whether the given mob can be planarfied according to the parsed configuration for the current plane.
java.lang.String	listOfPlanes()	Returns a friendly list of all the planes.
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.
void	setHardBumpLevel(int hardBumpLevel)	Modify the xtra difficulty level of this plane
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.
void	setOldRoom(Room oldRoom)	Set the return room when leaving/entering this plane
void	setPlanarLevel(int level)	Change the planar level, hopefully before rooms are generated.
void	setPlanarName(java.lang.String planeName)	Set the plane to use for this planar ability
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 interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

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

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

amDestroyed, destroy, isSavable, setSavable

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

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

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

expirationDate, setExpirationDate

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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.core.interfaces.StatsAffecting

affectCharState

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, displayText, disregardsArmorCheck, enchantQuality, evalTargetItem, expertise, expirationDate, externalFiles, failureTell, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getRawTrainingCost, getSaveStatIndex, getStat, getStatCodes, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTargetItemFavorMOB, getTargetItemFavorMOB, getTargetItemFavorMOB, getTickDownRemaining, getTicksBetweenCasts, getTickStatus, getTimeOfNextCast, getTrainingCost, getVisibleRoomTarget, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, ignoreCompounding, image, iniPracticesToPractice, initializeClass, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, 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

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

getTickStatus

Field Detail

lastCasting

protected volatile long lastCasting

oldRoom

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

planeArea

protected Area planeArea

planeVars

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

roomsDone

protected WeakArrayList<Room> roomsDone

planarLevel

protected int planarLevel

planarName

protected java.lang.String planarName

planarPrefix

protected java.lang.String planarPrefix

promotions

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

categories

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

opposed

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

behavList

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

reffectList

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

factionList

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

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<PlanarAbility.PlanarSpecFlag> specFlags

hardBumpLevel

protected int hardBumpLevel

levelFormula

protected CMath.CompiledFormula levelFormula

recentVisits

protected final java.util.Map<java.lang.String,long[]> recentVisits

hardBumpTimeout

protected static final long hardBumpTimeout

See Also:

Constant Field Values

enableList

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

planeIDNum

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

alwaysRandomArea

protected boolean alwaysRandomArea

Constructor Detail

StdPlanarAbility

public StdPlanarAbility()

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

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

public final Room getOldRoom()

Description copied from interface: PlanarAbility

Get the return room when leaving/entering this plane

Specified by:

getOldRoom in interface PlanarAbility

Returns:

the oldRoom

setOldRoom

public final void setOldRoom(Room oldRoom)

Description copied from interface: PlanarAbility

Set the return room when leaving/entering this plane

Specified by:

setOldRoom in interface PlanarAbility

Parameters:

oldRoom - the oldRoom to set

getPlanarPrefix

public final java.lang.String getPlanarPrefix()

Description copied from interface: PlanarAbility

The chosen-from-a-list prefix to use on mobs in this plane

Specified by:

getPlanarPrefix in interface PlanarAbility

Returns:

the planarPrefix

getHardBumpLevel

public final int getHardBumpLevel()

Description copied from interface: PlanarAbility

The xtra difficulty level of this plane

Specified by:

getHardBumpLevel in interface PlanarAbility

Returns:

the hardBumpLevel

setHardBumpLevel

public final void setHardBumpLevel(int hardBumpLevel)

Description copied from interface: PlanarAbility

Modify the xtra difficulty level of this plane

Specified by:

setHardBumpLevel in interface PlanarAbility

Parameters:

hardBumpLevel - the hardBumpLevel to set

getPlaneVars

public final java.util.Map<java.lang.String,java.lang.String> getPlaneVars()

Description copied from interface: PlanarAbility

Get the key/pair definitions for this plane

Specified by:

getPlaneVars in interface PlanarAbility

Returns:

the planeVars

getPlanarLevel

public final int getPlanarLevel()

Description copied from interface: PlanarAbility

Get the current level of this plane

Specified by:

getPlanarLevel in interface PlanarAbility

Returns:

the planarLevel

setPlanarLevel

public final void setPlanarLevel(int level)

Description copied from interface: PlanarAbility

Change the planar level, hopefully before rooms are generated.

Specified by:

setPlanarLevel in interface PlanarAbility

Parameters:

level - the new planarLevel

getPlanarName

public final java.lang.String getPlanarName()

Description copied from interface: PlanarAbility

Get the name of the current plane

Specified by:

getPlanarName in interface PlanarAbility

Returns:

the planarName

setPlanarName

public void setPlanarName(java.lang.String planeName)

Description copied from interface: PlanarAbility

Set the plane to use for this planar ability

Specified by:

setPlanarName in interface PlanarAbility

Parameters:

planeName - the plane to use

getPromotions

public final PairList<java.lang.Integer,java.lang.String> getPromotions()

Description copied from interface: PlanarAbility

Get the pct change and name of available mob promotions for this plane

Specified by:

getPromotions in interface PlanarAbility

Returns:

the promotions

getCategories

public final java.util.List<java.lang.String> getCategories()

Description copied from interface: PlanarAbility

Get the categories that apply to this plane

Specified by:

getCategories in interface PlanarAbility

Returns:

the categories

getOpposed

public final java.util.List<java.lang.String> getOpposed()

Description copied from interface: PlanarAbility

Get the planes that oppose this plane

Specified by:

getOpposed in interface PlanarAbility

Returns:

the opposed planes

getBehavList

public final PairList<java.lang.String,java.lang.String> getBehavList()

Description copied from interface: PlanarAbility

Get the list of behaviors and parms for this plane

Specified by:

getBehavList in interface PlanarAbility

Returns:

the behavList

getReffectList

public final PairList<java.lang.String,java.lang.String> getReffectList()

Description copied from interface: PlanarAbility

Get the list of room effects and args for this plane

Specified by:

getReffectList in interface PlanarAbility

Returns:

the reffectList

getFactionList

public final PairList<java.lang.String,java.lang.String> getFactionList()

Description copied from interface: PlanarAbility

Get the list of faction ids and values for this plane

Specified by:

getFactionList in interface PlanarAbility

Returns:

the factionList

getBonusDmgStat

public final int getBonusDmgStat()

Description copied from interface: PlanarAbility

Get the CharStat STAT_* ID of the stat that gives bonus damage on this plane

Specified by:

getBonusDmgStat in interface PlanarAbility

Returns:

the bonusDmgStat

getReqWeapons

public final java.util.Set<java.lang.String> getReqWeapons()

Description copied from interface: PlanarAbility

Get the seq of required weapon flags for hurting things in this plane.

Specified by:

getReqWeapons in interface PlanarAbility

Returns:

the reqWeapons

getRecoverRate

public final int getRecoverRate()

Description copied from interface: PlanarAbility

Get the number of extra recover ticks for players on this plane

Specified by:

getRecoverRate in interface PlanarAbility

Returns:

the recoverRate

getFatigueRate

public final int getFatigueRate()

Description copied from interface: PlanarAbility

Get the extra fatigue ticks for players on this plane

Specified by:

getFatigueRate in interface PlanarAbility

Returns:

the fatigueRate

getSpecFlags

public final java.util.Set<PlanarAbility.PlanarSpecFlag> getSpecFlags()

Description copied from interface: PlanarAbility

Get the special attribute flags for this plane

Specified by:

getSpecFlags in interface PlanarAbility

Returns:

the specFlags

getLevelFormula

public final CMath.CompiledFormula getLevelFormula()

Description copied from interface: PlanarAbility

Get the mob/item level adjustment formula for this plane. (at)x1 = base areas median level, (at)x2 = specific mob/item level (at)@x2 = the plane traveling players level

Specified by:

getLevelFormula in interface PlanarAbility

Returns:

the levelFormula

getEnableList

public final PairList<Pair<java.lang.Integer,java.lang.Integer>,PairList<java.lang.String,java.lang.String>> getEnableList()

Description copied from interface: PlanarAbility

Get the bonus ability list for this plane. Clearly, it's complicated.

Specified by:

getEnableList in interface PlanarAbility

Returns:

the enableList

clearVars

public void clearVars()

addOrEditPlane

public java.lang.String addOrEditPlane(java.lang.String planeName,
                                       java.lang.String rule)

Description copied from interface: PlanarAbility

Creates a new, or edits an existing plane. The rule must be the same format as found in planesofexistence.txt, except that it should not start with the plane name in quotes. The result value will start with "ERROR:" if there are one or more errors. Otherwise, it will contains the fields modified or null if the ADD was successful.

Specified by:

addOrEditPlane in interface PlanarAbility

Parameters:

planeName - the plane to add or edit

rule - the new rule definition

Returns:

what was done.

alterPlaneLine

protected boolean alterPlaneLine(java.lang.String planeName,
                                 java.lang.String fileName,
                                 java.lang.String rule)

deletePlane

public boolean deletePlane(java.lang.String planeName)

Description copied from interface: PlanarAbility

Removes a plane of existence, forever.

Specified by:

deletePlane in interface PlanarAbility

Parameters:

planeName - the name of the plane to delete

Returns:

true if the delete was successful, false otherwise

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

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

Description copied from interface: PlanarAbility

Calculates the area effects and behaviors, not including absorb lists, which would affect the planar area.

Specified by:

getAreaEffectsBehavs in interface PlanarAbility

Returns:

the list of abilities and behaviors

reEffect

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

isPlanarMob

public boolean isPlanarMob(MOB M)

Description copied from interface: PlanarAbility

Returns whether the given mob can be planarfied according to the parsed configuration for the current plane.

Specified by:

isPlanarMob in interface PlanarAbility

Parameters:

M - the mob to apply

Returns:

true if the mob can be planarfied

doPlanarRoomColoring

public void doPlanarRoomColoring(Room room)

Description copied from interface: PlanarAbility

Applies the room display and description coloring to the given room according to the rules of this plane.

Specified by:

doPlanarRoomColoring in interface PlanarAbility

Parameters:

room - the room to change permanently.

applyMobPrefix

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

Description copied from interface: PlanarAbility

Applies the prefix and random promotions string to the given mob according to the parsed configuration for the current plane. Also takes an optional eliteBump 1-dimensional array to return the elite level of the mob applies.

Specified by:

applyMobPrefix in interface PlanarAbility

Parameters:

M - the mob to apply

eliteBump - null, or 1-dimensional array with 0

fixRoom

public 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 void 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

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

getAllPlaneKeys

public java.util.List<java.lang.String> getAllPlaneKeys()

Description copied from interface: PlanarAbility

Return the list of all non prime-material planes. These can be use as keys to the planar var maps.

Specified by:

getAllPlaneKeys in interface PlanarAbility

Returns:

the complete list of planes of existence

getTransitionPlaneKeys

protected static java.util.List<java.lang.String> getTransitionPlaneKeys()

listOfPlanes

public java.lang.String listOfPlanes()

Description copied from interface: PlanarAbility

Returns a friendly list of all the planes.

Specified by:

listOfPlanes in interface PlanarAbility

Returns:

a friendly list.

getAllPlanesMap

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getAllPlanesMap()

getPlanarVars

public java.util.Map<java.lang.String,java.lang.String> getPlanarVars(java.lang.String planeName)

Description copied from interface: PlanarAbility

Get the definition for the given plane

Specified by:

getPlanarVars in interface PlanarAbility

Parameters:

planeName - the name of the plane to get definitions for

Returns:

the definitions map

destroyPlane

public void destroyPlane(Area planeA)

Description copied from interface: PlanarAbility

Completely destroyed the given plane of existence, kicking all players inside it back to the starting room they came from.

Specified by:

destroyPlane in interface PlanarAbility

Parameters:

planeA - the plane to destroy.

destroyPlane

protected void destroyPlane()

getStrippedRoomID

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

convertToMyArea

protected java.lang.String convertToMyArea(java.lang.String Name,
                                           java.lang.String roomID)

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

getPlanarAbility

protected PlanarAbility getPlanarAbility(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()

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.