Package com.planet_ink.coffee_mud.MOBS

Class StdDeity

java.lang.Object

com.planet_ink.coffee_mud.MOBS.StdMOB

com.planet_ink.coffee_mud.MOBS.StdDeity

All Implemented Interfaces:

AbilityContainer, Affectable, Behavable, CMObject, Combatant, Contingent, DBIdentifiable, Environmental, Expireable, FactionMember, Followable<MOB>, ItemCollection, ItemPossessor, Modifiable, MsgListener, MUDCmdProcessor, Physical, PhysicalAgent, Rider, StatsAffecting, Tattooable, Tickable, Deity, MOB, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenDeity

public class StdDeity
extends StdMOB
implements Deity

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.Deity

Deity.DeityWorshipper, Deity.HolyEvent, Deity.RitualType

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor

ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

MOB.Attrib

Nested classes/interfaces inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

StdMOB.ApplyAffectCharState<T extends StatsAffecting>, StdMOB.ApplyAffectCharStats<T extends StatsAffecting>, StdMOB.ApplyRecAffectPhyStats<T extends StatsAffecting>

Field Summary

Fields

Modifier and Type	Field	Description
protected PrioritizingLimitedMap<java.lang.String,int[]>	blacklist
protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.DeityPower>	blessings
protected java.lang.String	clericPowerup
protected java.lang.String	clericReqs
protected java.lang.String	clericRitual
protected java.lang.String	clericSin
protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.DeityPower>	curses
protected java.util.Set<java.lang.Integer>	neverTriggers
protected java.util.List<Ability>	powers
protected int	rebukeCheckDown
protected Triggerer	rituals
protected java.lang.String	serviceRitual
protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService>	services
protected java.lang.String	worshipReqs
protected java.lang.String	worshipRitual
protected java.lang.String	worshipSin
protected int	xpwrath

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

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

AGE_MILLIS_THRESHOLD, END_SHEATH_TIME, START_SHEATH_TIME

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.MUDCmdProcessor

METAFLAG_AS, METAFLAG_ASMESSAGE, METAFLAG_FORCED, METAFLAG_INORDER, METAFLAG_MPFORCED, METAFLAG_ORDER, METAFLAG_POSSESSED, METAFLAG_QUIETLY, METAFLAG_REVERSED, METAFLAG_SNOOPED

Fields inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

_name, abilitys, abilityUseCache, abilityUseTrig, affectCharState, affectCharStats, affectPhyStats, affects, ageMinutes, amDead, amDestroyed, amFollowing, atRange, attributesBitmap, baseCharStats, basePhyStats, baseState, behaviors, cachedImageName, charStats, clanAffects, clans, CODES, commandQue, curState, databaseID, description, displayText, experience, expertises, factions, followers, inventory, kickFlag, lastLocation, liegeID, location, maxState, me, miscText, money, moneyVariation, mySession, peaceTime, phyStats, playerStats, possHeldItem, possStartRoom, possWieldedItem, practices, questPoint, racialAffects, rawImageName, recoverAffectP, recoverTickCter, removeFromGame, riding, scripts, soulMate, speedAdj, tattoos, tickAgeCounter, tickStatus, trains, triggerer, validChkCounter, victim, wimpHitPoint, xtraValues

Constructor Summary

Constructors

Constructor	Description
StdDeity()

Method Summary

