com.planet_ink.coffee_mud.Common.interfaces
Interface EnvStats

All Superinterfaces:
java.lang.Cloneable, CMCommon, CMModifiable, CMObject, java.lang.Comparable<CMObject>
All Known Implementing Classes:
DefaultEnvStats

public interface EnvStats
extends CMCommon, CMModifiable

The EnvStats interface is a state object that holds some basic information about just about every Environmental object in the game. Not all stats are relevant for ALL Environmentals, but most, especially the big ones. Environmentals always keep two instances of this object, a base one, representing his base unmodified state, and current one, representing his state after spells and other affects have had their say.

See Also:
CMModifiable, Affectable.baseEnvStats(), Affectable.envStats()

Field Summary
static long ALLMASK
          All bits in a Integer, cast into a long
static int CAN_NOT_BREATHE
          a bit setting, as from sensesMask(), flagging this mob as unable to breathe
static int CAN_NOT_HEAR
          a bit setting, as from sensesMask(), flagging this mob as unable to hear
static int CAN_NOT_MOVE
          a bit setting, as from sensesMask(), flagging this mob as unable to move
static int CAN_NOT_SEE
          a bit setting, as from sensesMask(), flagging this mob as unable to see
static int CAN_NOT_SMELL
          a bit setting, as from sensesMask(), flagging this mob as unable to smell
static int CAN_NOT_SPEAK
          a bit setting, as from sensesMask(), flagging this mob as unable to speak
static int CAN_NOT_TASTE
          a bit setting, as from sensesMask(), flagging this mob as unable to taste
static int CAN_SEE_BONUS
          a bit setting, as from sensesMask(), flagging this mob as able to see bonus
static java.lang.String[] CAN_SEE_CODES
          STAT codes list, indexed by the 2nd root of the various sensesMask() CAN_SEE bitmasks
static int CAN_SEE_DARK
          a bit setting, as from sensesMask(), flagging this mob as able to see dark
static java.lang.String[] CAN_SEE_DESCS
          Descriptions, indexed by the 2nd root of the various CAN_SEE sensesMask() bitmasks
static int CAN_SEE_EVIL
          a bit setting, as from sensesMask(), flagging this mob as able to see evil
static int CAN_SEE_GOOD
          a bit setting, as from sensesMask(), flagging this mob as able to see good
static int CAN_SEE_HIDDEN
          a bit setting, as from sensesMask(), flagging this mob as able to see hidden
static int CAN_SEE_INFRARED
          a bit setting, as from sensesMask(), flagging this mob as able to see infrared
static int CAN_SEE_INVISIBLE
          a bit setting, as from sensesMask(), flagging this mob as able to see invisible
static int CAN_SEE_METAL
          a bit setting, as from sensesMask(), flagging this mob as able to see metals
static int CAN_SEE_SNEAKERS
          a bit setting, as from sensesMask(), flagging this mob as able to see sneakers
static java.lang.String[] CAN_SEE_VERBS
          Descriptive verbs, indexed by the 2nd root of the various CAN_SEE sensesMask() bitmasks
static int CAN_SEE_VICTIM
          a bit setting, as from sensesMask(), flagging this mob as able to see their victims
static int IS_BONUS
          a bit setting, as from disposition(), flagging this object as being magical
static int IS_BOUND
          a bit setting, as from disposition(), flagging this object as being bound
static int IS_CATALOGED
          a bit setting, as from disposition(), flagging this object as being cataloged
static int IS_CLIMBING
          a bit setting, as from disposition(), flagging this object as climbing
static int IS_CLOAKED
          a bit setting, as from disposition(), flagging this object as being cloaked
static java.lang.String[] IS_CODES
          STAT codes, indexed by the 2nd root of the various IS_ disposition() bitmasks
static int IS_DARK
          a bit setting, as from disposition(), flagging this object as being in the dark
static java.lang.String[] IS_DESCS
          Descriptions, indexed by the 2nd root of the various IS_ disposition() bitmasks
static int IS_EVIL
          a bit setting, as from disposition(), flagging this object as being evil
static int IS_FALLING
          a bit setting, as from disposition(), flagging this object as falling
static int IS_FLYING
          a bit setting, as from disposition(), flagging this object as flying
static int IS_GLOWING
          a bit setting, as from disposition(), flagging this object as glowing
