Package com.planet_ink.coffee_mud.Items.Weapons

Class StdWeapon

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Weapons.StdWeapon

All Implemented Interfaces:

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

Direct Known Subclasses:

Arquebus, Cestus, Dagger, GenWeapon, Glaive, Halberd, Javelin, Mace, Natural, Quarterstaff, Sabre, ShieldWeapon, Sickle, SmallHammer, SmallMace, Spear, Staff, StdBoffWeapon, StdBow, StdLasso, StdNet, StdSling, StdSpear, Sword, ThrowingStone, Trident, WarHammer, Whip

public class StdWeapon
extends StdItem
implements Weapon, AmmunitionWeapon

Nested Class Summary

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	ammoCapacity
protected long	lastReloadTime
protected int[]	ranges
protected boolean	useExtendedMissString
protected int	weaponClassification
protected int	weaponDamageType

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

idConverter

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

CLASS_AXE, CLASS_BLUNT, CLASS_DAGGER, CLASS_DESCS, CLASS_EDGED, CLASS_FLAILED, CLASS_HAMMER, CLASS_NATURAL, CLASS_POLEARM, CLASS_RANGED, CLASS_STAFF, CLASS_SWORD, CLASS_THROWN, MASK_MAXRANGEBITS, MASK_MAXRANGEFLAG, MASK_MAXRANGESHFT, MASK_MAXRANGEZERO, MASK_MINRANGEBITS, MASK_MINRANGEFLAG, MASK_MINRANGESHFT, MASK_MINRANGEZERO, MASK_MOAMMOBITS, MASK_MOAMMOFLAG, MASK_MOAMMOSHFT, MASK_MOAMMOZERO, MSG_TYPE_MAP, TYPE_BASHING, TYPE_BURNING, TYPE_BURSTING, TYPE_CORRUPTING, TYPE_DESCS, TYPE_DISRUPTING, TYPE_FROSTING, TYPE_GASSING, TYPE_LASERING, TYPE_MELTING, TYPE_MSG_MAP, TYPE_NATURAL, TYPE_PIERCING, TYPE_SCRAPING, TYPE_SHOOT, TYPE_SLASHING, TYPE_SONICING, TYPE_STRIKING, TYPE_STULTIFYING

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

Method Summary

Modifier and Type	Method	Description
protected boolean	abilityImbuesMagic()
void	affectPhyStats(Physical affected, PhyStats affectableStats)	This method is called by the recoverPhyStats() method on other Environmental objects.
int	ammunitionCapacity()	The current adjected maximum amount of Units of ammunition which can be loaded into this weapon.
int	ammunitionRemaining()	The amount of Units of ammunition loaded into this weapon.
java.lang.String	ammunitionType()	The type/class of ammunition required by this weapon.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
java.lang.String	genericName()	Returns a generic name for this object, devoid of its particular identifying details.
int[]	getRanges()	Gets the raw minimum and maximum range of this weapon.
java.lang.String	hitString(int damageAmount)	Gets the string that would be shown if someone gets a hit with this weapon.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	inventoryAmmoCheck(MOB M)
boolean	isFreeStanding()	Returns true if the weapon is a free-standing missile weapon, meaning it can be loaded and fired from the ground, like a siege weapon/catapult.
int	maxRange()	the modified maximum range of this object, if applicable.
int	minRange()	the modified minimum range of this object, if applicable.
java.lang.String	missString()	Gets the string that would be shown if someone misses with this weapon.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
int	rawAmmunitionCapacity()	The base unadjusted maximum amount of Units of ammunition which can be loaded into this weapon.
void	recoverOwner()
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	requiresAmmunition()	Returns true if the weapon requires ammunition, ever.
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	setAmmoCapacity(int amount)	Sets the maximum amount of Units of ammunition which can be loaded into this weapon.
void	setAmmoRemaining(int amount)	Sets the amount of Units of ammunition loaded into this weapon.
void	setAmmunitionType(java.lang.String ammo)	Sets the type/class of ammunition required by this weapon.
void	setRanges(int min, int max)	Sets the minimum and maximum range of this weapon.
void	setUsesRemaining(int newUses)	Sets the uses remaining field, which is a general numeric value whose meaning differs for different Item types.
void	setWeaponClassification(int newClassification)	Sets the general classification of this weapon, denoting how the weapon is used and the skills required.
void	setWeaponDamageType(int newType)	Sets the type of damage this weapon does, from the weapon damage type list of codes.
boolean	subjectToWearAndTear()	Whether the usesRemaining() number above is used to determine the percentage health of the item.
int	value()	The default value of the item, represented in the base CoffeeMud currency.
int	weaponClassification()	Gets the general classification of this weapon, denoting how the weapon is used and the skills required.
int	weaponDamageType()	Gets the type of damage this weapon does, from the weapon damage type list of codes.
protected java.lang.String	weaponHealth()

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 interface com.planet_ink.coffee_mud.Items.interfaces.Item

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

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, readableText, setReadable, setReadableText

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

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, 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, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, stopTicking, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, 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

