Package com.planet_ink.coffee_mud.Items.MiscMagic

Class GenMagicInstrument

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Basic.GenItem

com.planet_ink.coffee_mud.Items.MiscMagic.GenMagicInstrument

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Dischargeable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Item, MiscMagic, MusicalInstrument, Wand, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenMagicInstrument
extends GenItem
implements MusicalInstrument, MiscMagic, Wand

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.MusicalInstrument

MusicalInstrument.InstrumentType

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wand

Wand.WandUsage

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected int	enchType
protected int	maxUses
protected java.lang.String	spellList

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.GenItem

readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
GenMagicInstrument()

Method Summary

Modifier and Type	Method	Description
boolean	checkWave(MOB mob, java.lang.String message)	Returns whether the given mob can use this wand.
void	executeMsg(Environmental host, CMMsg msg)	The general message event handler for the object.
int	getCharges()	Returns the number charges remaining
int	getEnchantType()	Returns the type of magic that can be enchanted onto this wand.
MusicalInstrument.InstrumentType	getInstrumentType()	Returns the instrument type of this instrument
java.lang.String	getInstrumentTypeName()	Returns the instrument type name of this instrument
int	getMaxCharges()	Gets the max number of times this can be invoked before being drained and empty useless.
Ability	getSpell()	Sets the spell ability object that this wand can cast.
java.lang.String	getStat(java.lang.String code)	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String[]	getStatCodes()	Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	magicWord()	Returns the magic word that invokes this wand
boolean	okMessage(Environmental host, CMMsg msg)	The general message event previewer for the object.
java.lang.String	readableText()	For things that are readable, this returns the readable string for this thing.
void	recoverPhyStats()	This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method.
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
java.lang.String	secretIdentity()	This method returns the calculated and expanded description of the properties of the item as would be discovered through the Identify spell.
void	setCharges(int newCharges)	Sets the number of charges remaining
void	setEnchantType(int enchType)	Sets the type of magic that can be enchanted onto this wand.
void	setInstrumentType(int typeOrdinal)	Sets the instrument type of this instrument
void	setInstrumentType(MusicalInstrument.InstrumentType newType)	Sets the instrument type of this instrument
void	setInstrumentType(java.lang.String newType)	Sets the instrument type of this instrument
void	setMaxCharges(int num)	Sets the max number of times this wand can be invoked before being drained and empty useless stick.
void	setReadableText(java.lang.String text)	For things that are readable, this set the readable string for this thing.
void	setSpell(Ability theSpell)	Sets the spell ability object that this wand can cast.
void	setStat(java.lang.String code, java.lang.String val)	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
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.
void	waveIfAble(MOB mob, Physical afftarget, java.lang.String message)	Checks to see if the mob can invoke this wand against the given target, given the message they just said out loud.

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, newInstance

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 class com.planet_ink.coffee_mud.Items.Basic.GenItem

isGeneric, setMiscText

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

isReadable, setReadable

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

riding, setRiding

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, genericName, getSaveStatIndex, getTickStatus, I, image, initializeClass, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recursiveWeight, removeFromOwnerContainer, riding, scripts, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

spellList

protected java.lang.String spellList

maxUses

protected int maxUses

enchType

protected int enchType

Constructor Detail

GenMagicInstrument

public GenMagicInstrument()

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 GenItem

Returns:

the name of this class

recoverPhyStats

public void recoverPhyStats()

Description copied from interface: Affectable

This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method. Surrounding objects include the room where the object is located, the Ability objects in the Effects list, the Behaviors in the behaviors list, and race/charclass/area if applicable. Those methods will then make all necessary adjustments to the values in the new phyStats() object. When it returns, phyStats() will have a totally updated object. This method must be called in code whenever the object is placed on the map, or when anything changes in its environment, such as location, effects, or other states.

Specified by:

recoverPhyStats in interface Affectable

Overrides:

recoverPhyStats in class StdItem

See Also:

Affectable.basePhyStats(), Affectable.phyStats(), Affectable.addEffect(Ability), Behavable.addBehavior(Behavior), PhyStats

