com.planet_ink.coffee_mud.Items.ClanItems
Class StdClanCommonItem

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.ClanItems.StdClanItem
          com.planet_ink.coffee_mud.Items.ClanItems.StdClanCommonItem

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, MsgListener, Rider, StatsAffecting, Tickable, ClanItem, Item, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenClanCommonItem

public class StdClanCommonItem
extends StdClanItem

Field Summary

protected boolean	glows
protected int	workDown

Fields inherited from class com.planet_ink.coffee_mud.Items.ClanItems.StdClanItem

ciType, myClan

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

affects, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

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

CI_ANTIPROPAGANDA, CI_BANNER, CI_CRAFTITEM, CI_DESC, CI_DONATEJOURNAL, CI_FLAG, CI_GATHERITEM, CI_GAVEL, CI_LEGALBADGE, CI_PROPAGANDA, CI_SPECIALAPRON, CI_SPECIALOTHER, CI_SPECIALSCALES, CI_SPECIALSCAVENGER, CI_SPECIALTAXER

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

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, 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_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

Constructor Summary

StdClanCommonItem()

Method Summary

void	affectEnvStats(Environmental affected, EnvStats stats) This method is called by the recoverEnvStats() method on other Environmental objects.
java.util.Vector	enCode(MOB M, java.lang.String req)
boolean	fireHere(Room R)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.util.Vector	resourceHere(MOB M, int material)
java.util.Vector	resourceHere(MOB M, java.util.Vector materials)
java.util.Vector	resourceHere(Room R, int material)
java.util.Vector	resourceHere(Room R, java.util.Vector materials)
void	setReadableText(java.lang.String newText) Changes the text that is written on the item.
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.
boolean	trackTo(MOB M, MOB M2)
boolean	trackTo(MOB M, Room R)

Methods inherited from class com.planet_ink.coffee_mud.Items.ClanItems.StdClanItem

ciType, clanID, executeMsg, loadList, loadRecipes, okMessage, rightfulOwner, setCIType, setClanID, setRightfulOwner, standardTick, stdExecuteMsg, stdOkMessage, stdOkMessageMOBS, wearingAClanItem

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

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, baseGoldValue, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, displayText, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

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

riding, setRiding

Field Detail

workDown

protected int workDown

glows

protected boolean glows

Constructor Detail

StdClanCommonItem

public StdClanCommonItem()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdClanItem

Returns:

the name of this class

fireHere

public boolean fireHere(Room R)

resourceHere

public java.util.Vector resourceHere(Room R,
                                     int material)

resourceHere

public java.util.Vector resourceHere(MOB M,
                                     int material)

resourceHere

public java.util.Vector resourceHere(Room R,
                                     java.util.Vector materials)

resourceHere

public java.util.Vector resourceHere(MOB M,
                                     java.util.Vector materials)

enCode

public java.util.Vector enCode(MOB M,
                               java.lang.String req)

affectEnvStats

public void affectEnvStats(Environmental affected,
                           EnvStats stats)

Description copied from interface: StatsAffecting

This method is called by the recoverEnvStats() method on other Environmental objects. It is used to transform the Environmental baseEnvStats() object into a finished envStats() object, both of which are objects implementing the EnvStats interface. See those methods for more information.

Specified by:

affectEnvStats in interface StatsAffecting

Overrides:

affectEnvStats in class StdItem

Parameters:

affected - the host of the EnvStats object being affected

stats - the particular EnvStats object being affected

See Also:

EnvStats, Environmental, Environmental.baseEnvStats(), Environmental.envStats(), Environmental.recoverEnvStats()

setReadableText

public void setReadableText(java.lang.String newText)

Description copied from interface: Item

Changes the text that is written on the item. This method does NOT set the IS_READABLE flag on the envStats().sensesMask flag. This flag is defined in the EnvStats interface

Specified by:

setReadableText in interface Item

Overrides:

setReadableText in class StdItem

Parameters:

newText - what is written on the item. Empty string means nothing.

See Also:

EnvStats

trackTo

public boolean trackTo(MOB M,
                       MOB M2)

trackTo

public boolean trackTo(MOB M,
                       Room R)

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 StdClanItem

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