com.planet_ink.coffee_mud.MOBS.interfaces
Interface Deity

All Superinterfaces:

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

All Known Implementing Classes:

GenDeity, StdDeity

public interface Deity
extends MOB

A Deity is a type of mob that provides benefits (and punishments) for players that worship them, especially Clerics. They also provide for mini-mini quests (called rituals or sins) for obtaining the benefits or punishments, as well as mini-mini quests for clerics to do services. This interface defines the language for specifying the rituals, as well as the methods for accessing them and their benefits and detriments.

Nested Class Summary

static class	Deity.RitualConnector Separator enum constants for ritual definitions.
static class	Deity.RitualTrigger The definition of the key words in the ritual definitions.

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

MOB.Attrib

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

ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move

Field Summary

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_SNOOPED

Method Summary

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) Adds a new curse, which worshippers/clerics can get from performming the appropriate deity "Sin".
void	addPower(Ability to) Adds a new power up ability, which clerics can get from performming the appropriate powerup ritual.
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.
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.
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.
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.
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	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.

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

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

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

riding, setRiding

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

addItem, moveItemTo, moveItemTo

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

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

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

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

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

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

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

getCombatant, getDirectionToTarget, isInCombat, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setCombatant, setRangeToTarget

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

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

Method Detail

getClericRequirements

java.lang.String getClericRequirements()

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

Returns:

the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, setClericRequirements(String), getClericRequirementsDesc()

setClericRequirements

void setClericRequirements(java.lang.String reqs)

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

Parameters:

reqs - the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, getClericRequirements(), getClericRequirementsDesc()

getClericRequirementsDesc

java.lang.String getClericRequirementsDesc()

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

Returns:

a friendly readable description of the requirements

See Also:

setClericRequirements(String), getClericRequirements()

getWorshipRequirements

java.lang.String getWorshipRequirements()

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

Returns:

the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, setWorshipRequirements(String), getWorshipRequirementsDesc()

setWorshipRequirements

void setWorshipRequirements(java.lang.String reqs)

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

Parameters:

reqs - the Zapper Mask string that defines the requirements

See Also:

MaskingLibrary, getWorshipRequirements(), getWorshipRequirementsDesc()

getWorshipRequirementsDesc

java.lang.String getWorshipRequirementsDesc()

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

Returns:

a friendly readable description of the requirements

See Also:

setWorshipRequirements(String), getWorshipRequirements()

addBlessing

void addBlessing(Ability to,
                 boolean clericOnly)

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.

Parameters:

to - the blessing ability object

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

See Also:

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

delBlessing

void delBlessing(Ability to)

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

Parameters:

to - the blessing ability object

See Also:

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

numBlessings

int numBlessings()

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.

Returns:

the total number of blessings, both cleric and worshipper.

See Also:

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

fetchBlessing

Ability fetchBlessing(int index)

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

Parameters:

index - the index of the blessing to return info about

Returns:

the blessing ability object at the given index

See Also:

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

fetchBlessing

Ability fetchBlessing(java.lang.String ID)

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

Parameters:

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

Returns:

the blessing ability object with the given ID

See Also:

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

fetchBlessingCleric

boolean fetchBlessingCleric(int index)

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.

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:

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

fetchBlessingCleric

boolean fetchBlessingCleric(java.lang.String ID)

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.

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:

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

getClericRitual

java.lang.String getClericRitual()

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.

Returns:

the coded ritual command string

See Also:

Deity, fetchBlessing(String), setClericRitual(String), getClericTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

setClericRitual

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

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchBlessing(String), getClericRitual(), getClericTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

getClericTriggerDesc

java.lang.String getClericTriggerDesc()

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

Returns:

a description of the blessing ritual for clerics

See Also:

Deity, fetchBlessing(String), getClericRitual(), setClericRitual(String), Deity.RitualTrigger, Deity.RitualConnector

getServiceRitual

java.lang.String getServiceRitual()

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

Returns:

the coded ritual command string

See Also:

Deity, fetchBlessing(String), setServiceRitual(String), getServiceTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

setServiceRitual

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. These are coded strings with one line commands from the RitualTrigger list, along with one or more parameters. The command phrases are separated by &.

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchBlessing(String), getServiceRitual(), getServiceTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

getServiceTriggerDesc

java.lang.String getServiceTriggerDesc()

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

Returns:

a description of the service ritual for clerics

See Also:

Deity, fetchBlessing(String), getServiceRitual(), setServiceRitual(String), Deity.RitualTrigger, Deity.RitualConnector

getWorshipRitual

java.lang.String getWorshipRitual()

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.

Returns:

the coded ritual command string

See Also:

Deity, fetchBlessing(String), setWorshipRitual(String), getWorshipTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

setWorshipRitual

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

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchBlessing(String), getWorshipRitual(), getWorshipTriggerDesc(), Deity.RitualTrigger, Deity.RitualConnector

getWorshipTriggerDesc

java.lang.String getWorshipTriggerDesc()

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

Returns:

a description of the blessing ritual for worshippers

See Also:

Deity, fetchBlessing(String), getWorshipRitual(), setWorshipRitual(String), Deity.RitualTrigger, Deity.RitualConnector

addCurse

void addCurse(Ability to,
              boolean clericOnly)

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

Parameters:

to - the curse ability object

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

See Also:

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

delCurse

void delCurse(Ability to)

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

Parameters:

to - the curse ability object

See Also:

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

numCurses

int numCurses()

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

Returns:

the total number of curses, both cleric and worshipper.

See Also:

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

fetchCurse

Ability fetchCurse(int index)

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

Parameters:

index - the index of the curse to return info about

Returns:

the curse ability object at the given index

See Also:

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

fetchCurse

Ability fetchCurse(java.lang.String ID)

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

Parameters:

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

Returns:

the curse ability object with the given ID

See Also:

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

fetchCurseCleric

boolean fetchCurseCleric(int index)

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

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:

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

fetchCurseCleric

boolean fetchCurseCleric(java.lang.String ID)

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

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:

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

getClericSin

java.lang.String getClericSin()

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.

Returns:

the coded ritual command string

See Also:

Deity, fetchCurse(String), setClericSin(String), getClericSinDesc(), Deity.RitualTrigger, Deity.RitualConnector

setClericSin

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

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchCurse(String), getClericSin(), getClericSinDesc(), Deity.RitualTrigger, Deity.RitualConnector

getClericSinDesc

java.lang.String getClericSinDesc()

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

Returns:

a description of the cursing ritual for clerics

See Also:

Deity, fetchCurse(String), getClericSin(), setClericSin(String), Deity.RitualTrigger, Deity.RitualConnector

getWorshipSin

java.lang.String getWorshipSin()

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.

Returns:

the coded ritual command string

See Also:

Deity, fetchCurse(String), setWorshipSin(String), getWorshipSinDesc(), Deity.RitualTrigger, Deity.RitualConnector

setWorshipSin

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

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchCurse(String), getWorshipSin(), getWorshipSinDesc(), Deity.RitualTrigger, Deity.RitualConnector

getWorshipSinDesc

java.lang.String getWorshipSinDesc()

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

Returns:

a description of the cursing ritual for worshippers

See Also:

Deity, fetchCurse(String), getWorshipSin(), setWorshipSin(String), Deity.RitualTrigger, Deity.RitualConnector

addPower

void addPower(Ability to)

Adds a new power up ability, which clerics can get from performming the appropriate powerup ritual.

Parameters:

to - the power up ability object

See Also:

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

delPower

void delPower(Ability to)

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

Parameters:

to - the power up ability object to remove

See Also:

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

numPowers

int numPowers()

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

Returns:

the number of power up abilities

See Also:

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

fetchPower

Ability fetchPower(int index)

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

Parameters:

index - the index of the Ability to return

Returns:

the power up Ability object at that index

See Also:

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

fetchPower

Ability fetchPower(java.lang.String ID)

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

Parameters:

ID - the Ability ID of the Ability to return

Returns:

the power up Ability object with the Ability ID

See Also:

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

getClericPowerup

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

Returns:

the coded ritual command string

See Also:

Deity, fetchPower(String), setClericPowerup(String), getClericPowerupDesc(), Deity.RitualTrigger, Deity.RitualConnector

setClericPowerup

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

Parameters:

ritual - the coded ritual command string

See Also:

Deity, fetchPower(String), getClericPowerup(), getClericPowerupDesc(), Deity.RitualTrigger, Deity.RitualConnector

getClericPowerupDesc

java.lang.String getClericPowerupDesc()

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

Returns:

a description of the power up ritual for clerics

See Also:

Deity, fetchPower(String), getClericPowerup(), setClericPowerup(String), Deity.RitualTrigger, Deity.RitualConnector