getInstrumentType

public MusicalInstrument.InstrumentType getInstrumentType()

Description copied from interface: MusicalInstrument

Returns the instrument type of this instrument

Specified by:

getInstrumentType in interface MusicalInstrument

Returns:

the instrument type enum object of this instrument

See Also:

MusicalInstrument.InstrumentType, MusicalInstrument.setInstrumentType(InstrumentType), MusicalInstrument.setInstrumentType(String), MusicalInstrument.setInstrumentType(int)

getInstrumentTypeName

public java.lang.String getInstrumentTypeName()

Description copied from interface: MusicalInstrument

Returns the instrument type name of this instrument

Specified by:

getInstrumentTypeName in interface MusicalInstrument

Returns:

the instrument type name of this instrument

See Also:

MusicalInstrument.InstrumentType, MusicalInstrument.setInstrumentType(InstrumentType), MusicalInstrument.setInstrumentType(String), MusicalInstrument.setInstrumentType(int)

getCharges

public int getCharges()

Description copied from interface: Dischargeable

Returns the number charges remaining

Specified by:

getCharges in interface Dischargeable

Returns:

the number charges remaining

setCharges

public void setCharges(int newCharges)

Description copied from interface: Dischargeable

Sets the number of charges remaining

Specified by:

setCharges in interface Dischargeable

Parameters:

newCharges - the number of charges remaining

getMaxCharges

public int getMaxCharges()

Description copied from interface: Dischargeable

Gets the max number of times this can be invoked before being drained and empty useless.

Specified by:

getMaxCharges in interface Dischargeable

Returns:

the number of times this wand can be invoked

See Also:

Dischargeable.setMaxCharges(int)

setMaxCharges

public void setMaxCharges(int num)

Description copied from interface: Dischargeable

Sets the max number of times this wand can be invoked before being drained and empty useless stick.

Specified by:

setMaxCharges in interface Dischargeable

Parameters:

num - the number of times this can be invoked

See Also:

Dischargeable.getMaxCharges()

secretIdentity

public java.lang.String secretIdentity()

Description copied from interface: Item

This method returns the calculated and expanded description of the properties of the item as would be discovered through the Identify spell. It starts with its rawSecretIdentity() and adds to it any strings which the Ability objects contained in the Items effects list would generate. An empty string means the item has no secret properties per se.

Specified by:

secretIdentity in interface Item

Overrides:

secretIdentity in class StdItem

Returns:

a displayable string describing the secret properties of the item.

setSpell

public void setSpell(Ability theSpell)

Description copied from interface: Wand

Sets the spell ability object that this wand can cast.

Specified by:

setSpell in interface Wand

Parameters:

theSpell - the spell ability object that this wand can cast.

See Also:

Wand.getSpell()

getSpell

public Ability getSpell()

Description copied from interface: Wand

Sets the spell ability object that this wand can cast.

Specified by:

getSpell in interface Wand

Returns:

the spell ability object that this wand can cast.

See Also:

Wand.setSpell(Ability)

getEnchantType

public int getEnchantType()

Description copied from interface: Wand

Returns the type of magic that can be enchanted onto this wand.

Specified by:

getEnchantType in interface Wand

Returns:

the enchantment/magic type

See Also:

Ability.ACODE_SPELL

setEnchantType

public void setEnchantType(int enchType)

Description copied from interface: Wand

Sets the type of magic that can be enchanted onto this wand.

Specified by:

setEnchantType in interface Wand

Parameters:

enchType - the enchantment/magic type

See Also:

Ability.ACODE_CHANT

checkWave

public boolean checkWave(MOB mob,
                         java.lang.String message)

Description copied from interface: Wand

Returns whether the given mob can use this wand. They must be holding it, and must say the magic word, etc.

Specified by:

checkWave in interface Wand

Parameters:

mob - the mob to check for waving ability

message - what the mob said prior to the check

Returns:

true if the wand can be invoked, false otherwise

waveIfAble