weaponDamageType

protected int weaponDamageType

weaponClassification

protected int weaponClassification

useExtendedMissString

protected boolean useExtendedMissString

ranges

protected int[] ranges

ammoCapacity

protected int ammoCapacity

lastReloadTime

protected long lastReloadTime

Constructor Detail

StdWeapon

public StdWeapon()

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 StdItem

Returns:

the name of this class

genericName

public java.lang.String genericName()

Description copied from interface: Physical

Returns a generic name for this object, devoid of its particular identifying details. e.g. for a mob, this would return the age-range and race of this mob, as if it were someone spotted on the street that you didn't know.

Specified by:

genericName in interface Physical

Overrides:

genericName in class StdItem

Returns:

the generic name of this thing

weaponDamageType

public int weaponDamageType()

Description copied from interface: Weapon

Gets the type of damage this weapon does, from the weapon damage type list of codes.

Specified by:

weaponDamageType in interface Weapon

Returns:

get weapon damage type code

See Also:

Weapon.TYPE_DESCS

weaponClassification

public int weaponClassification()

Description copied from interface: Weapon

Gets the general classification of this weapon, denoting how the weapon is used and the skills required. The code comes from the weapon class list of codes.

Specified by:

weaponClassification in interface Weapon

Returns:

the weapon classification code

See Also:

Weapon.CLASS_DESCS

setWeaponDamageType

public void setWeaponDamageType(int newType)

Description copied from interface: Weapon

Sets the type of damage this weapon does, from the weapon damage type list of codes.

Specified by:

setWeaponDamageType in interface Weapon

Parameters:

newType - get weapon damage type code

See Also:

Weapon.TYPE_DESCS

setWeaponClassification

public void setWeaponClassification(int newClassification)

Description copied from interface: Weapon

Sets the general classification of this weapon, denoting how the weapon is used and the skills required. The code comes from the weapon class list of codes.

Specified by:

setWeaponClassification in interface Weapon

Parameters:

newClassification - the weapon classification code

See Also:

Weapon.CLASS_DESCS

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.

affectPhyStats