static int IS_GOLEM
          a bit setting, as from disposition(), flagging this object as being a golem
static int IS_GOOD
          a bit setting, as from disposition(), flagging this object as being good
static int IS_HIDDEN
          a bit setting, as from disposition(), flagging this object as being hidden
static int IS_INVISIBLE
          a bit setting, as from disposition(), flagging this object as being invisible
static int IS_LIGHTSOURCE
          a bit setting, as from disposition(), flagging this object as being a lightsource
static int IS_NOT_SEEN
          a bit setting, as from disposition(), flagging this object as not being seen
static int IS_SITTING
          a bit setting, as from disposition(), flagging this object as sitting/crawling
static int IS_SLEEPING
          a bit setting, as from disposition(), flagging this object as being asleep
static int IS_SNEAKING
          a bit setting, as from disposition(), flagging this object as sneaking
static int IS_SWIMMING
          a bit setting, as from disposition(), flagging this object as swimming
static int IS_UNSAVABLE
          a bit setting, as from disposition(), flagging this object as being unsavable
static java.lang.String[] IS_VERBS
          Descriptive verbs, indexed by the 2nd root of the various IS_ disposition() bitmasks
static int NUM_STATS
          the size of the internal stats integer array
static java.lang.String[] SENSE_CODES
          STAT codes list, indexed by the 2nd root of the various sensesMask() SENSE_ bitmasks
static int SENSE_CONTENTSUNSEEN
          a bit setting, as from sensesMask(), flagging this item/room as having unseeable contents
static int SENSE_ITEMNEVERSAVED
          a bit setting, as from sensesMask(), flagging this item/room as never being savable
static int SENSE_ITEMNODROP
          a bit setting, as from sensesMask(), flagging this item/room as undroppable
static int SENSE_ITEMNOMAXRANGE
          a bit setting, as from sensesMask(), flagging this item/room
static int SENSE_ITEMNOMINRANGE
          a bit setting, as from sensesMask(), flagging this item/room
static int SENSE_ITEMNOREMOVE
          a bit setting, as from sensesMask(), flagging this item/room as unremovable
static int SENSE_ITEMNORUIN
          a bit setting, as from sensesMask(), flagging this item/room as being unruinable
static int SENSE_ITEMNOTGET
          a bit setting, as from sensesMask(), flagging this item/room as ungettable
static int SENSE_ITEMREADABLE
          a bit setting, as from sensesMask(), flagging this item/room as readable
static int SENSE_ROOMGRIDSYNC
          a bit setting, as from sensesMask(), flagging this item/room as being flagged for synchronization
static int SENSE_ROOMNOMOVEMENT
          a bit setting, as from sensesMask(), flagging this item/room as not allowing movement
static int SENSE_ROOMUNEXPLORABLE
          a bit setting, as from sensesMask(), flagging this item/room as being unexplorable
static int SENSE_ROOMUNMAPPABLE
          a bit setting, as from sensesMask(), flagging this item/room as being unmappable
static int SENSE_UNLOCATABLE
          a bit setting, as from sensesMask(), flagging this item/room as being unlocatable
static int SENSE_UNUSEDMASK15
          a bit setting, as from sensesMask(), flagging this item/room
static int SENSE_UNUSEDMASK16
          a bit setting, as from sensesMask(), flagging this item/room
static int SENSE_UNUSEDMASK17
          a bit setting, as from sensesMask(), flagging this item/room
static int STAT_ABILITY
          an index into the internal stats integer array for ability
static int STAT_ARMOR
          an index into the internal stats integer array for armor
static int STAT_ATTACK
          an index into the internal stats integer array for attack
static int STAT_DAMAGE
          an index into the internal stats integer array for damage
static int STAT_DISPOSITION
          an index into the internal stats integer array for disposition
static int STAT_HEIGHT
          an index into the internal stats integer array for height
static int STAT_LEVEL
          an index into the internal stats integer array for level
static int STAT_REJUV
          an index into the internal stats integer array for rejuv
static int STAT_SENSES
          an index into the internal stats integer array for senses
static int STAT_WEIGHT
          an index into the internal stats integer array for weight
 
