Package com.planet_ink.coffee_mud.Abilities.interfaces

Interface PlanarAbility

All Superinterfaces:

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

All Known Implementing Classes:

Chant_PlaneWalking, Prayer_PlanarTravel, Spell_Planeshift, StdPlanarAbility

public interface PlanarAbility
extends Ability

This interface denotes an ability governs the behavior of another plane of existence, how its data is stored and retreived, how the mobs and items and rooms appear and behave inside.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PlanarAbility.PlanarSpecFlag	The special attribute flags for planes
static class	PlanarAbility.PlanarVar	The definitions variables for the attributes of each plane

Field Summary

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	addOrEditPlane(java.lang.String planeName, java.lang.String rule)	Creates a new, or edits an existing plane.
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.
boolean	deletePlane(java.lang.String planeName)	Removes a plane of existence, forever.
void	destroyPlane(Area planeA)	Completely destroyed the given plane of existence, kicking all players inside it back to the starting room they came from.
void	doPlanarRoomColoring(Room room)	Applies the room display and description coloring to the given room according to the rules of this plane.
java.util.List<java.lang.String>	getAllPlaneKeys()	Return the list of all non prime-material planes.
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
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
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.
void	setHardBumpLevel(int hardBumpLevel)	Modify the xtra difficulty level of this plane
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

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

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

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

copyOf, ID, 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, setMiscText, 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 interface com.planet_ink.coffee_mud.core.interfaces.MsgListener

executeMsg, okMessage

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

getTickStatus, name, tick

Method Detail

getPlanarName

java.lang.String getPlanarName()

Get the name of the current plane

Returns:

the planarName

setPlanarName

void setPlanarName(java.lang.String planeName)

Set the plane to use for this planar ability

Parameters:

planeName - the plane to use

getPlanarLevel

int getPlanarLevel()

Get the current level of this plane

Returns:

the planarLevel

setPlanarLevel

void setPlanarLevel(int level)

Change the planar level, hopefully before rooms are generated.

Parameters:

level - the level to change to.

getOldRoom

Room getOldRoom()

Get the return room when leaving/entering this plane

Returns:

the oldRoom

setOldRoom

void setOldRoom(Room oldRoom)

Set the return room when leaving/entering this plane

Parameters:

oldRoom - the oldRoom to set

getPlanarPrefix

java.lang.String getPlanarPrefix()

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

Returns:

the planarPrefix

doPlanarRoomColoring

void doPlanarRoomColoring(Room room)

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

Parameters:

room - the room to change permanently.

applyMobPrefix

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. Also takes an optional eliteBump 1-dimensional array to return the elite level of the mob applies.

Parameters:

M - the mob to apply

eliteBump - null, or 1-dimensional array with 0

isPlanarMob

boolean isPlanarMob(MOB M)

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

Parameters:

M - the mob to apply

Returns:

true if the mob can be planarfied

getHardBumpLevel

int getHardBumpLevel()

The xtra difficulty level of this plane

Returns:

the hardBumpLevel

setHardBumpLevel

void setHardBumpLevel(int hardBumpLevel)

Modify the xtra difficulty level of this plane

Parameters:

hardBumpLevel - the hardBumpLevel to set

getPlaneVars

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

Get the key/pair definitions for this plane

Returns:

the planeVars

addOrEditPlane

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

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.

Parameters:

planeName - the plane to add or edit

rule - the new rule definition

Returns:

what was done.

deletePlane

boolean deletePlane(java.lang.String planeName)

Removes a plane of existence, forever.

Parameters:

planeName - the name of the plane to delete

Returns:

true if the delete was successful, false otherwise

getPromotions

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

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

Returns:

the promotions

getCategories

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

Get the categories that apply to this plane

Returns:

the categories

getOpposed

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

Get the planes that oppose this plane

Returns:

the opposed planes

getBehavList

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

Get the list of behaviors and parms for this plane

Returns:

the behavList

getReffectList

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

Get the list of room effects and args for this plane

Returns:

the reffectList

getFactionList

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

Get the list of faction ids and values for this plane

Returns:

the factionList

getAreaEffectsBehavs

java.util.List<CMObject> getAreaEffectsBehavs()

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

Returns:

the list of abilities and behaviors

getBonusDmgStat

int getBonusDmgStat()

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

Returns:

the bonusDmgStat

getReqWeapons

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

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

Returns:

the reqWeapons

getRecoverRate

int getRecoverRate()

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

Returns:

the recoverRate

getFatigueRate

int getFatigueRate()

Get the extra fatigue ticks for players on this plane

Returns:

the fatigueRate

getSpecFlags

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

Get the special attribute flags for this plane

Returns:

the specFlags

getLevelFormula

CMath.CompiledFormula getLevelFormula()

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

Returns:

the levelFormula

getEnableList

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

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

Returns:

the enableList

getPlanarVars

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

Get the definition for the given plane

Parameters:

planeName - the name of the plane to get definitions for

Returns:

the definitions map

getAllPlaneKeys

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

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

Returns:

the complete list of planes of existence

listOfPlanes

java.lang.String listOfPlanes()

Returns a friendly list of all the planes.

Returns:

a friendly list.

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.

Parameters:

planeA - the plane to destroy.