Package com.planet_ink.coffee_mud.Items.Weapons

Class StdSiegeWeapon

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GenSiegeWeapon

public class StdSiegeWeapon
extends StdRideable
implements AmmunitionWeapon, SiegableItem

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

Rideable.Basis

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

SiegableItem.SiegeCommand

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[]	aiming
protected int	ammoCapacity
protected PairList<Item,int[]>	coordinates
protected int	lastSpamCt
protected java.lang.String	lastSpamMsg
protected int	maxRange
protected int	minRange
protected int	nextTacticalMoveDir
protected PairList<MOB,java.lang.Long>	otherUsers
protected Room	siegeCombatRoom
protected SiegableItem	siegeTarget
protected int	ticksFromHappen
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 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_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

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

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

dismountString, mountString, putString, rideBasis, riderCapacity, riders, rideString, stateString, stateSubjectStr

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

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

Method Summary

Modifier and Type	Method	Description
protected void	addPlayerAttacker(MOB M)
boolean	amDead()	Returns whether this is sunk or destroyed in a siege..
protected boolean	amInTacticalMode()
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	announceToUsers(java.lang.String msgStr)
protected void	clearTacticalMode()
protected void	clearTacticalModeInternal()
void	destroy()	Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
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.
PhysicalAgent	getCombatant()	If this mob is in combat, this returns the mob that this mob is targeting.
PairList<Item,int[]>	getCombatField()	Returns the combat field, which must be public to allow all participants too coordinate.
int	getDirectionToTarget()	Gets the compass direction between this combatant and the current combat victim.
protected int	getDirectionToTarget(PhysicalAgent dirTarget)
protected MOB	getFactoryAttacker(Room thisRoom)
protected int[]	getMagicCoords()
int	getMaxHullPoints()	Returns the number of base hull points that the given obj has.
protected java.util.List<MOB>	getPlayerAttackers()
int[]	getRanges()	Gets the raw minimum and maximum range of this weapon.
PairList<Weapon,int[]>	getSiegeWeaponAimings()	Returns the mapping of this objects siege weapons to the coordinates they are presently aimed at.
int[]	getTacticalCoords()	Returns the tactical coordinates of this object
protected int	getTacticalDistance(SiegableItem targetI)
java.lang.String	getTacticalView(SiegableItem viewer)	A unique display message for siegable objects and their relationship to this object.
java.lang.String	healthText(MOB viewer)	Returns the friendly viewable description of this mobs health status, from the given viewer mobs point of view.
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	isAnyoneAtCoords(int[] xy)
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.
boolean	isInCombat()	Returns whether this combatant is in an active combat state
Item	killMeDead(boolean createBody)	Puts this combatant in a dead state, removes all temporary effects, creates a corpse, ends combat, and sends mob players to their graveyard.
void	makePeace(boolean includePlayerFollowers)	Clears the combat state between this combatant and their target, clears the targets combat state, as well as that of any followers of this combatant.
int	maxRange()	the modified maximum range of this object, if applicable.
boolean	mayIFight(PhysicalAgent victim)	Returns whether this combatant is both permitted to attack the given combatant, and that both this combatant and the potential target are alive.
boolean	mayPhysicallyAttack(PhysicalAgent victim)	Returns whether this combatant is permitted to attack the given combatant, both this combatant and the potential target are alive, both the combatant and the target are confirmed to be the same place.
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	rangeToTarget()	Gets the distance between this combatant and the current combat victim.
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	setCombatant(PhysicalAgent other)	Sets the mob that this mob is targeting for combat, which either puts them into, or clears their combat state.
void	setRanges(int min, int max)	Sets the minimum and maximum range of this weapon.
void	setRangeToTarget(int newRange)	Sets the distance between this combatant and the current combat victim.
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.
protected java.lang.Boolean	startAttack(MOB sourceM, Room thisRoom, java.lang.String rest)
boolean	subjectToWearAndTear()	Whether the usesRemaining() number above is used to determine the percentage health of the item.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
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.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.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

amDestroyed, isSavable, setSavable

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

canSaveDatabaseID, databaseID, setDatabaseID

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

description, displayText, image, isGeneric, L, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

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

expirationDate, setExpirationDate

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

description, displayText, name

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 interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

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

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

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, 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, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, removeFromOwnerContainer, riding, sameAs, scripts, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, stopTicking, tackOns, text, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

addRider, affectPhyStats, amRiding, cloneFix, delRider, 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 interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name

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

minRange

protected int minRange

maxRange

protected int maxRange

ammoCapacity

