Package com.planet_ink.coffee_mud.Items.ClanItems

Class GenClanCastle

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

com.planet_ink.coffee_mud.Items.Basic.GenSiegableBoardable

com.planet_ink.coffee_mud.Items.Basic.GenCastle

com.planet_ink.coffee_mud.Items.ClanItems.GenClanCastle

All Implemented Interfaces:

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

public class GenClanCastle
extends GenCastle
implements ClanItem

Nested Class Summary

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

ClanItem.ClanItemType

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 ClanItem.ClanItemType	ciType
protected int	holesInWalls
protected int	lastPctHealth
protected java.lang.String	myClan
protected long	targetExpire
protected Room	targetRoom

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

aimings, coordinates, disableCmds, lastSpamCt, lastSpamMsg, siegeCombatRoom, siegeTarget

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	clanID()	Returns the identifier for the specific Clan that this item serves.
protected Item	doCombatDefeat(MOB victorM, boolean createBody)
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
ClanItem.ClanItemType	getClanItemType()	Returns the type of clan item this is
protected Room	getDestinationRoom(Room fromRoom)
java.lang.String	getStat(java.lang.String code)	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String[]	getStatCodes()	Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
Environmental	rightfulOwner()	Clan Items have their mob owners tracked.
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
void	setClanID(java.lang.String ID)	Sets the specific clan that this item serves.
void	setClanItemType(ClanItem.ClanItemType type)	Sets the type of clan item this is
void	setRightfulOwner(Environmental E)	Clan Items have their mob owners tracked.
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.
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, setDescription, setDisplayText, setImage, setMiscText, setName, text

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

expirationDate, setExpirationDate

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

canViewOuterRoom, createFirstRoom, dismountString, findNearestDocks, genericName, getMaxHullPoints, isSuitableRoomToBuildIn, mountString

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

isGeneric, isLocalStatCode

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, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

getSaveStatIndex, 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, cleanMsgForRepeat, confirmAreaMessage, copyOf, destroy, destroyThisBoardable, dockHere, expirationDate, getAreaClassType, getBoardableItem, getHomePortID, getIsDocked, getOwnerName, getPrice, getRandomOutsideRoom, getTitleID, haveEveryoneLookOutside, isProperlyOwned, isSavable, keyName, 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, getTickStatus, I, image, initializeClass, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, numBehaviors, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, removeFromOwnerContainer, riding, 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, 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 class com.planet_ink.coffee_mud.Items.Basic.StdSiegableBoardable

amDead, amInTacticalMode, appendCondition, clearTacticalMode, clearTacticalModeInternal, findSiegeCommand, fixArea, getArea, getCombatant, getCombatField, getDirectionStrToTarget, getDirectionToTarget, getDirectionToTarget, getFactoryAttacker, getLowestTacticalDistanceFromThis, getMagicCoords, getSiegeWeaponAimings, getTacticalCoordinates, getTacticalCoords, getTacticalDistance, getTacticalView, healthText, isAnyoneAtCoords, isASiegeWeaponReadyToFire, isInCombat, killMeDead, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setArea, setCombatant, setRangeToTarget, startAttack, staticL, subjectToWearAndTear

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

ciType

protected ClanItem.ClanItemType ciType

myClan

protected java.lang.String myClan

holesInWalls

protected volatile int holesInWalls

lastPctHealth

protected volatile int lastPctHealth

targetRoom

protected volatile Room targetRoom

targetExpire

protected volatile long targetExpire

Constructor Detail

GenClanCastle

public GenClanCastle()

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 GenCastle

Returns:

the name of this class

rightfulOwner

public Environmental rightfulOwner()

Description copied from interface: ClanItem

Clan Items have their mob owners tracked. This is so that sneaky mechanisms for getting items away from clan member mobs can be thwarted by having them automatically returned. Only conquest can end an items usefulness... This method returns the room or mob owner that this item should remain with.

Specified by:

rightfulOwner in interface ClanItem

Returns:

the room or mob owner that this item should remain with.

setRightfulOwner

public void setRightfulOwner(Environmental E)

Description copied from interface: ClanItem

Clan Items have their mob owners tracked. This is so that sneaky mechanisms for getting items away from clan member mobs can be thwarted by having them automatically returned. Only conquest can end an items usefulness... This method sets the room or mob owner that this item should remain with.

Specified by:

setRightfulOwner in interface ClanItem

Parameters:

E - the room or mob owner that this item should remain with.

getClanItemType

public ClanItem.ClanItemType getClanItemType()

Description copied from interface: ClanItem

Returns the type of clan item this is

Specified by:

getClanItemType in interface ClanItem

Returns:

the type of clan item this is

See Also:

ClanItem.ClanItemType, ClanItem.setClanItemType(ClanItemType)

setClanItemType

public void setClanItemType(ClanItem.ClanItemType type)

Description copied from interface: ClanItem

Sets the type of clan item this is

Specified by:

setClanItemType in interface ClanItem

Parameters:

type - the type of clan item this is

See Also:

ClanItem.ClanItemType, ClanItem.getClanItemType()

clanID

public java.lang.String clanID()

Description copied from interface: ClanItem

Returns the identifier for the specific Clan that this item serves. There can be only one.

Specified by:

clanID in interface ClanItem

Returns:

the identifier for the specific Clan that this item serves. There can be only one.

See Also:

ClanItem.setClanID(String)

setClanID

public void setClanID(java.lang.String ID)

Description copied from interface: ClanItem

Sets the specific clan that this item serves.

Specified by:

setClanID in interface ClanItem

Parameters:

ID - the specific clan that this item serves.

See Also:

ClanItem.clanID()

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 GenCastle

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 GenCastle

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

doCombatDefeat

protected Item doCombatDefeat(MOB victorM,
                              boolean createBody)

Overrides:

doCombatDefeat in class GenCastle

getDestinationRoom

protected Room getDestinationRoom(Room fromRoom)

Overrides:

getDestinationRoom in class StdBoardable

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 StdSiegableBoardable

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

sameAs

public boolean sameAs(Environmental E)

Description copied from interface: Environmental

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:

sameAs in interface Environmental

Overrides:

sameAs in class GenCastle

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)

getStatCodes

public java.lang.String[] getStatCodes()

Description copied from interface: Modifiable

Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.

Specified by:

getStatCodes in interface Modifiable

Overrides:

getStatCodes in class GenSiegableBoardable

Returns:

list of the fields which may be set.

See Also:

Modifiable.getStat(String), Modifiable.setStat(String, String)

getStat

public java.lang.String getStat(java.lang.String code)

Description copied from interface: Modifiable

An alternative means of retreiving 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. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:

getStat in interface Modifiable

Overrides:

getStat in class GenSiegableBoardable

Parameters:

code - the name of the field to read.

Returns:

the value of the field read

See Also:

Modifiable.getStatCodes()

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 GenSiegableBoardable

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()