Package com.planet_ink.coffee_mud.Items.Basic

Class StdSiegableBoardable

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

com.planet_ink.coffee_mud.Items.Basic.StdBoardable

com.planet_ink.coffee_mud.Items.Basic.StdSiegableBoardable

All Implemented Interfaces:

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

Direct Known Subclasses:

GenSiegableBoardable, StdNavigableBoardable

public class StdSiegableBoardable
extends StdBoardable
implements 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 PairList<Weapon,int[]>	aimings
protected PairList<Item,int[]>	coordinates
protected java.util.Set<java.lang.String>	disableCmds
protected int	lastSpamCt
protected java.lang.String	lastSpamMsg
protected Room	siegeCombatRoom
protected SiegableItem	siegeTarget

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

NAME_REPL_MARKERS, NAME_REPL_STRINGS

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

area, head_offTheDeck, homePortID, internalPrice, noun_word, ownerName, price, readableText

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

closedText, dismountString, doorName, mountString, putString, rideString, stateString, stateSubjectStr, tempExitPairs

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

Method Summary

Modifier and Type	Method	Description
boolean	amDead()	Returns whether this is sunk or destroyed in a siege..
protected boolean	amInTacticalMode()
static void	appendCondition(java.lang.StringBuilder visualCondition, double pct, java.lang.String name)
protected void	clearTacticalMode()
protected void	clearTacticalModeInternal()
protected Item	doCombatDefeat(MOB victorM, boolean createBody)
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
protected SiegableItem.SiegeCommand	findSiegeCommand(java.lang.String word, java.lang.String secondWord)
protected void	fixArea(Area area)
Area	getArea()	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
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.
protected java.lang.String	getDirectionStrToTarget(SiegableItem siegeTarget)
int	getDirectionToTarget()	Gets the compass direction between this combatant and the current combat victim.
protected int	getDirectionToTarget(SiegableItem dirTarget)
protected MOB	getFactoryAttacker(Room thisRoom)
protected int	getLowestTacticalDistanceFromThis()
protected int[]	getMagicCoords()
int	getMaxHullPoints()	Returns the number of base hull points that the given obj has.
PairList<Weapon,int[]>	getSiegeWeaponAimings()	Returns the mapping of this objects siege weapons to the coordinates they are presently aimed at.
protected int[]	getTacticalCoordinates(SiegableItem targetI)
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	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isAnyoneAtCoords(int[] xy)
protected boolean	isASiegeWeaponReadyToFire(Item I)
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.
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.
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.
void	setArea(java.lang.String xml)	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
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	setRangeToTarget(int newRange)	Sets the distance between this combatant and the current combat victim.
void	setStat(java.lang.String code, java.lang.String val)	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
protected java.lang.Boolean	startAttack(MOB sourceM, Room thisRoom, java.lang.String rest)
protected static java.lang.String	staticL(java.lang.String str, java.lang.String... xs)
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.

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

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, 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.CloseableLockable

hasALock, isLocked, isOpen

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, destroy, 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, maxRange, minRange, 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, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, ultimateContainer, usesRemaining, value

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

getSaveStatIndex, getStat, getStatCodes, isStat

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, genericName, 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.StdBoardable

abilityImbuesMagic, announceToAllAboard, announceToNonOuterViewers, announceToOuterViewers, announceToOuterViewers, announceToOuterViewers, announceToOuterViewers, canViewOuterRoom, cleanMsgForRepeat, confirmAreaMessage, copyOf, createFirstRoom, destroy, destroyThisBoardable, dismountString, dockHere, expirationDate, findNearestDocks, getAreaClassType, getBoardableItem, getDestinationRoom, getHomePortID, getIsDocked, getOwnerName, getPrice, getRandomOutsideRoom, getTitleID, haveEveryoneLookOutside, isProperlyOwned, isSavable, keyName, mountString, newInstance, okAreaMessage, putString, readableText, rename, renameDestinationRooms, securityCheck, sendAreaMessage, sendAreaMessage, setDatabaseID, setDockableItem, setExpirationDate, setHomePortID, setKeyName, setMiscText, setOwnerName, setPrice, setReadableText, stopTicking, text, transferOwnership, unDock, value

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

canContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasALock, hasContent, isInside, isLocked, isOpen, numberOfItems, recursiveWeight, setCapacity, setContainTypes

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

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

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

addRider, amRiding, closedText, closeWord, defaultsClosed, defaultsLocked, delRider, displayText, doorName, exitUsage, fetchRider, genericName, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, getTemporaryExits, hasADoor, isMobileRideBasis, isReadable, lastRoomUsedFrom, mobileRideBasis, numRiders, openDelayTicks, openWord, recoverPhyStats, rideBasis, riderCapacity, riders, rideString, setDismountString, setDoorsNLocks, setExitParams, setMountString, setOpenDelayTicks, setPutString, setReadable, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, setTemporaryDoorLink, stateString, stateStringSubject, temporaryDoorLink, viewableText

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

aimings

protected PairList<Weapon,int[]> aimings

coordinates

protected PairList<Item,int[]> coordinates

siegeTarget

protected volatile SiegableItem siegeTarget

siegeCombatRoom

protected volatile Room siegeCombatRoom

lastSpamCt

protected volatile int lastSpamCt

lastSpamMsg

protected volatile java.lang.String lastSpamMsg

disableCmds

protected java.util.Set<java.lang.String> disableCmds

Constructor Detail

StdSiegableBoardable

public StdSiegableBoardable()

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 StdBoardable

Returns:

the name of this class

findSiegeCommand

protected SiegableItem.SiegeCommand findSiegeCommand(java.lang.String word,
                                                     java.lang.String secondWord)

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 StdBoardable

Returns:

whether this item has a valid condition

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)

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

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)

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)

fixArea

protected void fixArea(Area area)

getArea

public Area getArea()

Description copied from interface: Boardable

Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method returns the area object that represents the contents of the ship.

Specified by:

getArea in interface Boardable

Overrides:

getArea in class StdBoardable

Returns:

the official area version of this ship

setArea

public void setArea(java.lang.String xml)

Description copied from interface: Boardable

Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method sets the area object that represents the contents of the ship.

Specified by:

setArea in interface Boardable

Overrides:

setArea in class StdBoardable

Parameters:

xml - area xml for the ship

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

getTacticalCoordinates

protected int[] getTacticalCoordinates(SiegableItem targetI)

getTacticalDistance

protected int getTacticalDistance(SiegableItem targetI)

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

getLowestTacticalDistanceFromThis

protected int getLowestTacticalDistanceFromThis()

getMagicCoords

protected int[] getMagicCoords()

amInTacticalMode

protected boolean amInTacticalMode()

clearTacticalMode

protected void clearTacticalMode()

clearTacticalModeInternal

protected void clearTacticalModeInternal()

isAnyoneAtCoords

protected boolean isAnyoneAtCoords(int[] xy)

getDirectionToTarget

protected int getDirectionToTarget(SiegableItem dirTarget)

getDirectionStrToTarget

protected java.lang.String getDirectionStrToTarget(SiegableItem siegeTarget)

getFactoryAttacker

protected MOB getFactoryAttacker(Room thisRoom)

startAttack

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

isASiegeWeaponReadyToFire

protected final boolean isASiegeWeaponReadyToFire(Item I)

staticL

protected static java.lang.String staticL(java.lang.String str,
                                          java.lang.String... xs)

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

appendCondition

public static void appendCondition(java.lang.StringBuilder visualCondition,
                                   double pct,
                                   java.lang.String name)

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 StdBoardable

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

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 StdBoardable

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

doCombatDefeat

protected Item doCombatDefeat(MOB victorM,
                              boolean createBody)

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)

getMaxHullPoints

public 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

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 StdBoardable

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

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)

setStat

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

Description copied from interface: Modifiable

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

Specified by:

setStat in interface Modifiable

Overrides:

setStat in class StdItem

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()