Modifier and Type	Method	Description
void	addBlessing(Ability to, boolean clericOnly)	Adds a new blessing, which worshippers/clerics can get from performming the appropriate deity ritual.
void	addCurse(Ability to, boolean clericOnly)	Manipulation of curse objects, which includes spells, traits, skills, etc.
void	addPower(Ability to)	Manipulation of curse objects, which includes spells, traits, skills, etc.
boolean	alreadyBlessed(MOB mob)
boolean	alreadyPowered(MOB mob)
protected boolean	alreadyServiced(MOB mob, Room room)
void	bestowBlessing(MOB mob, Ability blessingA)
void	bestowBlessings(MOB mob)
void	bestowCurse(MOB mob, Ability curseA)
void	bestowCurses(MOB mob)
void	bestowPower(MOB mob, Ability Power)
void	bestowPowers(MOB mob)
boolean	cancelService(com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService service)
protected void	cloneFix(MOB E)
void	delBlessing(Ability to)	Deletes the given blessing, which worshippers/clerics can get from performming the appropriate deity ritual.
void	delCurse(Ability to)	Deletes the given curse, which worshippers/clerics can get from performming the appropriate deity "Sin".
void	delPower(Ability to)	Removes the power up ability, which clerics can get from performming the appropriate powerup ritual.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
Ability	fetchBlessing(int index)	Gets the blessing at the given index.
Ability	fetchBlessing(java.lang.String ID)	Returns the blessing the given Ability ID.
boolean	fetchBlessingCleric(int index)	Returns whether the blessing at the given index is only for clerics.
boolean	fetchBlessingCleric(java.lang.String ID)	Returns whether the blessing with the given Ability ID is only for clerics.
Ability	fetchCurse(int index)	Gets the curse at the given index.
Ability	fetchCurse(java.lang.String ID)	Returns the curse the given Ability ID.
boolean	fetchCurseCleric(int index)	Returns whether the curse at the given index is only for clerics.
boolean	fetchCurseCleric(java.lang.String ID)	Returns whether the curse with the given Ability ID is only for clerics.
Ability	fetchPower(int index)	Returns the power up abilities at the given index.
Ability	fetchPower(java.lang.String ID)	Returns the power up abilities with the given Ability ID.
com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService	findService(MOB mob, Room room)
boolean	finishService(MOB mob, Room room)
protected int[]	getBlackmarks(MOB M)
java.lang.String	getClericPowerup()	Gets the raw ritual command string that defines what a cleric must do to receive the Power Up Abilities of this deity.
java.lang.String	getClericPowerupDesc()	Returns the friendly description of the ritual that cleric must do to receive the Power Up Abilities of this deity.
java.lang.String	getClericRequirements()	Gets the Zapper Mask string that defines the requirements to be a Cleric of this Deity.
java.lang.String	getClericRequirementsDesc()	Returns a friendly readable description of the requirements to be a Cleric of this Deity.
java.lang.String	getClericRitual()	Gets the raw ritual command string that defines what a cleric must do to receive the Blessings of this deity.
java.lang.String	getClericSin()	Gets the raw ritual command string that defines what a cleric must do to receive the Curses of this deity.
java.lang.String	getClericSinDesc()	Returns the friendly description of the ritual that cleric must do to receive the Curses of this deity.
java.lang.String	getClericTriggerDesc()	Returns the friendly description of the ritual that cleric must do to receive the Blessings of this deity.
java.lang.String	getServiceRitual()	Gets the raw ritual command string that defines what a cleric must do to complete a Service of this deity.
java.lang.String	getServiceTriggerDesc()	Returns the friendly description of the ritual that cleric must do to perform a service for this deity.
java.lang.String	getWorshipRequirements()	Gets the Zapper Mask string that defines the requirements to be a Worshipper of this Deity.
java.lang.String	getWorshipRequirementsDesc()	Returns a friendly readable description of the requirements to be a Worshipper of this Deity.
java.lang.String	getWorshipRitual()	Gets the raw ritual command string that defines what a worshipper must do to receive the Blessings of this deity.
java.lang.String	getWorshipSin()	Gets the raw ritual command string that defines what a worshipper must do to receive the Curses of this deity.
java.lang.String	getWorshipSinDesc()	Returns the friendly description of the ritual that worshipper must do to receive the Curses of this deity.
java.lang.String	getWorshipTriggerDesc()	Returns the friendly description of the ritual that worshipper must do to receive the Blessings of this deity.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
CMObject	newInstance()	Returns a new instance of this class.
int	numBlessings()	Returns the total number of blessings, both cleric and worshipper.
int	numCurses()	Returns the total number of curses, both cleric and worshipper.
int	numPowers()	Returns the number of power up abilities, which clerics get from performing the appropriate powerup ritual.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
void	recoverCharStats()	Causes this mob to recalculate its current char stats by copying the base stats over and then calling all equipment and spell effects to modify them.
void	removeBlessings(MOB mob)
void	removePowers(MOB mob)
void	setClericPowerup(java.lang.String ritual)	Sets the raw ritual command string that defines what a cleric must do to receive the Power Up Abilities of this deity.
void	setClericRequirements(java.lang.String reqs)	Sets the Zapper Mask string that defines the requirements to be a Cleric of this Deity.
void	setClericRitual(java.lang.String ritual)	Sets the raw ritual command string that defines what a cleric must do to receive the Blessings of this deity.
void	setClericSin(java.lang.String ritual)	Sets the raw ritual command string that defines what a cleric must do to receive the Curses of this deity.
void	setName(java.lang.String name)	Sets the raw unmodified name of this object as stored in the database.
protected void	setRitual(Deity.RitualType type, java.lang.String ritual)
void	setServiceRitual(java.lang.String ritual)	Sets the raw ritual command string that defines what a cleric must do to complete a Service of this deity.
void	setWorshipRequirements(java.lang.String reqs)	Sets the Zapper Mask string that defines the requirements to be a Worshipper of this Deity.
void	setWorshipRitual(java.lang.String ritual)	Sets the raw ritual command string that defines what a worshipper must do to receive the Blessings of this deity.
void	setWorshipSin(java.lang.String ritual)	Sets the raw ritual command string that defines what a worshipper must do to receive the Curses of this deity.
protected void	startServiceIfNecessary(MOB mob, Room room)
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
protected void	undoService(java.util.List<MOB> V)

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