Method Summary
 int ability()
          Returns the ability level (a secondary level, e.g.
 void addAmbiance(java.lang.String ambiance)
          Adds an ambiance (extra word, visible field) to the list that are tacked onto the display text of this Environmental.
 java.lang.String[] ambiances()
          Returns a list of ambiances (extra words, visible fields) that are tacked onto the display text of this Environmental.
 int armor()
          Returns the defensive capability number of this Environmental.
 int attackAdjustment()
          Returns the rawcombat attack prowess of this Environmental Usually mobs or weapons
 void copyInto(EnvStats intoStats)
          Copies the internal data of this object into another of kind.
 int damage()
          Returns the maximum damaging ability of this Environmental
 void delAmbiance(java.lang.String ambiance)
          Removes an ambiance (extra word, visible field) from the list that are tacked onto the display text of this Environmental.
 int disposition()
          Returns a bitmask for disposition related flags of Environmentals (IS_ constants).
 java.lang.String getCombatStats()
          Returns a single string summary of several important stats from this object.
 int height()
          Returns the height of this Environmental, in inches
 int level()
          Returns the experience level of the mob, item, exit, Environmental.
 java.lang.String newName()
          Returns a modified name for this Environmental, usually null for no change.
 int rejuv()
          Returns the number of ticks before an Environmental removed from the game (due to death, destruction, or just removal from home) is restored.
 boolean sameAs(EnvStats E)
          Returns whether the given object is substantially the same as this one
 int sensesMask()
          Returns a bitmask for sense related flags of mobs (CAN_ constants), or miscellaneous runtime flags for items and other Environmentals (SENSE_ constants).
 void setAbility(int newAdjustment)
          Sets the ability level (a secondary level, e.g.
 void setAllValues(int def)
          Sets all the stats in this object to the given value
 void setArmor(int newArmor)
          Sets the defensive capability number of this Environmental.
 void setAttackAdjustment(int newAdjustment)
          Sets the rawcombat attack prowess of this Environmental Usually mobs or weapons
 void setDamage(int newDamage)
          Sets the maximum damaging ability of this Environmental
 void setDisposition(int newDisposition)
          Sets a bitmask for disposition related flags of Environmentals (IS_ constants).
 void setHeight(int newHeight)
          Sets the height of this Environmental, in inches
 void setLevel(int newLevel)
          Sets the experience level of the mob, item, exit, Environmental.
 void setName(java.lang.String newName)
          Sets a modified name for this Environmental, usually null for no change.
 void setRejuv(int newRejuv)
          Sets the number of ticks before an Environmental removed from the game (due to death, destruction, or just removal from home) is restored.
 void setSensesMask(int newMask)
          Sets a bitmask for sense related flags of mobs (CAN_ constants), or miscellaneous runtime flags for items and other Environmentals (SENSE_ constants).
 void setSpeed(double newSpeed)
          Sets the number of actions this mob can do per tick
 void setWeight(int newWeight)
          Sets the weight of this Environmental, in pounds.
 double speed()
          Returns the number of actions this mob can do per tick.
 int weight()
          Returns the weight of this Environmental, in pounds.
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMModifiable
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
 

Field Detail

STAT_LEVEL

static final int STAT_LEVEL
an index into the internal stats integer array for level

See Also:
Constant Field Values

STAT_SENSES

static final int STAT_SENSES
an index into the internal stats integer array for senses

See Also:
Constant Field Values

STAT_ARMOR

static final int STAT_ARMOR
an index into the internal stats integer array for armor

See Also:
Constant Field Values

STAT_DAMAGE

static final int STAT_DAMAGE
an index into the internal stats integer array for damage

See Also:
Constant Field Values

STAT_ATTACK

static final int STAT_ATTACK
an index into the internal stats integer array for attack

See Also:
Constant Field Values

STAT_DISPOSITION

static final int STAT_DISPOSITION
an index into the internal stats integer array for disposition

See Also:
Constant Field Values

STAT_REJUV

static final int STAT_REJUV
an index into the internal stats integer array for rejuv

See Also:
Constant Field Values

STAT_WEIGHT

static final int STAT_WEIGHT
an index into the internal stats integer array for weight

See Also:
Constant Field Values

STAT_ABILITY

static final int STAT_ABILITY
an index into the internal stats integer array for ability

See Also:
Constant Field Values

STAT_HEIGHT

static final int STAT_HEIGHT
an index into the internal stats integer array for height

See Also:
Constant Field Values

NUM_STATS

static final int NUM_STATS
the size of the internal stats integer array

See Also:
Constant Field Values

CAN_NOT_SEE

static final int CAN_NOT_SEE
a bit setting, as from sensesMask(), flagging this mob as unable to see

See Also:
Constant Field Values

CAN_SEE_HIDDEN

static final int CAN_SEE_HIDDEN
a bit setting, as from sensesMask(), flagging this mob as able to see hidden

See Also:
Constant Field Values

CAN_SEE_INVISIBLE

static final int CAN_SEE_INVISIBLE
a bit setting, as from sensesMask(), flagging this mob as able to see invisible

See Also:
Constant Field Values

CAN_SEE_EVIL

static final int CAN_SEE_EVIL
a bit setting, as from sensesMask(), flagging this mob as able to see evil

See Also:
Constant Field Values

CAN_SEE_GOOD

static final int CAN_SEE_GOOD
a bit setting, as from sensesMask(), flagging this mob as able to see good

See Also:
Constant Field Values

CAN_SEE_SNEAKERS

static final int CAN_SEE_SNEAKERS
a bit setting, as from sensesMask(), flagging this mob as able to see sneakers

See Also:
Constant Field Values

CAN_SEE_BONUS

static final int CAN_SEE_BONUS
a bit setting, as from sensesMask(), flagging this mob as able to see bonus

See Also:
Constant Field Values

CAN_SEE_DARK

static final int CAN_SEE_DARK
a bit setting, as from sensesMask(), flagging this mob as able to see dark

See Also:
Constant Field Values

CAN_SEE_INFRARED

static final int CAN_SEE_INFRARED
a bit setting, as from sensesMask(), flagging this mob as able to see infrared

See Also:
Constant Field Values

CAN_NOT_HEAR

static final int CAN_NOT_HEAR
a bit setting, as from sensesMask(), flagging this mob as unable to hear

See Also:
Constant Field Values

CAN_NOT_MOVE

static final int CAN_NOT_MOVE
a bit setting, as from sensesMask(), flagging this mob as unable to move

See Also:
Constant Field Values

CAN_NOT_SMELL

static final int CAN_NOT_SMELL
a bit setting, as from sensesMask(), flagging this mob as unable to smell

See Also:
Constant Field Values

CAN_NOT_TASTE

static final int CAN_NOT_TASTE
a bit setting, as from sensesMask(), flagging this mob as unable to taste

See Also:
Constant Field Values

CAN_NOT_SPEAK

static final int CAN_NOT_SPEAK
a bit setting, as from sensesMask(), flagging this mob as unable to speak

See Also:
Constant Field Values

CAN_NOT_BREATHE

static final int CAN_NOT_BREATHE
a bit setting, as from sensesMask(), flagging this mob as unable to breathe

See Also:
Constant Field Values

CAN_SEE_VICTIM

static final int CAN_SEE_VICTIM
a bit setting, as from sensesMask(), flagging this mob as able to see their victims

See Also:
Constant Field Values

CAN_SEE_METAL

static final int CAN_SEE_METAL
a bit setting, as from sensesMask(), flagging this mob as able to see metals

See Also:
Constant Field Values

SENSE_UNLOCATABLE

static final int SENSE_UNLOCATABLE
a bit setting, as from sensesMask(), flagging this item/room as being unlocatable

See Also:
Constant Field Values

SENSE_ITEMNOMINRANGE

static final int SENSE_ITEMNOMINRANGE
a bit setting, as from sensesMask(), flagging this item/room

See Also:
Constant Field Values

SENSE_ITEMNOMAXRANGE

static final int SENSE_ITEMNOMAXRANGE
a bit setting, as from sensesMask(), flagging this item/room

See Also:
Constant Field Values

SENSE_ITEMREADABLE

static final int SENSE_ITEMREADABLE
a bit setting, as from sensesMask(), flagging this item/room as readable

See Also:
Constant Field Values

SENSE_ITEMNOTGET

static final int SENSE_ITEMNOTGET
a bit setting, as from sensesMask(), flagging this item/room as ungettable

See Also:
Constant Field Values

SENSE_ITEMNODROP

static final int SENSE_ITEMNODROP
a bit setting, as from sensesMask(), flagging this item/room as undroppable

See Also:
Constant Field Values

SENSE_ITEMNOREMOVE

static final int SENSE_ITEMNOREMOVE
a bit setting, as from sensesMask(), flagging this item/room as unremovable

See Also:
Constant Field Values

SENSE_CONTENTSUNSEEN

static final int SENSE_CONTENTSUNSEEN
a bit setting, as from sensesMask(), flagging this item/room as having unseeable contents

See Also:
Constant Field Values

SENSE_ITEMNEVERSAVED

static final int SENSE_ITEMNEVERSAVED
a bit setting, as from sensesMask(), flagging this item/room as never being savable

See Also:
Constant Field Values

SENSE_ROOMUNEXPLORABLE

static final int SENSE_ROOMUNEXPLORABLE
a bit setting, as from sensesMask(), flagging this item/room as being unexplorable

See Also:
Constant Field Values

SENSE_ROOMNOMOVEMENT

static final int SENSE_ROOMNOMOVEMENT
a bit setting, as from sensesMask(), flagging this item/room as not allowing movement

See Also:
Constant Field Values

SENSE_ROOMUNMAPPABLE

static final int SENSE_ROOMUNMAPPABLE
a bit setting, as from sensesMask(), flagging this item/room as being unmappable

See Also:
Constant Field Values

SENSE_ROOMGRIDSYNC

static final int SENSE_ROOMGRIDSYNC
a bit setting, as from sensesMask(), flagging this item/room as being flagged for synchronization

See Also:
Constant Field Values

SENSE_ITEMNORUIN

static final int SENSE_ITEMNORUIN
a bit setting, as from sensesMask(), flagging this item/room as being unruinable

See Also:
Constant Field Values

SENSE_UNUSEDMASK15

static final int SENSE_UNUSEDMASK15
a bit setting, as from sensesMask(), flagging this item/room

See Also:
Constant Field Values

SENSE_UNUSEDMASK16

static final int SENSE_UNUSEDMASK16
a bit setting, as from sensesMask(), flagging this item/room

See Also:
Constant Field Values

SENSE_UNUSEDMASK17

static final int SENSE_UNUSEDMASK17
a bit setting, as from sensesMask(), flagging this item/room

See Also:
Constant Field Values

SENSE_CODES

static final java.lang.String[] SENSE_CODES
STAT codes list, indexed by the 2nd root of the various sensesMask() SENSE_ bitmasks


ALLMASK

static final long ALLMASK
All bits in a Integer, cast into a long

See Also:
Constant Field Values

IS_NOT_SEEN

static final int IS_NOT_SEEN
a bit setting, as from disposition(), flagging this object as not being seen

See Also:
Constant Field Values

IS_HIDDEN

static final int IS_HIDDEN
a bit setting, as from disposition(), flagging this object as being hidden

See Also:
Constant Field Values

IS_INVISIBLE

static final int IS_INVISIBLE
a bit setting, as from disposition(), flagging this object as being invisible

See Also:
Constant Field Values

IS_EVIL

static final int IS_EVIL
a bit setting, as from disposition(), flagging this object as being evil

See Also:
Constant Field Values

IS_GOOD

static final int IS_GOOD
a bit setting, as from disposition(), flagging this object as being good

See Also:
Constant Field Values

IS_SNEAKING

static final int IS_SNEAKING
a bit setting, as from disposition(), flagging this object as sneaking

See Also:
Constant Field Values

IS_BONUS

static final int IS_BONUS
a bit setting, as from disposition(), flagging this object as being magical

See Also:
Constant Field Values

IS_DARK

static final int IS_DARK
a bit setting, as from disposition(), flagging this object as being in the dark

See Also:
Constant Field Values

IS_GOLEM

static final int IS_GOLEM
a bit setting, as from disposition(), flagging this object as being a golem

See Also:
Constant Field Values

IS_SLEEPING

static final int IS_SLEEPING
a bit setting, as from disposition(), flagging this object as being asleep

See Also:
Constant Field Values

IS_SITTING

static final int IS_SITTING
a bit setting, as from disposition(), flagging this object as sitting/crawling

See Also:
Constant Field Values

IS_FLYING

static final int IS_FLYING
a bit setting, as from disposition(), flagging this object as flying

See Also:
Constant Field Values

IS_SWIMMING

static final int IS_SWIMMING
a bit setting, as from disposition(), flagging this object as swimming

See Also:
Constant Field Values

IS_GLOWING

static final int IS_GLOWING
a bit setting, as from disposition(), flagging this object as glowing

See Also:
Constant Field Values

IS_CLIMBING

static final int IS_CLIMBING
a bit setting, as from disposition(), flagging this object as climbing

See Also:
Constant Field Values

IS_FALLING

static final int IS_FALLING
a bit setting, as from disposition(), flagging this object as falling

See Also:
Constant Field Values

IS_LIGHTSOURCE

static final int IS_LIGHTSOURCE
a bit setting, as from disposition(), flagging this object as being a lightsource

See Also:
Constant Field Values

IS_BOUND

static final int IS_BOUND
a bit setting, as from disposition(), flagging this object as being bound

See Also:
Constant Field Values

IS_CLOAKED

static final int IS_CLOAKED
a bit setting, as from disposition(), flagging this object as being cloaked

See Also:
Constant Field Values

IS_UNSAVABLE

static final int IS_UNSAVABLE
a bit setting, as from disposition(), flagging this object as being unsavable

See Also:
Constant Field Values

IS_CATALOGED

static final int IS_CATALOGED
a bit setting, as from disposition(), flagging this object as being cataloged

See Also:
Constant Field Values

CAN_SEE_CODES

static final java.lang.String[] CAN_SEE_CODES
STAT codes list, indexed by the 2nd root of the various sensesMask() CAN_SEE bitmasks


CAN_SEE_DESCS

static final java.lang.String[] CAN_SEE_DESCS
Descriptions, indexed by the 2nd root of the various CAN_SEE sensesMask() bitmasks


CAN_SEE_VERBS

static final java.lang.String[] CAN_SEE_VERBS
Descriptive verbs, indexed by the 2nd root of the various CAN_SEE sensesMask() bitmasks


IS_CODES

static final java.lang.String[] IS_CODES
STAT codes, indexed by the 2nd root of the various IS_ disposition() bitmasks


IS_DESCS

static final java.lang.String[] IS_DESCS
Descriptions, indexed by the 2nd root of the various IS_ disposition() bitmasks


IS_VERBS

static final java.lang.String[] IS_VERBS
Descriptive verbs, indexed by the 2nd root of the various IS_ disposition() bitmasks

Method Detail

sensesMask

int sensesMask()
Returns a bitmask for sense related flags of mobs (CAN_ constants), or miscellaneous runtime flags for items and other Environmentals (SENSE_ constants).

Returns:
a bitmask made up of SENSE_ constants or CAN_ constants
See Also:
SENSE_ITEMNEVERSAVED, CAN_NOT_SEE, setSensesMask(int)

setSensesMask

void setSensesMask(int newMask)
Sets a bitmask for sense related flags of mobs (CAN_ constants), or miscellaneous runtime flags for items and other Environmentals (SENSE_ constants).

Parameters:
newMask - a bitmask made up of SENSE_ constants or CAN_ constants
See Also:
SENSE_ITEMNEVERSAVED, CAN_NOT_SEE, setSensesMask(int)

disposition

int disposition()
Returns a bitmask for disposition related flags of Environmentals (IS_ constants).

Returns:
a bitmask of disposition related flags
See Also:
IS_BONUS, setDisposition(int)

setDisposition

void setDisposition(int newDisposition)
Sets a bitmask for disposition related flags of Environmentals (IS_ constants).

Parameters:
newDisposition - a bitmask of disposition flags
See Also:
IS_BONUS, disposition()

level

int level()
Returns the experience level of the mob, item, exit, Environmental.

Returns:
the experience level
See Also:
setLevel(int)

setLevel

void setLevel(int newLevel)
Sets the experience level of the mob, item, exit, Environmental.

Parameters:
newLevel - the new experience level
See Also:
level()

ability

int ability()
Returns the ability level (a secondary level, e.g. if magical, how much?) Also acts as a random flag for various purposes. For instance, on mobs, it designates a hit point multiplier.

Returns:
the ability level (or misc integer)
See Also:
setAbility(int)

setAbility

void setAbility(int newAdjustment)
Sets the ability level (a secondary level, e.g. if magical, how much?) Also acts as a random flag for various purposes. For instance, on mobs, it designates a hit point multiplier.

Parameters:
newAdjustment - the new ability level (or misc integer)
See Also:
ability()

rejuv

int rejuv()
Returns the number of ticks before an Environmental removed from the game (due to death, destruction, or just removal from home) is restored.

Returns:
the number of ticks before rejuv (0==never)
See Also:
setRejuv(int)

setRejuv

void setRejuv(int newRejuv)
Sets the number of ticks before an Environmental removed from the game (due to death, destruction, or just removal from home) is restored.

Parameters:
newRejuv - the new number of ticks before rejuv (0==never)
See Also:
rejuv()

weight

int weight()
Returns the weight of this Environmental, in pounds.

Returns:
the weight of this Environmental
See Also:
setWeight(int)

setWeight

void setWeight(int newWeight)
Sets the weight of this Environmental, in pounds.

Parameters:
newWeight - the new weight of this Environmental
See Also:
weight()

height

int height()
Returns the height of this Environmental, in inches

Returns:
the height of this Environmental, in inches (0=indeterminate)
See Also:
setHeight(int)

setHeight

void setHeight(int newHeight)
Sets the height of this Environmental, in inches

Parameters:
newHeight - the new height of this Environmental, in inches (0=indeterminate)
See Also:
height()

armor

int armor()
Returns the defensive capability number of this Environmental.

Returns:
the raw defensive capability of this Environmental
See Also:
setArmor(int)

setArmor

void setArmor(int newArmor)
Sets the defensive capability number of this Environmental.

Parameters:
newArmor - the defensive capability number of this Environmental
See Also:
armor()

damage

int damage()
Returns the maximum damaging ability of this Environmental

Returns:
the maxiumu damaging ability of this Environmental
See Also:
setDamage(int)

setDamage

void setDamage(int newDamage)
Sets the maximum damaging ability of this Environmental

Parameters:
newDamage - the new maximum damaging ability of this Environmental
See Also:
damage()

speed

double speed()
Returns the number of actions this mob can do per tick.

Returns:
the number of actions per tick.
See Also:
setSpeed(double)

setSpeed

void setSpeed(double newSpeed)
Sets the number of actions this mob can do per tick

Parameters:
newSpeed - the new number of actions this mob can do per tick
See Also:
speed()

attackAdjustment

int attackAdjustment()
Returns the rawcombat attack prowess of this Environmental Usually mobs or weapons

Returns:
the raw combat attack prowess of this Environmental
See Also:
setAttackAdjustment(int)

setAttackAdjustment

void setAttackAdjustment(int newAdjustment)
Sets the rawcombat attack prowess of this Environmental Usually mobs or weapons

Parameters:
newAdjustment - the new raw combat attack prowess of this Environmental
See Also:
attackAdjustment()

newName

java.lang.String newName()
Returns a modified name for this Environmental, usually null for no change.

Returns:
the modified name, or null
See Also:
setName(String)

setName

void setName(java.lang.String newName)
Sets a modified name for this Environmental, usually null for no change.

Parameters:
newName - the modified name, or null
See Also:
newName()

ambiances

java.lang.String[] ambiances()
Returns a list of ambiances (extra words, visible fields) that are tacked onto the display text of this Environmental.

Returns:
a list of ambiances
See Also:
addAmbiance(String), delAmbiance(String)

addAmbiance

void addAmbiance(java.lang.String ambiance)
Adds an ambiance (extra word, visible field) to the list that are tacked onto the display text of this Environmental.

Parameters:
ambiance - a new ambiance string
See Also:
ambiances(), delAmbiance(String)

delAmbiance

void delAmbiance(java.lang.String ambiance)
Removes an ambiance (extra word, visible field) from the list that are tacked onto the display text of this Environmental.

Parameters:
ambiance - the old ambiance string

getCombatStats

java.lang.String getCombatStats()
Returns a single string summary of several important stats from this object.

Returns:
a single string summary of several important stats from this object.

sameAs

boolean sameAs(EnvStats E)
Returns whether the given object is substantially the same as this one

Parameters:
E - the EnvStats to compare to
Returns:
whether or not they are the same

copyInto

void copyInto(EnvStats intoStats)
Copies the internal data of this object into another of kind.

Parameters:
intoStats - another EnvStats object.

setAllValues

void setAllValues(int def)
Sets all the stats in this object to the given value

Parameters:
def - a value to set all the stats to