Package com.planet_ink.coffee_mud.Items.Basic

Class GenStove

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

com.planet_ink.coffee_mud.Items.Basic.GenStove

All Implemented Interfaces:

Affectable, Behavable, CloseableLockable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Container, FuelConsumer, Item, Light, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenStove
extends GenContainer
implements Light, FuelConsumer

Nested Class Summary

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 boolean	destroyedWhenBurnedOut
protected int	durationTicks
protected int	fuelTickDown
protected int[]	generatedFuelTypes
protected boolean	goesOutInTheRain
protected boolean	lit
protected java.lang.String	readableText
protected int	ticksPerFuelConsume

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

Method Summary

Modifier and Type	Method	Description
boolean	consumeFuel(int amount)	Forces this fuel consumer to consumer some amount of its fuel, without any other effect.
boolean	destroyedWhenBurnedOut()	Gets whether this Light item automatically destroys itself after it is lit, and then its duration runs out.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
int[]	getConsumedFuelTypes()	Gets an array of RawMaterial codes representing the type of fuel that must be put inside this fuel container for it to consume it.
int	getDuration()	Gets the duration, in ticks, that this light object will emit light before stopping for whatever reason.
protected java.util.List<Item>	getFuel()
int	getFuelRemaining()	Returns the amount of fuel remaining in this container.
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.
int	getTicksPerFuelConsume()	Gets the number of ticks between each consumption of fuel.
int	getTotalFuelCapacity()	Returns the amount of total fuel this container can hold.
boolean	goesOutInTheRain()	Returns true if this particular light item is sensitive to rain and nasty weather such that rain or water will cause it to stop being lit.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isFuel(Item I)
boolean	isGeneric()	Whether the fields of this item are set in code, or set by builders.
boolean	isLit()	Gets whether this light item is presently emitting any light.
void	light(boolean isLit)	Sets whether this light item is presently emitting any light.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
java.lang.String	readableText()	For things that are readable, this returns the readable string for this thing.
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
void	setConsumedFuelType(int[] resources)	Sets an array of RawMaterial codes representing the type of fuel that must be put inside this fuel container for it to consume it.
void	setDestroyedWhenBurntOut(boolean truefalse)	Sets whether this Light item automatically destroys itself after it is lit, and then its duration runs out.
void	setDuration(int duration)	Sets the duration, in ticks, that this light object will emit light before stopping for whatever reason.
void	setMiscText(java.lang.String newText)	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
void	setOwner(ItemPossessor newOwner)	Sets the Room or MOB representing where this item is located.
void	setReadableText(java.lang.String text)	For things that are readable, this set the readable string for this thing.
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.
void	setTicksPerFuelConsume(int tick)	Sets the number of ticks between each consumption of fuel.
java.lang.String	text()	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
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.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

defaultsClosed, defaultsLocked, hasADoor, hasALock, isLocked, isOpen, keyName, openDelayTicks, setDoorsNLocks, setKeyName, setOpenDelayTicks

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.Items.interfaces.Container

canContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasContent, isInside, setCapacity, setContainTypes

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

canSaveDatabaseID, databaseID, setDatabaseID

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

keyName, setKeyName

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

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

isReadable, setReadable

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

riding, setRiding

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

canContain, capacity, containTypes, defaultsClosed, defaultsLocked, emptyPlease, genericName, getContents, getDeepContents, hasADoor, hasALock, hasContent, isInside, isLocked, isOpen, numberOfItems, openDelayTicks, recursiveWeight, setCapacity, setContainTypes, setDoorsNLocks, setOpenDelayTicks

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

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

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

readableText

protected java.lang.String readableText

lit

protected boolean lit

durationTicks

protected int durationTicks

destroyedWhenBurnedOut

protected boolean destroyedWhenBurnedOut

goesOutInTheRain

protected boolean goesOutInTheRain

generatedFuelTypes

protected int[] generatedFuelTypes

ticksPerFuelConsume

protected int ticksPerFuelConsume

fuelTickDown

protected volatile int fuelTickDown

Constructor Detail

GenStove

public GenStove()

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 GenContainer

Returns:

the name of this class

setDuration

public void setDuration(int duration)

Description copied from interface: Light

Sets the duration, in ticks, that this light object will emit light before stopping for whatever reason.

Specified by:

setDuration in interface Light

Parameters:

duration - the duration of the light source, in ticks.

See Also:

Light.getDuration()

getDuration

public int getDuration()

Description copied from interface: Light

Gets the duration, in ticks, that this light object will emit light before stopping for whatever reason.

Specified by:

getDuration in interface Light

Returns:

duration the duration of the light source, in ticks.

See Also:

Light.setDuration(int)

isGeneric

public boolean isGeneric()

Description copied from interface: Environmental

Whether the fields of this item are set in code, or set by builders. Generic means that they are set by builders, in which case XML is returned by the text() method containing all of the values for all the fields.

Specified by:

isGeneric in interface Environmental

Overrides:

isGeneric in class GenContainer

Returns:

whether this item is modifiable by builders

See Also:

Environmental.text()

text

public java.lang.String text()

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

text in interface Environmental

Overrides:

text in class GenContainer

Returns:

either an open internal text string, or XML

readableText

public java.lang.String readableText()

Description copied from interface: Readable

For things that are readable, this returns the readable string for this thing. That is to say, what the player sees when they read the door.

Specified by:

readableText in interface Readable

Overrides:

readableText in class GenContainer

Returns:

the readable string

See Also:

Readable.isReadable(), Readable.setReadable(boolean), Readable.setReadableText(String)

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Readable

For things that are readable, this set the readable string for this thing. That is to say, what the player sees when they read the door.

