Package com.planet_ink.coffee_mud.Abilities.Properties

Class Prop_ReqEntry

java.lang.Object

com.planet_ink.coffee_mud.Abilities.ThinAbility

com.planet_ink.coffee_mud.Abilities.Properties.Property

com.planet_ink.coffee_mud.Abilities.Properties.Prop_ReqEntry

All Implemented Interfaces:

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

public class Prop_ReqEntry
extends Property
implements TriggeredAffect, Deity.DeityWorshipper

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 class com.planet_ink.coffee_mud.Abilities.ThinAbility

affected, amDestroyed, empty, miscText, savable

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

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.TriggeredAffect

TRIGGER_ALWAYS, TRIGGER_BEING_HIT, TRIGGER_DESC, TRIGGER_DROP_PUTIN, TRIGGER_ENTER, TRIGGER_GET, TRIGGER_HITTING_WITH, TRIGGER_MOUNT, TRIGGER_PUT, TRIGGER_USE, TRIGGER_WEAR_WIELD

Constructor Summary

Constructors

Constructor	Description
Prop_ReqEntry()

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountForYourself()	For use by the identify spell, this should return a nice description of any properties incorporated by this effect.
protected int	canAffectCode()	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
java.lang.String	deityName()	Returns the displayable name of this mobs current deity.
long	flags()	Returns a bitmap giving some specific information about the scope and purpose of the skill.
Deity	getMyDeity()	Returns the Deity object of the mob that this player/mob worships.
java.lang.String	getWorshipCharID()	Returns the name of the Deity mob that this player/mob worships.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	name()	The nice displayable name of this instance of this object
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
boolean	passesMuster(MOB mob)
void	setDeityName(java.lang.String newDeityName)	Changes the apparent deity of ths mob by setting a new name.
void	setMiscText(java.lang.String txt)	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
void	setWorshipCharID(java.lang.String newVal)	Sets the name of the Deity mob that this player/mob worships.
int	triggerMask()	This method returns a mask of TRIGGER_* constants denoting what triggers the properties

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

abilityCode, abstractQuality, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkedCastingCost, classificationCode, combatCastingTime, enchantQuality, externalFiles, 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, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

amDestroyed, destroy, isSavable, setSavable

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

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

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

expirationDate, setExpirationDate

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

executeMsg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Abilities.Properties.Property

canAffect, canAffect, canTarget, canTargetCode, classificationCode, copyOf, newInstance, sameAs, setDescription, setDisplayText

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

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.Abilities.ThinAbility

abilityCode, abstractQuality, adjustedLevel, affectCharState, affectCharStats, affecting, affectPhyStats, amDestroyed, appropriateToMyFactions, autoInvocation, bubbleAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, castingQuality, castingTime, checkedCastingCost, combatCastingTime, compareTo, description, destroy, displayText, enchantQuality, executeMsg, expirationDate, externalFiles, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, getTrainingCost, helpProficiency, image, initializeClass, invoke, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maxRange, mayBeEnchanted, minRange, miscTextFormat, Name, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, rawImage, requirements, setAbilityCode, setAffectedOne, setExpirationDate, setImage, setInvoker, setName, setProficiency, setSavable, setStat, startTickDown, teach, text, tick, triggerStrings, unInvoke, unlearn, usageCost, usageType

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

getTickStatus, tick

Constructor Detail

Prop_ReqEntry

public Prop_ReqEntry()

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 Property

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Tickable

The nice displayable name of this instance of this object

Specified by:

name in interface CMObject

Specified by:

name in interface Tickable

Overrides:

name in class Property

Returns:

the displayable name of this object instance

See Also:

Environmental.Name()

canAffectCode

protected int canAffectCode()

Description copied from class: Property

Designates whether, when used as a property/effect, what sort of objects this ability can affect. Uses the Ability.CAN_* constants.

Overrides:

canAffectCode in class Property

Returns:

a mask showing the type of objects this ability can affect

See Also:

Ability

flags

public long flags()

Description copied from interface: Ability

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