abilities, addAbility, allAbilities, delAbility, delAllAbilities, fetchAbility, fetchAbility, fetchRandomAbility, numAbilities, numAllAbilities

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

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

copyOf, initializeClass

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

amDead, getCombatant, getDirectionToTarget, healthText, isInCombat, killMeDead, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setCombatant, setRangeToTarget

Methods inherited from interface java.lang.Comparable

compareTo

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

canSaveDatabaseID, databaseID, setDatabaseID

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

addFaction, adjustFaction, copyFactions, factions, fetchFaction, fetchFactionData, fetchFactionRanges, getFactionListing, hasFaction, removeFaction

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

addFollower, amFollowing, amUltimatelyFollowing, delFollower, fetchFollower, fetchFollower, fetchFollowerOrder, followers, getGroupMembers, getGroupMembersAndRideables, isFollowedBy, numFollowers, setFollowing, totalFollowers

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

addItem, delAllItems, delItem, eachItem, findItem, findItem, findItems, findItems, getItem, getRandomItem, isContent, items, numItems

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

addItem, getContextName, moveItemTo, moveItemTo

Methods inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

addExpertise, addPriorityEffect, amActive, baseCharStats, baseState, baseWeight, bringToLife, bringToLife, charStats, clans, curState, delAllExpertises, delExpertise, dispossess, expertises, fetchExpertise, fetchFirstWornItem, fetchHeldItem, fetchItem, fetchWieldedItem, fetchWornItems, findAbility, flagVariableEq, freeWearPositions, getAbilityUsageCache, getAgeMinutes, getAttributesBitmap, getClanRole, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getLiegeID, getMoney, getMoneyVariation, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getRideBuddies, getStartRoom, getTrains, getVictim, getWearPositions, getWimpHitPoint, hasOnlyGoldInInventory, isAttributeSet, isMarriedToLiege, isMine, isMonster, isPlayer, isPossessing, isRacialAbility, lastTickedDateTime, location, maxCarry, maxFollowers, maxItems, maxState, numAllEffects, personalEffects, playerStats, recoverMaxState, removeFromGame, resetToMaxState, session, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBaseState, setClan, setExperience, setLiegeID, setLocation, setMoney, setMoneyVariation, setPlayerStats, setPractices, setQuestPoint, setSession, setSoulMate, setStartRoom, setTrains, setTriggerer, setVictim, setWimpHitPoint, soulMate, tell, tell, titledName, titledName, triggerer, willFollowOrdersOf

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

actions, clearCommandQueue, commandQueSize, dequeCommand, doCommand, enqueCommand, enqueCommands, getTopCommand, prequeCommand, prequeCommands, setActions

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

riding, setRiding

Methods inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

