Package com.planet_ink.coffee_mud.Abilities.Songs

Class Play

java.lang.Object

com.planet_ink.coffee_mud.Abilities.StdAbility

com.planet_ink.coffee_mud.Abilities.Songs.Play

All Implemented Interfaces:

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

Direct Known Subclasses:

Play_Accompaniment, Play_Background, Play_Ballad, Play_Battlehymn, Play_Blues, Play_Break, Play_Carol, Play_Charge, Play_Dirge, Play_Ditty, Play_Harmony, Play_Instrument, Play_LoveSong, Play_Lullabies, Play_March, Play_Melody, Play_Mystical, Play_Retreat, Play_Reveille, Play_Rhythm, Play_Solo, Play_Spiritual, Play_Symphony, Play_Tempo, Play_Tribal

public class Play
extends StdAbility

Field Summary

Fields

Modifier and Type	Field	Description
protected Pair<java.lang.Double,java.lang.Integer>	bonusCache
protected java.util.List<Room>	commonRoomSet
protected MusicalInstrument	instrument
protected Room	originRoom
protected int	playDepth
protected long	timeOut

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

affected, amDestroyed, canBeUninvoked, empty, invoker, isAnAutoEffect, lastCastHelp, miscText, proficiency, savable, tickDown, unInvoked

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

Constructor Summary

Constructors

Constructor	Description
Play()

Method Summary

Modifier and Type	Method	Description
int	adjustedLevel(MOB mob, int asLevel)	This method calculates the strength level of this skill for the given mob, and taking into account the given override-level (asLevel).
void	affectPhyStats(Physical affectedEnv, PhyStats affectableStats)	This method is called by the recoverPhyStats() method on other Environmental objects.
protected int	avgStat()
protected int	calculateNewSongDepth(MOB invoker)
protected int	canAffectCode()	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
protected int	canTargetCode()	Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
int	castingQuality(MOB mob, Physical target)	Serves a purpose similar to that of the Ability abstractQuality() method, but it determines a more exact quality based on a given invoker, target, and assumes an imminent use of the skill.
int	classificationCode()	Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
java.lang.String	displayText()	Gets the raw string used to show what this object looks like in the room.
void	executeMsg(Environmental host, CMMsg msg)	The general message event handler for the object.
protected Pair<java.lang.Double,java.lang.Integer>	getBonuses()
protected int	getCorrectDirToOriginRoom(Room R, int v)
protected java.lang.String	getCorrectMsgString(Room R, java.lang.String str, int v)
static MusicalInstrument	getInstrument(MOB mob, MusicalInstrument.InstrumentType requiredInstrumentType, boolean noisy)
protected java.util.List<Room>	getInvokerScopeRoomSet(int depth)
protected boolean	HAS_QUANTITATIVE_ASPECT()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected int	innerAvgStat()
protected double	innerStatBonusPct()
protected void	inpersistentAffect(MOB mob)
java.lang.String	instrumentName()
boolean	invoke(MOB mob, java.util.List<java.lang.String> commands, Physical givenTarget, boolean auto, int asLevel)	This method is called when a player or the system invokes this skill, casts this spell, etc.
int	invokerLevel()
protected boolean	maliciousButNotAggressiveFlag()
int	maxRange()	the modified maximum range of this object, if applicable.
protected boolean	mindAttack()
java.lang.String	name()	The nice displayable name of this instance of this object
protected boolean	persistentSong()
protected MusicalInstrument.InstrumentType	requiredInstrumentType()
java.util.Set<MOB>	sendMsgAndGetTargets(MOB mob, Room R, CMMsg msg, Environmental givenTarget, boolean auto)
void	setAffectedOne(Physical P)	Sets a reference to the room, item, mob, or exit that is currently being affected by this skill.
void	setInvoker(MOB mob)	Sets or changes the mob that invoked or initated the skill or effect.
protected boolean	skipStandardSongInvoke()
protected boolean	skipStandardSongTick()
protected java.lang.String	songOf()
protected double	statBonusPct()
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
java.lang.String[]	triggerStrings()	A set of the command strings the user types to access this command when it is listed as a skill ability.
protected void	unPlayAll(MOB mob, MOB invoker, boolean exceptThisOne, boolean noEcho)
protected boolean	unPlayMe(MOB mob, MOB invoker, boolean noEcho)
int	usageType()	Returns a bitmap made up of constants defined by Ability.USAGE_*.
static boolean	usingInstrument(MusicalInstrument I, MOB mob)

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