public void affectPhyStats(Physical affected,
                           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 StdItem

Parameters:

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

abilityImbuesMagic

protected boolean abilityImbuesMagic()

Overrides:

abilityImbuesMagic in class StdItem

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

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 StdItem

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

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 StdItem

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

inventoryAmmoCheck

protected boolean inventoryAmmoCheck(MOB M)

setUsesRemaining

public void setUsesRemaining(int newUses)

Description copied from interface: Item

Sets the uses remaining field, which is a general numeric value whose meaning differs for different Item types. See usesRemaining() method above for more information.

Specified by:

setUsesRemaining in interface Item

Overrides:

setUsesRemaining in class StdItem

Parameters:

newUses - a new general numeric value for this field.

weaponHealth

protected java.lang.String weaponHealth()

missString

public java.lang.String missString()

Description copied from interface: Weapon

Gets the string that would be shown if someone misses with this weapon.

Specified by:

missString in interface Weapon

Returns:

the message string to show someone misses with this weapon

See Also:

Weapon.hitString(int)

hitString

public java.lang.String hitString(int damageAmount)

Description copied from interface: Weapon

Gets the string that would be shown if someone gets a hit with this weapon.

Specified by:

hitString in interface Weapon

Parameters:

damageAmount - the amount of damage done with this weapon

Returns:

the message string to show someone hit with this weapon

See Also:

Weapon.missString()

minRange

public int minRange()

Description copied from interface: Environmental

the modified minimum 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. Usually 0.

Specified by:

minRange in interface Environmental

Overrides:

minRange in class StdItem

Returns:

the minimum range

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 StdItem

Returns:

the maximum range

setRanges

public void setRanges(int min,
                      int max)

Description copied from interface: Weapon

Sets the minimum and maximum range of this weapon. Combined with the size of the room, and who attacks first, this can set the distance between two combatants.

Specified by:

setRanges in interface Weapon

Parameters:

min - the minimum range 0=melee

max - the maximum range 0=melee

See Also:

Environmental.maxRange(), Environmental.minRange()

getRanges

public int[] getRanges()

Description copied from interface: Weapon

Gets the raw minimum and maximum range of this weapon. The array returned is in format min/max;

Specified by:

getRanges in interface Weapon

Returns:

the ranges as an array, min and then max

See Also:

Weapon.setRanges(int, int), Environmental.maxRange(), Environmental.minRange()

requiresAmmunition

public boolean requiresAmmunition()

Description copied from interface: AmmunitionWeapon

Returns true if the weapon requires ammunition, ever. Not sure why this would ever return false for an AmmunitionWeapon, but it can, so here it is.

Specified by:

requiresAmmunition in interface AmmunitionWeapon

Returns:

true if the weapon requires ammunition, false otherwise

isFreeStanding

public boolean isFreeStanding()

Description copied from interface: AmmunitionWeapon

Returns true if the weapon is a free-standing missile weapon, meaning it can be loaded and fired from the ground, like a siege weapon/catapult.

Specified by:

isFreeStanding in interface AmmunitionWeapon

Returns:

true if the weapon is free standing, false if held only

setAmmunitionType

public void setAmmunitionType(java.lang.String ammo)

Description copied from interface: AmmunitionWeapon

Sets the type/class of ammunition required by this weapon. This must match the ammunition type of the ammunition item in order to be reloaded. This can be an arbitrary string.

Specified by:

setAmmunitionType in interface AmmunitionWeapon

Parameters:

ammo - the ammunition type string

See Also:

Ammunition.setAmmunitionType(String), AmmunitionWeapon.ammunitionType()

ammunitionType

public java.lang.String ammunitionType()

Description copied from interface: AmmunitionWeapon

The type/class of ammunition required by this weapon. This must match the ammunition type of the ammunition item in order to be reloaded. This can be an arbitrary string.

Specified by:

ammunitionType in interface AmmunitionWeapon

Returns:

the ammunition type string

See Also:

Ammunition.ammunitionType(), AmmunitionWeapon.setAmmunitionType(String)

ammunitionRemaining

public int ammunitionRemaining()

Description copied from interface: AmmunitionWeapon

The amount of Units of ammunition loaded into this weapon. If this is, for example, a bow, or a gun, how many are in the clip or ready to shoot.

Specified by:

ammunitionRemaining in interface AmmunitionWeapon

Returns:

the number of units of ammunition

See Also:

AmmunitionWeapon.setAmmoRemaining(int)

setAmmoRemaining

public void setAmmoRemaining(int amount)

Description copied from interface: AmmunitionWeapon

Sets the amount of Units of ammunition loaded into this weapon. If this is, for example, a bow, or a gun, how many are in the clip or ready to shoot.

Specified by:

setAmmoRemaining in interface AmmunitionWeapon

Parameters:

amount - the number of units of ammunition

See Also:

AmmunitionWeapon.ammunitionRemaining()

ammunitionCapacity

public int ammunitionCapacity()

Description copied from interface: AmmunitionWeapon

The current adjected maximum amount of Units of ammunition which can be loaded into this weapon. If this is, for example, a bow, or a gun, how many does the clip hold or can be ready to shoot.

Specified by:

ammunitionCapacity in interface AmmunitionWeapon

Returns:

the max number of units of ammunition that can be loaded

See Also:

AmmunitionWeapon.setAmmoCapacity(int), AmmunitionWeapon.rawAmmunitionCapacity()

rawAmmunitionCapacity

public int rawAmmunitionCapacity()

Description copied from interface: AmmunitionWeapon

The base unadjusted maximum amount of Units of ammunition which can be loaded into this weapon. If this is, for example, a bow, or a gun, how many does the clip hold or can be ready to shoot.

Specified by:

rawAmmunitionCapacity in interface AmmunitionWeapon

Returns:

the max number of units of ammunition that can be loaded

See Also:

AmmunitionWeapon.setAmmoCapacity(int), AmmunitionWeapon.ammunitionCapacity()

setAmmoCapacity

public void setAmmoCapacity(int amount)

Description copied from interface: AmmunitionWeapon

Sets the maximum amount of Units of ammunition which can be loaded into this weapon. If this is, for example, a bow, or a gun, how many does the clip hold or can be ready to shoot.

Specified by:

setAmmoCapacity in interface AmmunitionWeapon

Parameters:

amount - the max number of units of ammunition that can be loaded

See Also:

AmmunitionWeapon.ammunitionCapacity(), AmmunitionWeapon.rawAmmunitionCapacity()

value

public int value()

Description copied from interface: Item

The default value of the item, represented in the base CoffeeMud currency. This method starts with baseGoldValue, which is a user-entered value, and adjusts according to magical enhancements and the condition of the item.

Specified by:

value in interface Item

Overrides:

value in class StdItem

Returns:

the adjusted value of the item in the base currency.

subjectToWearAndTear

public boolean subjectToWearAndTear()

Description copied from interface: Item

Whether the usesRemaining() number above is used to determine the percentage health of the item. If this method returns false, then health or condition is irrelevant to this Item. If true is returned, then usesRemaining is a number from 100 to 0, where 100 means perfect condition, and 0 means imminent disintegration.

Specified by:

subjectToWearAndTear in interface Item

Overrides:

subjectToWearAndTear in class StdItem

Returns:

whether this item has a valid condition

recoverOwner

public void recoverOwner()