Specified by:

setReadableText in interface Readable

Overrides:

setReadableText in class GenContainer

Parameters:

text - the readable text

See Also:

Readable.isReadable(), Readable.setReadable(boolean), Readable.readableText()

setMiscText

public void setMiscText(java.lang.String newText)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class GenContainer

Parameters:

newText - either an open internal text string, or XML

getTicksPerFuelConsume

public int getTicksPerFuelConsume()

Description copied from interface: FuelConsumer

Gets the number of ticks between each consumption of fuel. This determines the rate of fuel consumption, assuming the amount of fuel itself is fixed, or determined internally. This is the only way variation in consumption is controlled from outside.

Specified by:

getTicksPerFuelConsume in interface FuelConsumer

Returns:

the number of ticks between each consumption of fuel.

See Also:

FuelConsumer.setTicksPerFuelConsume(int)

setTicksPerFuelConsume

public void setTicksPerFuelConsume(int tick)

Description copied from interface: FuelConsumer

Sets the number of ticks between each consumption of fuel. This determines the rate of fuel consumption, assuming the amount of fuel itself is fixed, or determined internally. This is the only way variation in consumption is controlled from outside.

Specified by:

setTicksPerFuelConsume in interface FuelConsumer

Parameters:

tick - the number of ticks between each consumption of fuel.

See Also:

FuelConsumer.getTicksPerFuelConsume()

getConsumedFuelTypes

public int[] getConsumedFuelTypes()

Description copied from interface: FuelConsumer

Gets an array of RawMaterial codes representing the type of fuel that must be put inside this fuel container for it to consume it.

Specified by:

getConsumedFuelTypes in interface FuelConsumer

Returns:

an array of RawMaterial codes

See Also:

FuelConsumer.setConsumedFuelType(int[]), RawMaterial

setConsumedFuelType

public void setConsumedFuelType(int[] resources)

Description copied from interface: FuelConsumer

Sets an array of RawMaterial codes representing the type of fuel that must be put inside this fuel container for it to consume it.

Specified by:

setConsumedFuelType in interface FuelConsumer

Parameters:

resources - an array of RawMaterial codes

See Also:

FuelConsumer.getConsumedFuelTypes(), RawMaterial

isFuel

protected boolean isFuel(Item I)

getFuelRemaining

public int getFuelRemaining()

Description copied from interface: FuelConsumer

Returns the amount of fuel remaining in this container.

Specified by:

getFuelRemaining in interface FuelConsumer

Returns:

the amount of fuel remaining in this container.

See Also:

FuelConsumer.getTotalFuelCapacity()

getFuel

protected java.util.List<Item> getFuel()

setOwner

public void setOwner(ItemPossessor newOwner)

Description copied from interface: Item

Sets the Room or MOB representing where this item is located. Containers are handled by another pointer, container(), so those two methods be used together to determine where a given item is. This method is called by the addItem method on mobs and the addItem interface on Rooms. Alone, this method is insufficient to properly determine an items location, so one of the two above should be called instead.

Specified by:

setOwner in interface Item

Overrides:

setOwner in class StdItem

Parameters:

newOwner - the mob or room where the item is located

See Also:

ItemCollection.addItem(Item)

consumeFuel

public boolean consumeFuel(int amount)

Description copied from interface: FuelConsumer

Forces this fuel consumer to consumer some amount of its fuel, without any other effect. If there was not enough fuel to be consumed, it might result in de-activation.

Specified by:

consumeFuel in interface FuelConsumer

Parameters:

amount - the amount of fuel to consume

Returns:

true if there was NOT enough fuel, false if fuel was consumed OK.

getTotalFuelCapacity

public int getTotalFuelCapacity()

Description copied from interface: FuelConsumer

Returns the amount of total fuel this container can hold.

Specified by:

getTotalFuelCapacity in interface FuelConsumer

Returns:

the amount of total fuel this container can hold.

See Also:

FuelConsumer.getFuelRemaining()

destroyedWhenBurnedOut

public boolean destroyedWhenBurnedOut()

Description copied from interface: Light

Gets whether this Light item automatically destroys itself after it is lit, and then its duration runs out.

Specified by:

destroyedWhenBurnedOut in interface Light

Returns:

true if it is destroyed after use, false otherwise

See Also:

Light.setDestroyedWhenBurntOut(boolean)

setDestroyedWhenBurntOut

public void setDestroyedWhenBurntOut(boolean truefalse)

Description copied from interface: Light

Sets whether this Light item automatically destroys itself after it is lit, and then its duration runs out.

Specified by:

setDestroyedWhenBurntOut in interface Light

Parameters:

truefalse - true if it is destroyed after use, false otherwise

See Also:

Light.destroyedWhenBurnedOut()

goesOutInTheRain

public boolean goesOutInTheRain()

Description copied from interface: Light

Returns true if this particular light item is sensitive to rain and nasty weather such that rain or water will cause it to stop being lit.

Specified by:

goesOutInTheRain in interface Light

Returns:

true if it goes out in the rain

isLit

public boolean isLit()

Description copied from interface: Light

Gets whether this light item is presently emitting any light.

Specified by:

isLit in interface Light

Returns:

true if it is lit and emitting light

See Also:

Light.light(boolean)

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 StdContainer

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

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 StdContainer

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

light

public void light(boolean isLit)

Description copied from interface: Light

Sets whether this light item is presently emitting any light.

Specified by:

light in interface Light

Parameters:

isLit - true if it is lit and emitting light

See Also:

Light.isLit()

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

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 GenContainer

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 GenContainer

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()

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 GenContainer

Returns:

list of the fields which may be set.

See Also:

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

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 GenContainer

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)