abilities, actions, addAbility, addBehavior, addEffect, addExpertise, addFaction, addFollower, addItem, addItem, addNonUninvokableEffect, addPriorityEffect, addScript, addTattoo, addTattoo, addTattoo, adjustFaction, affectCharState, affectCharStats, affectPhyStats, allAbilities, amActive, amDead, amDestroyed, amFollowing, amUltimatelyFollowing, baseCharStats, basePhyStats, baseState, baseWeight, behaviors, bringToLife, bringToLife, calculateActionCost, canSaveDatabaseID, charStats, checkCommandCancel, clanEffects, clans, clearCommandQueue, commandQueSize, compareTo, confirmLocation, copyFactions, copyOf, counItemsWornAt, curState, databaseID, delAbility, delAllAbilities, delAllBehaviors, delAllEffects, delAllExpertises, delAllItems, delAllScripts, delBehavior, delEffect, delExpertise, delFollower, delItem, delScript, delTattoo, delTattoo, dequeCommand, description, description, destroy, displayText, displayText, dispossess, doCommand, doCommand, eachBehavior, eachEffect, eachItem, eachScript, effects, enqueCommand, enqueCommands, expertises, expirationDate, factions, fetchAbility, fetchAbility, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchExpertise, fetchFaction, fetchFactionData, fetchFactionRanges, fetchFirstWornItem, fetchFollower, fetchFollower, fetchFollowerOrder, fetchFromInventory, fetchHeldItem, fetchItem, fetchRandomAbility, fetchScript, fetchWieldedItem, fetchWornItems, findAbility, findItem, findItem, findItems, findItems, findTattoo, findTattooStartsWith, fixChannelColors, flagVariableEq, followers, freeWearPositions, genericName, getAbilityUsageCache, getAgeMinutes, getAttributesBitmap, getClanRole, getCodeNum, getCombatant, getContextName, getDirectionToTarget, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getFactionListing, getGroupMembers, getGroupMembersAndRideables, getItem, getLiegeID, getMoney, getMoneyVariation, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getRandomItem, getRideBuddies, getSaveStatIndex, getStartRoom, getStat, getStatCodes, getTickStatus, getTopCommand, getTrains, getVictim, getWearPositions, getWimpHitPoint, hasFaction, hasOnlyGoldInInventory, healthText, image, initializeClass, isAttributeSet, isContent, isEitherOfUsDead, isFollowedBy, isGeneric, isInCombat, isMarriedToLiege, isMine, isMonster, isPermissableToFight, isPlayer, isPossessing, isRacialAbility, isSavable, isStat, items, killMeDead, L, lastTickedDateTime, location, makePeace, maxCarry, maxFollowers, maxItems, maxRange, maxState, mayIFight, mayPhysicallyAttack, minRange, miscTextFormat, moveItemTo, moveItemTo, name, name, Name, numAbilities, numAllAbilities, numAllEffects, numBehaviors, numEffects, numFollowers, numItems, numScripts, personalEffects, phyStats, playerStats, prequeCommand, prequeCommands, racialEffects, rangeToTarget, rawImage, recoverMaxState, recoverPhyStats, removeFaction, removeFromGame, resetToMaxState, riding, sameAs, scripts, session, setActions, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBasePhyStats, setBaseState, setClan, setCombatant, setDatabaseID, setDescription, setDestroyed, setDisplayText, setExperience, setExpirationDate, setFollowing, setImage, setLiegeID, setLocation, setMiscText, setMoney, setMoneyVariation, setPlayerStats, setPractices, setQuestPoint, setRangeToTarget, setRiding, setSavable, setSession, setSoulMate, setStartRoom, setStat, setTrains, setTriggerer, setVictim, setWimpHitPoint, soulMate, tattoos, tell, tell, text, titledName, titledName, totalFollowers, triggerer, willFollowOrdersOf

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

addTattoo, addTattoo, addTattoo, delTattoo, delTattoo, findTattoo, findTattooStartsWith, tattoos

Field Detail

xpwrath

protected int xpwrath

clericReqs

protected java.lang.String clericReqs

worshipReqs

protected java.lang.String worshipReqs

serviceRitual

protected java.lang.String serviceRitual

clericRitual

protected java.lang.String clericRitual

clericSin

protected java.lang.String clericSin

clericPowerup

protected java.lang.String clericPowerup

worshipRitual

protected java.lang.String worshipRitual

worshipSin

protected java.lang.String worshipSin

rebukeCheckDown

protected int rebukeCheckDown

blacklist

protected final PrioritizingLimitedMap<java.lang.String,int[]> blacklist

rituals

protected Triggerer rituals

services

protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService> services

blessings

protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.DeityPower> blessings

curses

protected java.util.List<com.planet_ink.coffee_mud.MOBS.StdDeity.DeityPower> curses

powers

protected java.util.List<Ability> powers

neverTriggers

protected final java.util.Set<java.lang.Integer> neverTriggers

Constructor Detail

StdDeity

public StdDeity()

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 StdMOB

Returns:

the name of this class

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Overrides:

newInstance in class StdMOB

Returns:

a new instance of this class

cloneFix

protected void cloneFix(MOB E)

Overrides:

cloneFix in class StdMOB

getClericRequirements

public java.lang.String getClericRequirements()

Description copied from interface: Deity

Gets the Zapper Mask string that defines the requirements to be a Cleric of this Deity. See help on ZAPPERMASK

Specified by:

getClericRequirements in interface Deity

Returns:

the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, Deity.setClericRequirements(String), Deity.getClericRequirementsDesc()

setClericRequirements

public void setClericRequirements(java.lang.String reqs)

Description copied from interface: Deity

Sets the Zapper Mask string that defines the requirements to be a Cleric of this Deity. See help on ZAPPERMASK

Specified by:

setClericRequirements in interface Deity

Parameters:

reqs - the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, Deity.getClericRequirements(), Deity.getClericRequirementsDesc()

getWorshipRequirements

public java.lang.String getWorshipRequirements()

Description copied from interface: Deity

Gets the Zapper Mask string that defines the requirements to be a Worshipper of this Deity. See help on ZAPPERMASK

Specified by:

getWorshipRequirements in interface Deity

Returns:

the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, Deity.setWorshipRequirements(String), Deity.getWorshipRequirementsDesc()

setWorshipRequirements

public void setWorshipRequirements(java.lang.String reqs)

Description copied from interface: Deity

Sets the Zapper Mask string that defines the requirements to be a Worshipper of this Deity. See help on ZAPPERMASK

Specified by:

setWorshipRequirements in interface Deity

Parameters:

reqs - the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, Deity.getWorshipRequirements(), Deity.getWorshipRequirementsDesc()

getClericRitual

public java.lang.String getClericRitual()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a cleric must do to receive the Blessings of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

getClericRitual in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.setClericRitual(String), Deity.getClericTriggerDesc(), Triggerer

setRitual

protected void setRitual(Deity.RitualType type,
                         java.lang.String ritual)

setClericRitual

public void setClericRitual(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a cleric must do to receive the Blessings of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

setClericRitual in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.getClericRitual(), Deity.getClericTriggerDesc(), Triggerer

setName

public void setName(java.lang.String name)

Description copied from interface: Environmental

Sets the raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

setName in interface Environmental

Overrides:

setName in class StdMOB

Parameters:

name - the raw base name of this object on the map.

See Also:

Environmental.Name()

getWorshipRitual

public java.lang.String getWorshipRitual()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a worshipper must do to receive the Blessings of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

getWorshipRitual in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.setWorshipRitual(String), Deity.getWorshipTriggerDesc(), Triggerer

setWorshipRitual

public void setWorshipRitual(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a worshipper must do to receive the Blessings of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

setWorshipRitual in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.getWorshipRitual(), Deity.getWorshipTriggerDesc(), Triggerer

getServiceRitual

public java.lang.String getServiceRitual()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a cleric must do to complete a Service of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by &.

Specified by:

getServiceRitual in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.setServiceRitual(String), Deity.getServiceTriggerDesc(), Triggerer

setServiceRitual

public void setServiceRitual(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a cleric must do to complete a Service of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by &.

Specified by:

setServiceRitual in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchBlessing(String), Deity.getServiceRitual(), Deity.getServiceTriggerDesc(), Triggerer

getClericRequirementsDesc

public java.lang.String getClericRequirementsDesc()

Description copied from interface: Deity

Returns a friendly readable description of the requirements to be a Cleric of this Deity.

Specified by:

getClericRequirementsDesc in interface Deity

Returns:

a friendly readable description of the requirements

See Also:

Deity.setClericRequirements(String), Deity.getClericRequirements()

getClericTriggerDesc

public java.lang.String getClericTriggerDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that cleric must do to receive the Blessings of this deity.

Specified by:

getClericTriggerDesc in interface Deity

Returns:

a description of the blessing ritual for clerics

See Also:

Deity, Deity.fetchBlessing(String), Deity.getClericRitual(), Deity.setClericRitual(String), Triggerer

getWorshipRequirementsDesc

public java.lang.String getWorshipRequirementsDesc()

Description copied from interface: Deity

Returns a friendly readable description of the requirements to be a Worshipper of this Deity.

Specified by:

getWorshipRequirementsDesc in interface Deity

Returns:

a friendly readable description of the requirements

See Also:

Deity.setWorshipRequirements(String), Deity.getWorshipRequirements()

getWorshipTriggerDesc

public java.lang.String getWorshipTriggerDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that worshipper must do to receive the Blessings of this deity.

Specified by:

getWorshipTriggerDesc in interface Deity

Returns:

a description of the blessing ritual for worshippers

See Also:

Deity, Deity.fetchBlessing(String), Deity.getWorshipRitual(), Deity.setWorshipRitual(String), Triggerer

getServiceTriggerDesc

public java.lang.String getServiceTriggerDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that cleric must do to perform a service for this deity.

Specified by:

getServiceTriggerDesc in interface Deity

Returns:

a description of the service ritual for clerics

See Also:

Deity, Deity.fetchBlessing(String), Deity.getServiceRitual(), Deity.setServiceRitual(String), Triggerer

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 StdMOB

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

bestowBlessing

public void bestowBlessing(MOB mob,
                           Ability blessingA)

bestowPower

public void bestowPower(MOB mob,
                        Ability Power)

bestowCurse

public void bestowCurse(MOB mob,
                        Ability curseA)

bestowBlessings

public void bestowBlessings(MOB mob)

bestowPowers

public void bestowPowers(MOB mob)

bestowCurses

public void bestowCurses(MOB mob)

removeBlessings

public void removeBlessings(MOB mob)

removePowers

public void removePowers(MOB mob)

alreadyBlessed

public boolean alreadyBlessed(MOB mob)

alreadyPowered

public boolean alreadyPowered(MOB mob)

recoverCharStats

public void recoverCharStats()

Description copied from interface: MOB

Causes this mob to recalculate its current char stats by copying the base stats over and then calling all equipment and spell effects to modify them.

Specified by:

recoverCharStats in interface MOB

Overrides:

recoverCharStats in class StdMOB

See Also:

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

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 StdMOB

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

startServiceIfNecessary

protected void startServiceIfNecessary(MOB mob,
                                       Room room)

undoService

protected void undoService(java.util.List<MOB> V)

alreadyServiced

protected boolean alreadyServiced(MOB mob,
                                  Room room)

findService

public com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService findService(MOB mob,
                                                                          Room room)

finishService

public boolean finishService(MOB mob,
                             Room room)

cancelService

public boolean cancelService(com.planet_ink.coffee_mud.MOBS.StdDeity.WorshipService service)

getBlackmarks

protected int[] getBlackmarks(MOB M)

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 StdMOB

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

addBlessing

public void addBlessing(Ability to,
                        boolean clericOnly)

Description copied from interface: Deity

Adds a new blessing, which worshippers/clerics can get from performming the appropriate deity ritual. The blessing can also be designated as only for clerics, or for both clerics and worshippers.

Specified by:

addBlessing in interface Deity

Parameters:

to - the blessing ability object

clericOnly - true if its only for clerics, false if for everyone

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.delBlessing(Ability), Deity.numBlessings(), Deity.fetchBlessing(String), Deity.fetchBlessingCleric(int), Deity.fetchBlessing(int)

delBlessing

public void delBlessing(Ability to)

Description copied from interface: Deity

Deletes the given blessing, which worshippers/clerics can get from performming the appropriate deity ritual.

Specified by:

delBlessing in interface Deity

Parameters:

to - the blessing ability object

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.numBlessings(), Deity.fetchBlessing(String), Deity.fetchBlessingCleric(int), Deity.fetchBlessing(int)

numBlessings

public int numBlessings()

Description copied from interface: Deity

Returns the total number of blessings, both cleric and worshipper. Blessings are spells cast on worshippers or clerics by the deity for performing an appropriate ritual.

Specified by:

numBlessings in interface Deity

Returns:

the total number of blessings, both cleric and worshipper.

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.delBlessing(Ability), Deity.fetchBlessing(String), Deity.fetchBlessingCleric(int), Deity.fetchBlessing(int)

fetchBlessing

public Ability fetchBlessing(int index)

Description copied from interface: Deity

Gets the blessing at the given index. Blessings are spells cast on worshippers or clerics by the deity for performing an appropriate ritual.

Specified by:

fetchBlessing in interface Deity

Parameters:

index - the index of the blessing to return info about

Returns:

the blessing ability object at the given index

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.delBlessing(Ability), Deity.fetchBlessing(String), Deity.fetchBlessingCleric(int), Deity.numBlessings()

fetchBlessingCleric

public boolean fetchBlessingCleric(int index)

Description copied from interface: Deity

Returns whether the blessing at the given index is only for clerics. Blessings are spells cast on worshippers or clerics by the deity for performing an appropriate ritual.

Specified by:

fetchBlessingCleric in interface Deity

Parameters:

index - the index of the blessing to return info about

Returns:

true if the blessing at this index is only for clerics

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.delBlessing(Ability), Deity.fetchBlessing(String), Deity.fetchBlessing(int), Deity.fetchBlessingCleric(String), Deity.numBlessings()

fetchBlessingCleric

public boolean fetchBlessingCleric(java.lang.String ID)

Description copied from interface: Deity

Returns whether the blessing with the given Ability ID is only for clerics. Blessings are spells cast on worshippers or clerics by the deity for performing an appropriate ritual.

Specified by:

fetchBlessingCleric in interface Deity

Parameters:

ID - the ability id of the blessing to return info about

Returns:

true if the blessing with that ID is only for clerics

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.delBlessing(Ability), Deity.fetchBlessing(String), Deity.fetchBlessing(int), Deity.fetchBlessingCleric(int), Deity.numBlessings()

fetchBlessing

public Ability fetchBlessing(java.lang.String ID)

Description copied from interface: Deity

Returns the blessing the given Ability ID. Blessings are spells cast on worshippers or clerics by the deity for performing an appropriate ritual.

Specified by:

fetchBlessing in interface Deity

Parameters:

ID - the Ability ID of the blessing to return info about

Returns:

the blessing ability object with the given ID

See Also:

Deity.getClericRitual(), Deity.getWorshipRitual(), Deity.addBlessing(Ability, boolean), Deity.delBlessing(Ability), Deity.fetchBlessing(int), Deity.fetchBlessingCleric(int), Deity.numBlessings()

addCurse

public void addCurse(Ability to,
                     boolean clericOnly)

Manipulation of curse objects, which includes spells, traits, skills, etc.

Specified by:

addCurse in interface Deity

Parameters:

to - the curse ability object

clericOnly - true if its only for clerics, false if for everyone

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.delCurse(Ability), Deity.numCurses(), Deity.fetchCurse(String), Deity.fetchCurseCleric(int), Deity.fetchCurse(int)

delCurse

public void delCurse(Ability to)

Description copied from interface: Deity

Deletes the given curse, which worshippers/clerics can get from performming the appropriate deity "Sin".

Specified by:

delCurse in interface Deity

Parameters:

to - the curse ability object

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.numCurses(), Deity.fetchCurse(String), Deity.fetchCurseCleric(int), Deity.fetchCurse(int)

numCurses

public int numCurses()

Description copied from interface: Deity

Returns the total number of curses, both cleric and worshipper. Curses are spells cast on worshippers or clerics by the deity for performing an appropriate "Sin".

Specified by:

numCurses in interface Deity

Returns:

the total number of curses, both cleric and worshipper.

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.delCurse(Ability), Deity.fetchCurse(String), Deity.fetchCurseCleric(int), Deity.fetchCurse(int)

fetchCurse

public Ability fetchCurse(int index)

Description copied from interface: Deity

Gets the curse at the given index. Curses are spells cast on worshippers or clerics by the deity for performing an appropriate "Sin".

Specified by:

fetchCurse in interface Deity

Parameters:

index - the index of the curse to return info about

Returns:

the curse ability object at the given index

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.delCurse(Ability), Deity.fetchCurse(String), Deity.fetchCurseCleric(int), Deity.numCurses()

fetchCurse

public Ability fetchCurse(java.lang.String ID)

Description copied from interface: Deity

Returns the curse the given Ability ID. Curses are spells cast on worshippers or clerics by the deity for performing an appropriate "Sin".

Specified by:

fetchCurse in interface Deity

Parameters:

ID - the Ability ID of the curse to return info about

Returns:

the curse ability object with the given ID

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.delCurse(Ability), Deity.fetchCurse(int), Deity.fetchCurseCleric(int), Deity.numCurses()

fetchCurseCleric

public boolean fetchCurseCleric(int index)

Description copied from interface: Deity

Returns whether the curse at the given index is only for clerics. Curses are spells cast on worshippers or clerics by the deity for performing an appropriate "Sin".

Specified by:

fetchCurseCleric in interface Deity

Parameters:

index - the index of the curse to return info about

Returns:

true if the curse at this index is only for clerics

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.delCurse(Ability), Deity.fetchCurse(String), Deity.fetchCurse(int), Deity.fetchCurseCleric(String), Deity.numCurses()

fetchCurseCleric

public boolean fetchCurseCleric(java.lang.String ID)

Description copied from interface: Deity

Returns whether the curse with the given Ability ID is only for clerics. Curses are spells cast on worshippers or clerics by the deity for performing an appropriate "Sin".

Specified by:

fetchCurseCleric in interface Deity

Parameters:

ID - the ability id of the curse to return info about

Returns:

true if the curse with that ID is only for clerics

See Also:

Deity.getClericSin(), Deity.getWorshipSin(), Deity.addCurse(Ability, boolean), Deity.delCurse(Ability), Deity.fetchCurse(String), Deity.fetchCurse(int), Deity.fetchCurseCleric(int), Deity.numCurses()

getClericSin

public java.lang.String getClericSin()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a cleric must do to receive the Curses of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

getClericSin in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchCurse(String), Deity.setClericSin(String), Deity.getClericSinDesc(), Triggerer

setClericSin

public void setClericSin(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a cleric must do to receive the Curses of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

setClericSin in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchCurse(String), Deity.getClericSin(), Deity.getClericSinDesc(), Triggerer

getClericSinDesc

public java.lang.String getClericSinDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that cleric must do to receive the Curses of this deity.

Specified by:

getClericSinDesc in interface Deity

Returns:

a description of the cursing ritual for clerics

See Also:

Deity, Deity.fetchCurse(String), Deity.getClericSin(), Deity.setClericSin(String), Triggerer

getWorshipSin

public java.lang.String getWorshipSin()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a worshipper must do to receive the Curses of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

getWorshipSin in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchCurse(String), Deity.setWorshipSin(String), Deity.getWorshipSinDesc(), Triggerer

setWorshipSin

public void setWorshipSin(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a worshipper must do to receive the Curses of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

setWorshipSin in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchCurse(String), Deity.getWorshipSin(), Deity.getWorshipSinDesc(), Triggerer

getWorshipSinDesc

public java.lang.String getWorshipSinDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that worshipper must do to receive the Curses of this deity.

Specified by:

getWorshipSinDesc in interface Deity

Returns:

a description of the cursing ritual for worshippers

See Also:

Deity, Deity.fetchCurse(String), Deity.getWorshipSin(), Deity.setWorshipSin(String), Triggerer

addPower

public void addPower(Ability to)

Manipulation of curse objects, which includes spells, traits, skills, etc.

Specified by:

addPower in interface Deity

Parameters:

to - the power up ability object

See Also:

Deity.getClericPowerup(), Deity.delPower(Ability), Deity.numPowers(), Deity.fetchPower(String), Deity.fetchPower(int)

delPower

public void delPower(Ability to)

Description copied from interface: Deity

Removes the power up ability, which clerics can get from performming the appropriate powerup ritual.

Specified by:

delPower in interface Deity

Parameters:

to - the power up ability object to remove

See Also:

Deity.getClericPowerup(), Deity.addPower(Ability), Deity.numPowers(), Deity.fetchPower(String), Deity.fetchPower(int)

numPowers

public int numPowers()

Description copied from interface: Deity

Returns the number of power up abilities, which clerics get from performing the appropriate powerup ritual.

Specified by:

numPowers in interface Deity

Returns:

the number of power up abilities

See Also:

Deity.getClericPowerup(), Deity.addPower(Ability), Deity.delPower(Ability), Deity.fetchPower(String), Deity.fetchPower(int)

fetchPower

public Ability fetchPower(int index)

Description copied from interface: Deity

Returns the power up abilities at the given index. Power up abilities are Abilities which clerics get from performing the appropriate powerup ritual.

Specified by:

fetchPower in interface Deity

Parameters:

index - the index of the Ability to return

Returns:

the power up Ability object at that index

See Also:

Deity.getClericPowerup(), Deity.addPower(Ability), Deity.delPower(Ability), Deity.fetchPower(String), Deity.numPowers()

fetchPower

public Ability fetchPower(java.lang.String ID)

Description copied from interface: Deity

Returns the power up abilities with the given Ability ID. Power up abilities are Abilities which clerics get from performing the appropriate powerup ritual.

Specified by:

fetchPower in interface Deity

Parameters:

ID - the Ability ID of the Ability to return

Returns:

the power up Ability object with the Ability ID

See Also:

Deity.getClericPowerup(), Deity.addPower(Ability), Deity.delPower(Ability), Deity.fetchPower(String), Deity.numPowers()

getClericPowerup

public java.lang.String getClericPowerup()

Description copied from interface: Deity

Gets the raw ritual command string that defines what a cleric must do to receive the Power Up Abilities of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

getClericPowerup in interface Deity

Returns:

the coded ritual command string

See Also:

Deity, Deity.fetchPower(String), Deity.setClericPowerup(String), Deity.getClericPowerupDesc(), Triggerer

setClericPowerup

public void setClericPowerup(java.lang.String ritual)

Description copied from interface: Deity

Sets the raw ritual command string that defines what a cleric must do to receive the Power Up Abilities of this deity. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by & or | to denote AND or OR.

Specified by:

setClericPowerup in interface Deity

Parameters:

ritual - the coded ritual command string

See Also:

Deity, Deity.fetchPower(String), Deity.getClericPowerup(), Deity.getClericPowerupDesc(), Triggerer

getClericPowerupDesc

public java.lang.String getClericPowerupDesc()

Description copied from interface: Deity

Returns the friendly description of the ritual that cleric must do to receive the Power Up Abilities of this deity.

Specified by:

getClericPowerupDesc in interface Deity

Returns:

a description of the power up ritual for clerics

See Also:

Deity, Deity.fetchPower(String), Deity.getClericPowerup(), Deity.setClericPowerup(String), Triggerer