com.planet_ink.coffee_mud.Abilities.Properties
Class Prop_ItemSlotFiller

java.lang.Object
  com.planet_ink.coffee_mud.Abilities.Properties.Property
      com.planet_ink.coffee_mud.Abilities.Properties.Prop_ItemSlotFiller

All Implemented Interfaces:

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

public class Prop_ItemSlotFiller
extends Property
implements AbilityContainer

Field Summary

protected PairList<java.lang.String,java.lang.String>	adds
protected Physical	affected2
protected Ability[]	affects
protected static Item	fakeItem
protected java.util.List<java.lang.String>	skips
protected int	slotCount
protected java.lang.String	slotType

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

affected, amDestroyed, empty, miscText, savable

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_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_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_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, 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_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ENABLER, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_MINDALTERING, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, 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_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT

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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Prop_ItemSlotFiller()

Method Summary

java.util.Enumeration<Ability>	abilities() Returns an enumerator of the Ability objects in this container.
java.lang.String	accountForYourself() For use by the identify spell, this should return a nice description of any properties incorporated by this effect.
void	addAbility(Ability to) Adds a new ability to this for use.
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.
java.util.Enumeration<Ability>	allAbilities() Returns an enumerator of the Ability objects in this container.
protected int	canAffectCode() Designates whether, when used as a property/effect, what sort of objects this ability can affect.
void	delAbility(Ability to) Removes the exact given ability object from here.
void	delAllAbilities() Removes all owned abilities from this container.
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
Ability	fetchAbility(int index) Returns the Ability object at that index in this container.
Ability	fetchAbility(java.lang.String ID) If contained herein, this will return the ability from this container of the given ID.
Ability	fetchRandomAbility() Returns a random ability from this container.
protected Physical	getAffected()
protected Ability[]	getAffects()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isSlotted()
java.lang.String	name() The nice displayable name of this instance of this object
int	numAbilities() Returns the number of abilities contained herein this object.
int	numAllAbilities() Returns the number of all abilities in this container.
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
void	setAffectedOne(Physical P) Sets a reference to the room, item, mob, or exit that is currently being affected by this skill.
void	setMiscText(java.lang.String text) 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.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

slotCount

protected int slotCount

slotType

protected java.lang.String slotType

affects

protected Ability[] affects

affected2

protected Physical affected2

skips

protected java.util.List<java.lang.String> skips

fakeItem

protected static Item fakeItem

adds

protected PairList<java.lang.String,java.lang.String> adds

Constructor Detail

Prop_ItemSlotFiller

public Prop_ItemSlotFiller()

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

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 Property

Returns:

a description of properties incorporated

setAffectedOne

public void setAffectedOne(Physical P)

Description copied from interface: Ability

Sets a reference to the room, item, mob, or exit that is currently being affected by this skill. Does not apply to non-affecting skills like kick, but more to auto-invoking skills and spells that affect people like sleep, and especially to properties.

Specified by:

setAffectedOne in interface Ability

Overrides:

setAffectedOne in class Property

Parameters:

P - the room, mob, or item being affected

See Also:

Ability.affecting()

getAffected

protected Physical getAffected()

getAffects

protected Ability[] getAffects()

setMiscText

public void setMiscText(java.lang.String text)

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 Property

Parameters:

text - either an open internal text string, or XML

isSlotted

protected boolean isSlotted()

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 Property

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

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 Property

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

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 Property

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 Property

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 Property

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

addAbility

public void addAbility(Ability to)

Description copied from interface: AbilityContainer

Adds a new ability to this for use. No ability with the same ID can be contained twice.

Specified by:

addAbility in interface AbilityContainer

Parameters:

to - the Ability to add.

See Also:

Ability

delAbility

public void delAbility(Ability to)

Description copied from interface: AbilityContainer

Removes the exact given ability object from here.

Specified by:

delAbility in interface AbilityContainer

Parameters:

to - the exact Ability to remove

See Also:

Ability

numAbilities

public int numAbilities()

Description copied from interface: AbilityContainer

Returns the number of abilities contained herein this object. Any extraneous abilities bestowed from other sources will NOT be returned -- only the exact abilities owned herein.

Specified by:

numAbilities in interface AbilityContainer

Returns:

the number of owned abilities

See Also:

Ability

fetchAbility

public Ability fetchAbility(int index)

Description copied from interface: AbilityContainer

Returns the Ability object at that index in this container. Any extraneous abilities bestowed from other sources MAY be returned, so long as index > numAbilities.

Specified by:

fetchAbility in interface AbilityContainer

Parameters:

index - the index of the Ability object to return

Returns:

the Ability object

See Also:

Ability

fetchAbility

public Ability fetchAbility(java.lang.String ID)

Description copied from interface: AbilityContainer

If contained herein, this will return the ability from this container of the given ID. Any extraneous abilities bestowed from other sources MAY be returned by this method.

Specified by:

fetchAbility in interface AbilityContainer

Parameters:

ID - the ID of the ability to return.

Returns:

the Ability object

See Also:

Ability

fetchRandomAbility

public Ability fetchRandomAbility()

Description copied from interface: AbilityContainer

Returns a random ability from this container. Any extraneous abilities bestowed from other sources MAY be returned by this method.

Specified by:

fetchRandomAbility in interface AbilityContainer

Returns:

a random Ability

See Also:

Ability

abilities

public java.util.Enumeration<Ability> abilities()

Description copied from interface: AbilityContainer

Returns an enumerator of the Ability objects in this container. Any extraneous abilities bestowed from other sources will NOT be returned -- only the exact abilities owned herein.

Specified by:

abilities in interface AbilityContainer

Returns:

An enumerator for abilities

delAllAbilities

public void delAllAbilities()

Description copied from interface: AbilityContainer

Removes all owned abilities from this container. Any extraneous abilities bestowed from other sources will NOT be removed.

Specified by:

delAllAbilities in interface AbilityContainer

numAllAbilities

public int numAllAbilities()

Description copied from interface: AbilityContainer

Returns the number of all abilities in this container. Any extraneous abilities bestowed from other sources WILL be counted by this.

Specified by:

numAllAbilities in interface AbilityContainer

Returns:

the number of all abilities in this container

allAbilities

public java.util.Enumeration<Ability> allAbilities()

Description copied from interface: AbilityContainer

Returns an enumerator of the Ability objects in this container. Any extraneous abilities bestowed from other sources WILL ALSO be returned.

Specified by:

allAbilities in interface AbilityContainer

Returns:

An enumerator for all abilities, both in the container and not