Specified by:

flags in interface Ability

Overrides:

flags in class ThinAbility

Returns:

FLAG_* constant based bitmap

See Also:

Ability

triggerMask

public int triggerMask()

Description copied from interface: TriggeredAffect

This method returns a mask of TRIGGER_* constants denoting what triggers the properties

Specified by:

triggerMask in interface TriggeredAffect

Returns:

a mask of TRIGGER_* constants denoting what triggers the properties

See Also:

TriggeredAffect.TRIGGER_ALWAYS

setMiscText

public void setMiscText(java.lang.String txt)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class ThinAbility

Parameters:

txt - either an open internal text string, or XML

accountForYourself

public java.lang.String accountForYourself()

Description copied from interface: Ability

For use by the identify spell, this should return a nice description of any properties incorporated by this effect.

Specified by:

accountForYourself in interface Ability

Overrides:

accountForYourself in class ThinAbility

Returns:

a description of properties incorporated

getWorshipCharID

public java.lang.String getWorshipCharID()

Description copied from interface: Deity.DeityWorshipper

Returns the name of the Deity mob that this player/mob worships. Empty string means they are an atheist. :) The name here should always be the same as a Deity type mob in the game in order for the religion system to work correctly. For Clerics, this field has particular importance.

Specified by:

getWorshipCharID in interface Deity.DeityWorshipper

Returns:

the name of the Deity mob that this player/mob worships.

See Also:

Deity.DeityWorshipper.setWorshipCharID(String), Deity.DeityWorshipper.getMyDeity(), Deity.DeityWorshipper.setDeityName(String), Deity.DeityWorshipper.deityName()

setWorshipCharID

public void setWorshipCharID(java.lang.String newVal)

Description copied from interface: Deity.DeityWorshipper

Sets the name of the Deity mob that this player/mob worships. Empty string means they are an atheist. :) The name here should always be the same as a Deity type mob in the game in order for the religion system to work correctly. For Clerics, this field has particular importance.

Specified by:

setWorshipCharID in interface Deity.DeityWorshipper

Parameters:

newVal - the name of the Deity mob that this player/mob worships.

See Also:

Deity.DeityWorshipper.setWorshipCharID(String), Deity.DeityWorshipper.getMyDeity(), Deity.DeityWorshipper.deityName()

setDeityName

public void setDeityName(java.lang.String newDeityName)

Description copied from interface: Deity.DeityWorshipper

Changes the apparent deity of ths mob by setting a new name. A value of null will reset this setting, allowing the mobs TRUE deity to be displayed through the deityName method instead of the string set through this one.

Specified by:

setDeityName in interface Deity.DeityWorshipper

Parameters:

newDeityName - the name of the mobs apparent deity

See Also:

Deity.DeityWorshipper.deityName()

deityName

public java.lang.String deityName()

Description copied from interface: Deity.DeityWorshipper

Returns the displayable name of this mobs current deity. If this method is called on the mobs charStats() object, as opposed to baseCharStats(), it may return something different than charStats().getMyDeity().name(). For this reason, you should ONLY use this method when you want to display the mobs current deity.

Specified by:

deityName in interface Deity.DeityWorshipper

Returns:

the name of this mobs current deity, or empty string.

See Also:

Deity.DeityWorshipper.getWorshipCharID(), Deity.DeityWorshipper.setWorshipCharID(String), Deity.DeityWorshipper.getMyDeity()

getMyDeity

public Deity getMyDeity()

Description copied from interface: Deity.DeityWorshipper

Returns the Deity object of the mob that this player/mob worships. A null return means they are an atheist. Very important for Clerics.

Specified by:

getMyDeity in interface Deity.DeityWorshipper

Returns:

the Deity object of the mob that this player/mob worships

See Also:

Deity.DeityWorshipper.getWorshipCharID(), Deity.DeityWorshipper.setWorshipCharID(String), Deity.DeityWorshipper.deityName()

passesMuster

public boolean passesMuster(MOB mob)

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 ThinAbility

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