public void waveIfAble(MOB mob,
                       Physical afftarget,
                       java.lang.String message)

Description copied from interface: Wand

Checks to see if the mob can invoke this wand against the given target, given the message they just said out loud.

Specified by:

waveIfAble in interface Wand

Parameters:

mob - the invoker of the wand

afftarget - the target of the say message

message - the thing said by the wand invoker

magicWord

public java.lang.String magicWord()

Description copied from interface: Wand

Returns the magic word that invokes this wand

Specified by:

magicWord in interface Wand

Returns:

the magic word that invokes this wand

text

public 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:

text in interface Environmental

Overrides:

text in class GenItem

Returns:

either an open internal text string, or XML

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Readable

For things that are readable, this set the readable string for this thing. That is to say, what the player sees when they read the door.

Specified by:

setReadableText in interface Readable

Overrides:

setReadableText in class GenItem

Parameters:

text - the readable text

See Also:

Readable.isReadable(), Readable.setReadable(boolean), Readable.readableText()

readableText

public java.lang.String readableText()

Description copied from interface: Readable

For things that are readable, this returns the readable string for this thing. That is to say, what the player sees when they read the door.

Specified by:

readableText in interface Readable

Overrides:

readableText in class GenItem

Returns:

the readable string

See Also:

Readable.isReadable(), Readable.setReadable(boolean), Readable.setReadableText(String)

setInstrumentType

public void setInstrumentType(int typeOrdinal)

Description copied from interface: MusicalInstrument

Sets the instrument type of this instrument

Specified by:

setInstrumentType in interface MusicalInstrument

Parameters:

typeOrdinal - the instrument ordinal of this instrument

See Also:

MusicalInstrument.InstrumentType, MusicalInstrument.setInstrumentType(InstrumentType), MusicalInstrument.setInstrumentType(String), MusicalInstrument.setInstrumentType(int)

setInstrumentType

public void setInstrumentType(MusicalInstrument.InstrumentType newType)

Description copied from interface: MusicalInstrument

Sets the instrument type of this instrument

Specified by:

setInstrumentType in interface MusicalInstrument

Parameters:

newType - the instrument type enum object of this instrument

See Also:

MusicalInstrument.InstrumentType, MusicalInstrument.setInstrumentType(InstrumentType), MusicalInstrument.setInstrumentType(String), MusicalInstrument.setInstrumentType(int)

setInstrumentType

public void setInstrumentType(java.lang.String newType)

Description copied from interface: MusicalInstrument

Sets the instrument type of this instrument

Specified by:

setInstrumentType in interface MusicalInstrument

Parameters:

newType - the instrument type name for this instrument

See Also:

MusicalInstrument.InstrumentType, MusicalInstrument.setInstrumentType(InstrumentType), MusicalInstrument.setInstrumentType(String), MusicalInstrument.setInstrumentType(int)

okMessage

public boolean okMessage(Environmental host,
                         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 StdItem

Parameters:

host - 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 host,
                       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 StdItem

Parameters:

host - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

getStat

public java.lang.String getStat(java.lang.String code)

Description copied from interface: Modifiable

An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:

getStat in interface Modifiable

Overrides:

getStat in class GenItem

Parameters:

code - the name of the field to read.

Returns:

the value of the field read

See Also:

Modifiable.getStatCodes()

setStat

public void setStat(java.lang.String code,
                    java.lang.String val)

Description copied from interface: Modifiable

An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.

Specified by:

setStat in interface Modifiable

Overrides:

setStat in class GenItem

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()

getStatCodes

public java.lang.String[] getStatCodes()

Description copied from interface: Modifiable

Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.

Specified by:

getStatCodes in interface Modifiable

Overrides:

getStatCodes in class GenItem

Returns:

list of the fields which may be set.

See Also:

Modifiable.getStat(String), Modifiable.setStat(String, String)

sameAs

public boolean sameAs(Environmental E)

Description copied from interface: Environmental

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:

sameAs in interface Environmental

Overrides:

sameAs in class GenItem

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)