protected int ammoCapacity

nextTacticalMoveDir

protected volatile int nextTacticalMoveDir

lastSpamCt

protected volatile int lastSpamCt

ticksFromHappen

protected volatile int ticksFromHappen

lastSpamMsg

protected volatile java.lang.String lastSpamMsg

otherUsers

protected PairList<MOB,java.lang.Long> otherUsers

siegeTarget

protected SiegableItem siegeTarget

siegeCombatRoom

protected Room siegeCombatRoom

coordinates

protected PairList<Item,int[]> coordinates

aiming

protected volatile int[] aiming

Constructor Detail

StdSiegeWeapon

public StdSiegeWeapon()

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 StdRideable

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 StdRideable

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

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

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.

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 StdRideable

See Also:

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

setRangeToTarget

public void setRangeToTarget(int newRange)

Description copied from interface: Combatant

Sets the distance between this combatant and the current combat victim. This method only matters if the combatant is in combat and getCombatant() returns a non-null value. This method does not reciprocate by setting the range to target of the combat target.

Specified by:

setRangeToTarget in interface Combatant

Parameters:

newRange - the range from this combatant to their target

See Also:

MOB.getVictim(), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.rangeToTarget(), Combatant.mayIFight(PhysicalAgent)

getDirectionToTarget

protected int getDirectionToTarget(PhysicalAgent dirTarget)

getMaxHullPoints

public final int getMaxHullPoints()

Description copied from interface: SiegableItem

Returns the number of base hull points that the given obj has.

Specified by:

getMaxHullPoints in interface SiegableItem

Returns:

the base hull points of the obj

rangeToTarget

public int rangeToTarget()

Description copied from interface: Combatant

Gets the distance between this combatant and the current combat victim. This method only matters if the combatant is in combat and getCombatant() returns a non-null value.

Specified by:

rangeToTarget in interface Combatant

Returns:

newRange the range from this combatant to their target

See Also:

MOB.getVictim(), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

mayPhysicallyAttack

public boolean mayPhysicallyAttack(PhysicalAgent victim)

Description copied from interface: Combatant

Returns whether this combatant is permitted to attack the given combatant, both this combatant and the potential target are alive, both the combatant and the target are confirmed to be the same place.

Specified by:

mayPhysicallyAttack in interface Combatant

Parameters:

victim - the potential combat target

Returns:

true if this combatant can attack the given combatant, false otherwise

See Also:

MOB.getVictim(), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.setRangeToTarget(int), Combatant.mayPhysicallyAttack(PhysicalAgent)

isInCombat

public boolean isInCombat()

Description copied from interface: Combatant

Returns whether this combatant is in an active combat state

Specified by:

isInCombat in interface Combatant

Returns:

true if this combatant is in combat, false otherwise

See Also:

MOB.getVictim(), MOB.setVictim(MOB), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.makePeace(boolean), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

amDead

public boolean amDead()

Description copied from interface: SiegableItem

Returns whether this is sunk or destroyed in a siege..

Specified by:

amDead in interface Combatant

Specified by:

amDead in interface SiegableItem

Returns:

true if this is sunk or destroyed in a siege

See Also:

Combatant.killMeDead(boolean), MOB.bringToLife(Room, boolean), MOB.removeFromGame(boolean, boolean)

mayIFight

public boolean mayIFight(PhysicalAgent victim)

Description copied from interface: Combatant

Returns whether this combatant is both permitted to attack the given combatant, and that both this combatant and the potential target are alive. Being in the same place is not necessary.

Specified by:

mayIFight in interface Combatant

Parameters:

victim - the potential combat target

Returns:

true if this combatant can fight the given combatant, false otherwise

See Also:

MOB.getVictim(), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.setRangeToTarget(int), Combatant.mayPhysicallyAttack(PhysicalAgent)

getMagicCoords

protected int[] getMagicCoords()

getTacticalDistance

protected int getTacticalDistance(SiegableItem targetI)

isAnyoneAtCoords

protected boolean isAnyoneAtCoords(int[] xy)

amInTacticalMode

protected boolean amInTacticalMode()

clearTacticalMode

protected void clearTacticalMode()

clearTacticalModeInternal

protected void clearTacticalModeInternal()

makePeace

public void makePeace(boolean includePlayerFollowers)

Description copied from interface: Combatant

Clears the combat state between this combatant and their target, clears the targets combat state, as well as that of any followers of this combatant. It is at best an approximation of a universal combat ender.

Specified by:

makePeace in interface Combatant

Parameters:

includePlayerFollowers - false to apply only to npc followers, true for npc and player

See Also:

Combatant.isInCombat(), MOB.getVictim(), MOB.setVictim(MOB), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

getCombatant

public PhysicalAgent getCombatant()

Description copied from interface: Combatant

If this mob is in combat, this returns the mob that this mob is targeting. If this method returns null, the mob is not in combat.

Specified by:

getCombatant in interface Combatant

Returns:

the combat target, or null for a peace state

See Also:

Combatant.isInCombat(), Combatant.setCombatant(PhysicalAgent), Combatant.makePeace(boolean), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

setCombatant

public void setCombatant(PhysicalAgent other)

Description copied from interface: Combatant

Sets the mob that this mob is targeting for combat, which either puts them into, or clears their combat state. If a null value, the mob is no longer fighting.

Specified by:

setCombatant in interface Combatant

Parameters:

other - the combat target, or null for a peace state

See Also:

Combatant.isInCombat(), Combatant.getCombatant(), Combatant.makePeace(boolean), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

getTacticalCoords

public int[] getTacticalCoords()

Description copied from interface: SiegableItem

Returns the tactical coordinates of this object

Specified by:

getTacticalCoords in interface SiegableItem

Returns:

the tactical coordinates of this object

getDirectionToTarget

public int getDirectionToTarget()

Description copied from interface: Combatant

Gets the compass direction between this combatant and the current combat victim. This method only matters if the combatant is in combat and getCombatant() returns a non-null value.

Specified by:

getDirectionToTarget in interface Combatant

Returns:

cardinal direction from this combatant to their target

See Also:

MOB.getVictim(), Combatant.setCombatant(PhysicalAgent), Combatant.getCombatant(), Combatant.setRangeToTarget(int), Combatant.mayIFight(PhysicalAgent)

getSiegeWeaponAimings

public PairList<Weapon,int[]> getSiegeWeaponAimings()

Description copied from interface: SiegableItem

Returns the mapping of this objects siege weapons to the coordinates they are presently aimed at. Each coordinate is int[x,y]

Specified by:

getSiegeWeaponAimings in interface SiegableItem

Returns:

the pairings of weapons to coordinates aimed at

destroy

public void destroy()

Description copied from interface: Contingent

Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java. Containers, rooms. and mobs who have their destroy() method called will also call the destroy() methods on all items and other objects listed as content, recursively.

Specified by:

destroy in interface Contingent

Overrides:

destroy in class StdRideable

getTacticalView

public java.lang.String getTacticalView(SiegableItem viewer)

Description copied from interface: SiegableItem

A unique display message for siegable objects and their relationship to this object. So, this method returns the relationship between this object and the given viewer object.

Specified by:

getTacticalView in interface SiegableItem

Parameters:

viewer - an object viewing this one

Returns:

a quick display message

getCombatField

public PairList<Item,int[]> getCombatField()

Description copied from interface: SiegableItem

Returns the combat field, which must be public to allow all participants too coordinate. If this siegable is not yet resolved, this may return null.

Specified by:

getCombatField in interface SiegableItem

Returns:

the field of combat or null if not yet set

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 StdRideable

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

getFactoryAttacker

protected MOB getFactoryAttacker(Room thisRoom)

startAttack

protected java.lang.Boolean startAttack(MOB sourceM,
                                        Room thisRoom,
                                        java.lang.String rest)

addPlayerAttacker

protected void addPlayerAttacker(MOB M)

getPlayerAttackers

protected java.util.List<MOB> getPlayerAttackers()

announceToUsers

public void announceToUsers(java.lang.String msgStr)

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 StdContainer

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

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 StdRideable

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

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.

healthText

public java.lang.String healthText(MOB viewer)

Description copied from interface: Combatant

Returns the friendly viewable description of this mobs health status, from the given viewer mobs point of view.

Specified by:

healthText in interface Combatant

Parameters:

viewer - the mob viewing this mob

Returns:

the friendly viewable health status string

killMeDead

public Item killMeDead(boolean createBody)

Description copied from interface: Combatant

Puts this combatant in a dead state, removes all temporary effects, creates a corpse, ends combat, and sends mob players to their graveyard.

Specified by:

killMeDead in interface Combatant

Parameters:

createBody - true to create a corpse, false otherwise

Returns:

the corpse, if one was created

See Also:

Combatant.amDead(), MOB.bringToLife(Room, boolean), MOB.removeFromGame(boolean, boolean)

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

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 StdRideable

Returns:

whether this item has a valid condition

recoverOwner

public void recoverOwner()