abilityCode, abstractQuality, accountForYourself, addedTickTime, adjustBeneficialTickdownTime, adjustedMaxInvokerRange, adjustMaliciousTickdownTime, affectCharState, affectCharStats, affecting, amDestroyed, aPossibleAbuserOfCasterLevel, appropriateToMyFactions, autoInvocation, beneficialAffect, beneficialSoundFizzle, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkComponents, checkedCastingCost, checkTargetRange, cloneFix, combatCastingTime, commonTell, commonTelL, commonTelL, compareTo, copyOf, description, destroy, disregardsArmorCheck, enchantQuality, evalTargetItem, expertise, expirationDate, externalFiles, failureTell, flags, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getRawTrainingCost, getSaveStatIndex, getStat, getStatCodes, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTargetItemFavorMOB, getTargetItemFavorMOB, getTargetItemFavorMOB, getTickDownRemaining, getTicksBetweenCasts, getTickStatus, getTimeOfNextCast, getTrainingCost, getVisibleRoomTarget, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, ignoreCompounding, image, iniPracticesToPractice, initializeClass, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, mayBeEnchanted, minCastWaitTime, minRange, miscTextFormat, modifyCastCode, Name, newInstance, okMessage, overrideMana, possibleContainer, practice, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, sameAs, saveCombatState, setAbilityCode, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, setProficiency, setSavable, setStat, setTickDown, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somaticCastCode, somaticCastMask, spreadImmunity, startTickDown, teach, testUsageCost, text, unInvoke, unlearn, usageCost, verbalCastCode, verbalCastMask, verbalSpeakCode

Field Detail

instrument

protected MusicalInstrument instrument

timeOut

protected long timeOut

commonRoomSet

protected java.util.List<Room> commonRoomSet

originRoom

protected Room originRoom

playDepth

protected volatile int playDepth

bonusCache

protected volatile Pair<java.lang.Double,java.lang.Integer> bonusCache

Constructor Detail

Play

public Play()

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 StdAbility

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 StdAbility

Returns:

the displayable name of this object instance

See Also:

Environmental.Name()

displayText

public java.lang.String displayText()

Description copied from interface: Environmental

Gets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

displayText in interface Environmental

Overrides:

displayText in class StdAbility

Returns:

the string describing how this object looks in the room

canAffectCode

protected int canAffectCode()

Description copied from class: StdAbility

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 StdAbility

Returns:

a mask showing the type of objects this ability can affect

See Also:

Ability

canTargetCode

protected int canTargetCode()

Description copied from class: StdAbility

Designates whether, when invoked as a skill, what sort of objects this ability can effectively target. Uses the Ability.CAN_* constants.

Overrides:

canTargetCode in class StdAbility

Returns:

a mask showing the type of objects this ability can target

See Also:

Ability

triggerStrings

public java.lang.String[] triggerStrings()

Description copied from interface: Ability

A set of the command strings the user types to access this command when it is listed as a skill ability.

Specified by:

triggerStrings in interface Ability

Overrides:

triggerStrings in class StdAbility

Returns:

an array of command invoking string words

See Also:

Ability.putInCommandlist()

classificationCode

public int classificationCode()

Description copied from interface: Ability

Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain. It is made up of the ACODE_* constants the Ability interface, and optionally the DOMAIN_* constants also defined in this interface.

Specified by:

classificationCode in interface Ability

Overrides:

classificationCode in class StdAbility

Returns:

ACODE_* constant classification

See Also:

Ability

usageType

public int usageType()

Description copied from interface: Ability

Returns a bitmap made up of constants defined by Ability.USAGE_*. It lets the system know which of the values in the usageCost(MOB,boolean) method are relevant. It determines whether this skill requires mana, movement, hit points, or some combination of the three.

Specified by:

usageType in interface Ability

Overrides:

usageType in class StdAbility

Returns:

a bitmap defined by Ability.USAGE_*

See Also:

Ability

maliciousButNotAggressiveFlag

protected boolean maliciousButNotAggressiveFlag()

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 StdAbility

Parameters:

P - the room, mob, or item being affected

See Also:

Ability.affecting()

setInvoker

public void setInvoker(MOB mob)

Description copied from interface: Ability

Sets or changes the mob that invoked or initated the skill or effect.

Specified by:

setInvoker in interface Ability

Overrides:

setInvoker in class StdAbility

Parameters:

mob - the invoker mob

See Also:

MOB, Ability.invoker()

getBonuses

protected Pair<java.lang.Double,java.lang.Integer> getBonuses()

statBonusPct

protected double statBonusPct()

avgStat

protected int avgStat()

innerStatBonusPct

protected double innerStatBonusPct()

innerAvgStat

protected int innerAvgStat()

maxRange

public int maxRange()

Description copied from interface: Environmental

the modified maximum range of this object, if applicable. Can refer to the size of a room, the range of a weapon, or the calculated range of a mob in combat.

Specified by:

maxRange in interface Environmental

Overrides:

maxRange in class StdAbility

Returns:

the maximum range

requiredInstrumentType

protected MusicalInstrument.InstrumentType requiredInstrumentType()

skipStandardSongInvoke

protected boolean skipStandardSongInvoke()

mindAttack

protected boolean mindAttack()

skipStandardSongTick

protected boolean skipStandardSongTick()

persistentSong

protected boolean persistentSong()

songOf

protected java.lang.String songOf()

HAS_QUANTITATIVE_ASPECT

protected boolean HAS_QUANTITATIVE_ASPECT()

instrumentName

public java.lang.String instrumentName()

adjustedLevel

public int adjustedLevel(MOB mob,
                         int asLevel)

Description copied from interface: Ability

This method calculates the strength level of this skill for the given mob, and taking into account the given override-level (asLevel). The level returned should be based on a minimum baseline level (usually the class level of the class that qualifies for this skill at the lowest level), and should take into account the number of levels the mob has over and above that in appropriate classes

Specified by:

adjustedLevel in interface Ability

Overrides:

adjustedLevel in class StdAbility

Parameters:

mob - the mob to evaluate the skill level of

asLevel - if greater than 0, this method always returns it

Returns:

the level of power the given mob has in this skill.

invokerLevel

public int invokerLevel()

inpersistentAffect

protected void inpersistentAffect(MOB mob)

usingInstrument

public static boolean usingInstrument(MusicalInstrument I,
                                      MOB mob)

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdAbility

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

castingQuality

public int castingQuality(MOB mob,
                          Physical target)

Description copied from interface: Ability

Serves a purpose similar to that of the Ability abstractQuality() method, but it determines a more exact quality based on a given invoker, target, and assumes an imminent use of the skill. For this reason, the QUALITY_OK_* constants should be avoided in favor of the other Ability.QUALITY_* constants.

Specified by:

castingQuality in interface Ability

Overrides:

castingQuality in class StdAbility

Parameters:

mob - the person to use the skill

target - the potential target -- may be invoker

Returns:

Ability.QUALITY_* constant classification

See Also:

Ability, Ability.abstractQuality()

affectPhyStats

public void affectPhyStats(Physical affectedEnv,
                           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 StdAbility

Parameters:

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

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 StdAbility

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

unPlayAll

protected void unPlayAll(MOB mob,
                         MOB invoker,
                         boolean exceptThisOne,
                         boolean noEcho)

unPlayMe

protected boolean unPlayMe(MOB mob,
                           MOB invoker,
                           boolean noEcho)

getInstrument

public static MusicalInstrument getInstrument(MOB mob,
                                              MusicalInstrument.InstrumentType requiredInstrumentType,
                                              boolean noisy)

calculateNewSongDepth

protected int calculateNewSongDepth(MOB invoker)

getInvokerScopeRoomSet

protected java.util.List<Room> getInvokerScopeRoomSet(int depth)

getCorrectDirToOriginRoom

protected int getCorrectDirToOriginRoom(Room R,
                                        int v)

getCorrectMsgString

protected java.lang.String getCorrectMsgString(Room R,
                                               java.lang.String str,
                                               int v)

sendMsgAndGetTargets

public java.util.Set<MOB> sendMsgAndGetTargets(MOB mob,
                                               Room R,
                                               CMMsg msg,
                                               Environmental givenTarget,
                                               boolean auto)

invoke

public boolean invoke(MOB mob,
                      java.util.List<java.lang.String> commands,
                      Physical givenTarget,
                      boolean auto,
                      int asLevel)

Description copied from interface: Ability

This method is called when a player or the system invokes this skill, casts this spell, etc. Calls the more complete invoke method without an empty command strings vector unless target is non-null, in which case the vector will contain the name of the target.

Specified by:

invoke in interface Ability

Overrides:

invoke in class StdAbility

Parameters:

mob - the player or mob invoking the skill

commands - the parameters entered for the skill (minus trigger word)

givenTarget - null, unless being auto-invoked. Represents an override target.

auto - false if player enters command, true if system invokes the command

asLevel - -1, unless being auto-invoked, when it is the level to invoke it at.

Returns:

whether the skill successfully invoked.