Package com.planet_ink.coffee_mud.Abilities.Properties

Class Prop_UseAdjuster

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_HaveAdjuster

com.planet_ink.coffee_mud.Abilities.Properties.Prop_Adjuster

com.planet_ink.coffee_mud.Abilities.Properties.Prop_UseAdjuster

All Implemented Interfaces:

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

public class Prop_UseAdjuster
extends Prop_Adjuster
implements ArchonOnly

Nested Class Summary

Nested classes/interfaces inherited from class com.planet_ink.coffee_mud.Abilities.Properties.Prop_HaveAdjuster

Prop_HaveAdjuster.ItemSetDef

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	processing
protected boolean	reversed

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

allSet, ambianceAdd, ambianceDel, charStateChanges, charStatsChanges, firstTime, mask, multiplyCharStates, multiplyPhyStats, parameters, phyStatsChanges, removeOnDeath

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

Method Summary

Modifier and Type	Method	Description
void	adjCharState(MOB mob, java.lang.Object[] changes, CharState charState)
void	affectCharState(MOB affectedMOB, CharState affectedState)	This method is called by the recoverCharState() method on other MOB objects.
void	affectCharStats(MOB affectedMOB, CharStats affectedStats)	This method is called by the recoverCharStats() method on other MOB objects.
void	affectPhyStats(Physical host, PhyStats affectableStats)	This method is called by the recoverPhyStats() method on other Environmental objects.
boolean	bubbleAffect()	This method is used to modify the behavior of the affectPhyStats, affectCharStats, and affectCharState methods.
protected int	canAffectCode()	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
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
void	setMiscText(java.lang.String newText)	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
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, 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, getStatCodes, isStat

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

okMessage

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

accountForYourself, canApply, canApply, flags

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

addIfPlussed, addPlusMinusAmbiances, adjCharStats, clearSet, ensureStarted, fixAccoutingsWithMask, getIntStatValue, getStat, getStrStatValue, makeObjectArray, phyStuff, setCheck, setItemCheck, setStat

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

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

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

getTickStatus, tick

Field Detail

processing

protected volatile boolean processing

reversed

protected boolean reversed

Constructor Detail

Prop_UseAdjuster

public Prop_UseAdjuster()

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 Prop_Adjuster

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 Prop_Adjuster

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 Prop_Adjuster

Returns:

a mask showing the type of objects this ability can affect

See Also:

Ability

bubbleAffect

public boolean bubbleAffect()

Description copied from interface: Ability

This method is used to modify the behavior of the affectPhyStats, affectCharStats, and affectCharState methods. If this returns true, then those methods will be called only on the owner/mob of the item currently being affected by this skill. If false, those methods behave normally.

Specified by:

bubbleAffect in interface Ability

Overrides:

bubbleAffect in class Prop_Adjuster

Returns:

whether this skill affects a mob owner of an item

See Also:

Item.owner()

affectPhyStats

public void affectPhyStats(Physical host,
                           PhyStats affectableStats)

Description copied from interface: StatsAffecting

This method is called by the recoverPhyStats() method on other Environmental objects. It is used to transform the Environmental basePhyStats() object into a finished phyStats() object, both of which are objects implementing the PhyStats interface. See those methods for more information.

Specified by:

affectPhyStats in interface StatsAffecting

Overrides:

affectPhyStats in class Prop_HaveAdjuster

Parameters:

host - the host of the PhyStats object being affected

affectableStats - the particular PhyStats object being affected

See Also:

PhyStats, Environmental, Affectable.basePhyStats(), Affectable.phyStats(), Affectable.recoverPhyStats()

affectCharStats

public void affectCharStats(MOB affectedMOB,
                            CharStats affectedStats)

Description copied from interface: StatsAffecting

This method is called by the recoverCharStats() method on other MOB objects. It is used to transform the MOB baseCharStats() object into a finished charStats() object, both of which are objects implementing the CharStats interface. See those methods for more information.

Specified by:

affectCharStats in interface StatsAffecting

Overrides:

affectCharStats in class Prop_HaveAdjuster

Parameters:

affectedMOB - the host of the CharStats object being affected

affectedStats - the particular CharStats object being affected

See Also:

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

affectCharState

public void affectCharState(MOB affectedMOB,
                            CharState affectedState)

Description copied from interface: StatsAffecting

This method is called by the recoverCharState() method on other MOB objects. It is used to transform the MOB baseCharState() object into a finished charState() object, both of which are objects implementing the CharState interface. See those methods for more information.

Specified by:

affectCharState in interface StatsAffecting

Overrides:

affectCharState in class Prop_HaveAdjuster

Parameters:

affectedMOB - the host of the CharState object being affected

affectedState - the particular CharState object being affected

See Also:

CharState, MOB, MOB.baseState(), MOB.curState(), MOB.recoverMaxState()

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

Overrides:

triggerMask in class Prop_Adjuster

Returns:

a mask of TRIGGER_* constants denoting what triggers the properties

See Also:

TriggeredAffect.TRIGGER_ALWAYS

setMiscText

public void setMiscText(java.lang.String newText)

Description copied from interface: Environmental

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

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class Prop_HaveAdjuster

Parameters:

newText - either an open internal text string, or XML

adjCharState

public void adjCharState(MOB mob,
                         java.lang.Object[] changes,
                         CharState charState)

Overrides:

adjCharState in class Prop_HaveAdjuster

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 Prop_HaveAdjuster

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