|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.planet_ink.coffee_mud.Items.Basic.StdItem
com.planet_ink.coffee_mud.Items.Basic.StdContainer
com.planet_ink.coffee_mud.Items.Basic.StdRideable
com.planet_ink.coffee_mud.Items.Weapons.StdSiegeWeapon
public class StdSiegeWeapon
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable |
---|
Wearable.CODES |
Field Summary | |
---|---|
protected int |
ammoCapacity
|
protected int |
maxRange
|
protected int |
minRange
|
protected boolean |
useExtendedMissString
|
protected int |
weaponClassification
|
protected int |
weaponDamageType
|
Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdRideable |
---|
dismountString, mountString, putString, rideBasis, riderCapacity, riders, rideString, stateString, stateSubjectStr |
Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer |
---|
capacity, containType, defaultsClosed, defaultsLocked, hasALid, hasALock, isLocked, isOpen, openDelayTicks |
Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem |
---|
affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, name, 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, TYPE_BASHING, TYPE_BURNING, TYPE_BURSTING, TYPE_DESCS, TYPE_FROSTING, TYPE_GASSING, TYPE_LASERING, TYPE_MELTING, TYPE_NATURAL, TYPE_PIERCING, TYPE_SHOOT, TYPE_SLASHING, TYPE_SONICING, TYPE_STRIKING |
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 |
Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable |
---|
RIDEABLE_AIR, RIDEABLE_DESCS, RIDEABLE_ENTERIN, RIDEABLE_LADDER, RIDEABLE_LAND, RIDEABLE_SIT, RIDEABLE_SLEEP, RIDEABLE_TABLE, RIDEABLE_WAGON, RIDEABLE_WATER |
Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container |
---|
CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS |
Constructor Summary | |
---|---|
StdSiegeWeapon()
|
Method Summary | |
---|---|
int |
ammunitionCapacity()
The 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 |
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. |
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 maximum range of this object, if applicable. |
int |
minRange()
the 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. |
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 class com.planet_ink.coffee_mud.Items.Basic.StdRideable |
---|
addRider, affectPhyStats, amRiding, cloneFix, delRider, destroy, dismountString, displayText, fetchRider, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, isMobileRideBasis, mobileRideBasis, mountString, numRiders, putString, rideBasis, riderCapacity, riders, rideString, savable, setDismountString, setMountString, setPutString, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, stateString, stateStringSubject |
Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer |
---|
canContain, capacity, containTypes, defaultsClosed, defaultsLocked, emptyPlease, getContents, getDeepContents, hasADoor, hasALock, hasContent, isInside, isLocked, isOpen, keyName, numberOfItems, openDelayTicks, recursiveWeight, setCapacity, setContainTypes, setDoorsNLocks, setKeyName, setMiscText, setOpenDelayTicks, tick |
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.Items.interfaces.Item |
---|
baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, stopTicking, ultimateContainer, usesRemaining |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider |
---|
riding, setRiding |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical |
---|
description, displayText, name |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental |
---|
description, displayText, expirationDate, image, isGeneric, L, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable |
---|
getTickStatus, name, tick |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting |
---|
affectCharState, affectCharStats, affectPhyStats |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent |
---|
amDestroyed, destroy, isSavable, setSavable |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject |
---|
copyOf, initializeClass, newInstance |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable |
---|
getSaveStatIndex, getStat, getStatCodes, isStat, setStat |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable |
---|
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, setBasePhyStats |
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.DBIdentifiable |
---|
canSaveDatabaseID, databaseID, setDatabaseID |
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 |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable |
---|
isReadable, readableText, setReadable, setReadableText |
Field Detail |
---|
protected int weaponDamageType
protected int weaponClassification
protected boolean useExtendedMissString
protected int minRange
protected int maxRange
protected int ammoCapacity
Constructor Detail |
---|
public StdSiegeWeapon()
Method Detail |
---|
public java.lang.String ID()
CMObject
ID
in interface CMObject
ID
in class StdRideable
public int weaponDamageType()
Weapon
weaponDamageType
in interface Weapon
Weapon.TYPE_DESCS
public int weaponClassification()
Weapon
weaponClassification
in interface Weapon
Weapon.CLASS_DESCS
public void setWeaponDamageType(int newType)
Weapon
setWeaponDamageType
in interface Weapon
newType
- get weapon damage type codeWeapon.TYPE_DESCS
public void setWeaponClassification(int newClassification)
Weapon
setWeaponClassification
in interface Weapon
newClassification
- the weapon classification codeWeapon.CLASS_DESCS
public boolean isFreeStanding()
AmmunitionWeapon
isFreeStanding
in interface AmmunitionWeapon
public java.lang.String secretIdentity()
Item
secretIdentity
in interface Item
secretIdentity
in class StdItem
public void recoverPhyStats()
Affectable
recoverPhyStats
in interface Affectable
recoverPhyStats
in class StdRideable
Affectable.basePhyStats()
,
Affectable.phyStats()
,
Affectable.addEffect(Ability)
,
Behavable.addBehavior(Behavior)
,
PhyStats
public void executeMsg(Environmental myHost, CMMsg msg)
MsgListener
executeMsg
in interface MsgListener
executeMsg
in class StdRideable
myHost
- either the initiator of the event, or the host of this objectmsg
- the CMMsg that needs to be executedCMMsg
public boolean okMessage(Environmental myHost, CMMsg msg)
MsgListener
okMessage
in interface MsgListener
okMessage
in class StdRideable
myHost
- either the initiator of the event, or the host of this objectmsg
- the CMMsg that wants to be executed
CMMsg
,
CMMsg.source()
public void setUsesRemaining(int newUses)
Item
setUsesRemaining
in interface Item
setUsesRemaining
in class StdItem
newUses
- a new general numeric value for this field.protected java.lang.String weaponHealth()
public java.lang.String missString()
Weapon
missString
in interface Weapon
Weapon.hitString(int)
public java.lang.String hitString(int damageAmount)
Weapon
hitString
in interface Weapon
damageAmount
- the amount of damage done with this weapon
Weapon.missString()
public int minRange()
Environmental
minRange
in interface Environmental
minRange
in class StdItem
public int maxRange()
Environmental
maxRange
in interface Environmental
maxRange
in class StdItem
public void setRanges(int min, int max)
Weapon
setRanges
in interface Weapon
min
- the minimum range 0=meleemax
- the maximum range 0=meleeEnvironmental.maxRange()
,
Environmental.minRange()
public boolean requiresAmmunition()
AmmunitionWeapon
requiresAmmunition
in interface AmmunitionWeapon
public void setAmmunitionType(java.lang.String ammo)
AmmunitionWeapon
setAmmunitionType
in interface AmmunitionWeapon
ammo
- the ammunition type stringAmmunition.setAmmunitionType(String)
,
AmmunitionWeapon.ammunitionType()
public java.lang.String ammunitionType()
AmmunitionWeapon
ammunitionType
in interface AmmunitionWeapon
Ammunition.ammunitionType()
,
AmmunitionWeapon.setAmmunitionType(String)
public int ammunitionRemaining()
AmmunitionWeapon
ammunitionRemaining
in interface AmmunitionWeapon
AmmunitionWeapon.setAmmoRemaining(int)
public void setAmmoRemaining(int amount)
AmmunitionWeapon
setAmmoRemaining
in interface AmmunitionWeapon
amount
- the number of units of ammunitionAmmunitionWeapon.ammunitionRemaining()
public int ammunitionCapacity()
AmmunitionWeapon
ammunitionCapacity
in interface AmmunitionWeapon
AmmunitionWeapon.setAmmoCapacity(int)
public void setAmmoCapacity(int amount)
AmmunitionWeapon
setAmmoCapacity
in interface AmmunitionWeapon
amount
- the max number of units of ammunition that can be loadedAmmunitionWeapon.ammunitionCapacity()
public int value()
Item
value
in interface Item
value
in class StdItem
public boolean subjectToWearAndTear()
Item
subjectToWearAndTear
in interface Item
subjectToWearAndTear
in class StdRideable
public void recoverOwner()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |