com.planet_ink.coffee_mud.Behaviors
Class WaterCurrents.AWaterCurrent

java.lang.Object
  com.planet_ink.coffee_mud.Behaviors.WaterCurrents.AWaterCurrent

All Implemented Interfaces:

Ability, Behavable, CMModifiable, CMObject, Environmental, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Enclosing class:

WaterCurrents

protected static class WaterCurrents.AWaterCurrent
extends java.lang.Object
implements Ability, java.lang.Cloneable

Field Summary

protected Environmental	affected
protected boolean	amDestroyed
protected java.lang.String	miscText
protected boolean	savable

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_AIRBASED, FLAG_BINDING, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_INTOXICATING, FLAG_MOVING, FLAG_NOORDERING, FLAG_PARALYZING, FLAG_SUMMONING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT

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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY, TICKS_PER_RLMIN, TIME_MILIS_PER_MUDHOUR, TIME_TICK, TIME_TICK_DOUBLE

Constructor Summary

WaterCurrents.AWaterCurrent()

Method Summary

int	abilityCode() Returns an optional numeric value whose purpose is entirely contextual.
int	abstractQuality() Returns a constant value notifying the system of the general quality of the skill, whether it is malicious, beneficial, indifferent, or qualifiably beneficial (ok), as well as whether it is intended to target the invoker (self) or others.
java.lang.String	accountForYourself() For use by the identify spell, this should return a nice description of any properties incorporated by this effect.
void	addBehavior(Behavior to) Add a new behavior to this object.
void	addEffect(Ability to) Add a new effect to this object, whether permanent or temporary.
void	addNonUninvokableEffect(Ability to) Same as addEffect(Ability), but will set the Ability object as never being able to be uninvoked.
void	addScript(ScriptingEngine S) Add a new runnable script to this object.
int	adjustedLevel(MOB mob, int asLevel) This method calculates the strength level of this skill for the given mob, and taking into account the given override-level (asLevel).
void	affectCharState(MOB affectedMob, CharState affectableMaxState) This method is called by the recoverCharState() method on other MOB objects.
void	affectCharStats(MOB affectedMob, CharStats affectableStats) This method is called by the recoverCharStats() method on other MOB objects.
void	affectEnvStats(Environmental affected, EnvStats affectableStats) This method is called by the recoverEnvStats() method on other Environmental objects.
Environmental	affecting() Returns a reference to the room, item, mob, or exit that is currently being affected by this skill.
boolean	amDestroyed() Whether the destroy() method has been previousy called on this object.
boolean	appropriateToMyFactions(MOB mob) Returns whether there are any Faction reasons why the given mob should not use this skill.
boolean	autoInvocation(MOB mob) An autoinvocating ability is an ability which affects the mob just by having learned the ability.
EnvStats	baseEnvStats() Object containing a set of base, unmodified, mostly numeric fields.
boolean	bubbleAffect() This method is used to modify the behavior of the affectEnvStats, affectCharStats, and affectCharState methods.
boolean	canAffect(Environmental E) Returns whether, when used as a property/effect, this ability can affect the given object.
boolean	canAffect(int can_code) Returns whether, when used as a property/effect, this ability can affect the given type of object.
protected int	canAffectCode()
boolean	canBeLearnedBy(MOB teacher, MOB student) Returns whether the given student mob is able and allowed to learn this skill from the given teacher.
boolean	canBePracticedBy(MOB teacher, MOB student) Returns whether the given teacher mob is able and allowed to practice this skill with the given student *and* whether the student is able and allowed to practice this skill.
boolean	canBeTaughtBy(MOB teacher, MOB student) Returns whether the given teacher mob is able and allowed to teach this skill to the given student.
boolean	canBeUninvoked() Whether this skill is allowed to be uninvoked.
boolean	canTarget(Environmental E) Returns whether, when used as a skill, this ability can target itself at the given object.
boolean	canTarget(int can_code) Returns whether, when used as a skill, this ability can target itself at an object of the given type.
protected int	canTargetCode()
int	castingQuality(MOB mob, Environmental target) Serves a purpose similar to that of the Ability abstractQuality() method, but it determines a more exact quality based on a given invoker, target, and assumes an imminent use of the skill.
double	castingTime(MOB mob, java.util.Vector cmds) Returns the number of actions required to completely activate this skill.
int	classificationCode() Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
protected void	cloneFix(Ability E)
double	combatCastingTime(MOB mob, java.util.Vector cmds) Returns the number of actions required to completely activate this skill.
int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	delBehavior(Behavior to) Delete a behavior from this object.
void	delEffect(Ability to) Delete an effect from this object, whether permanent or temporary.
void	delScript(ScriptingEngine S) Remove a running script from this object.
java.lang.String	description() The basic description of this object, as shown when the item is directly LOOKed at.
void	destroy() Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
java.lang.String	displayText() Gets the raw string used to show what this object looks like in the room.
int	enchantQuality() Identical to abstractQuality() method, but returns a quality based on how the skill or spell behaves as a spell effect on a weapon or on armor.
EnvStats	envStats() Object containing a set of current, modified, usable, mostly numeric fields.
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
long	expirationDate() If this object expires, it should have a timestamp saying when it expires, in real time.
java.util.Vector	externalFiles() Any external files which may be required to make this ability work files returned by this method should not be base distrib files!
Behavior	fetchBehavior(int index) Returns a behavior object on this object.
Behavior	fetchBehavior(java.lang.String ID) Returns a behavior object listed on this object.
Ability	fetchEffect(int index) Returns an ability object listed as an effect on this object.
Ability	fetchEffect(java.lang.String ID) Returns an ability object listed as an effect on this object.
ScriptingEngine	fetchScript(int x) Retreive one of the enumerated scripts running on this object
protected void	finalize()
long	flags() Returns a bitmap giving some specific information about the scope and purpose of the skill.
protected int	getCodeNum(java.lang.String code)
int	getSaveStatIndex() Returns the index into the stat codes array where extra savable fields begins.
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.
long	getTickStatus() A coded status for this object during the period where its tick method is being called.
void	helpProficiency(MOB mob) This method should, occassionally, add to the proficiency the given mob has in this skill.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	image() Returns the fully qualified and determined name of the image file displayed for this object when MXP is used.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
boolean	invoke(MOB mob, Environmental target, boolean auto, int asLevel) This method is called when a player or the system invokes this skill, casts this spell, etc.
boolean	invoke(MOB mob, java.util.Vector commands, Environmental target, boolean auto, int asLevel) This method is called when a player or the system invokes this skill, casts this spell, etc.
MOB	invoker() Always returns the mob that invoked or initiated the skill or effect.
boolean	isAutoInvoked() An autoinvocating ability is an ability which affects the mob just by having learned the ability.
boolean	isGeneric() Whether the fields of this item are set in code, or set by builders.
boolean	isNowAnAutoEffect() An autoinvocating ability is an ability which affects the mob just by having learned the ability.
boolean	isStat(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.
void	makeLongLasting() If this ability has been added as as temporary effect, like sleep, or trip, or other typical spells, calling this method will make it so thatit will not do so on its own for a long long time.
void	makeNonUninvokable() Designates that this skill should never be uninvoked.
int	maxRange() the maximum range of this object, if applicable.
int	minRange() the minimum range of this object, if applicable.
java.lang.String	miscTextFormat() Unimplemented as of yet, but will hold a string telling the system what the proper format of any miscText data.
java.lang.String	name() The displayable name of this object.
java.lang.String	Name() The raw unmodified name of this object as stored in the database.
CMObject	newInstance() Returns a new instance of this class.
int	numBehaviors() The number of behaviors this object has.
int	numEffects() Returns the number of ability objects listed as effects on this object.
int	numScripts() Return the number of scripts running on this object
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
void	practice(MOB teacher, MOB student) Causes the student to practice this skill, presumably with the teacher mob.
int	practicesRequired(MOB mob) Returns practices required to learn this skill
boolean	preInvoke(MOB mob, java.util.Vector commands, Environmental givenTarget, boolean auto, int asLevel, int secondsElapsed, double actionsRemaining) This method is only called when the mob invoking this skill does not have enough actions to complete it immediately.
int	proficiency() Returns a number from 0-100 representing the percent of proficiency the mob or player who has this instance in their Abilities list has in this skill.
boolean	proficiencyCheck(MOB mob, int adjustment, boolean auto) Returns whether the given mob passes their proficiency check in this skill at this time.
boolean	putInCommandlist() Returns whether this skills triggerStrings should be places in the master list of commands, unlike properties or other hidden skills.
java.lang.String	rawImage() Returns the raw name of the image file to display for this object when MXP is used.
void	recoverEnvStats() This method copies the baseEnvStats() object into the envStats() object, then makes repeated calls to all surrounding objects with affectEnvStats(Environmental,EnvStats) method.
java.lang.String	requirements() Returns a string describing the requirements and qualifications that are required to learn this skill.
boolean	sameAs(Environmental E) Whether this object instance is functionally identical to the object passed in.
boolean	savable() Whether, if this object is in a room, whether it is appropriate to save this object to the database as a permanent feature of its container.
void	setAbilityCode(int newCode) Sets an optional numeric value whose purpose is entirely contextual.
void	setAffectedOne(Environmental being) Sets a reference to the room, item, mob, or exit that is currently being affected by this skill.
void	setBaseEnvStats(EnvStats newBaseEnvStats) Re-sets the object containing a set of base, unmodified, mostly numeric fields.
void	setDescription(java.lang.String newDescription) Sets the basic description of this object, as shown when the item is directly LOOKed at.
void	setDisplayText(java.lang.String newDisplayText) Sets the raw string used to show what this object looks like in the room.
void	setExpirationDate(long time) If this object expires, it should have a timestamp saying when it expires, in real time.
void	setImage(java.lang.String newImage) Sets the raw name of the image file to display for this object when MXP is used.
void	setInvoker(MOB mob) Sets or changes the mob that invoked or initated the skill or effect.
void	setMiscText(java.lang.String newMiscText) 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	setName(java.lang.String newName) Sets the raw unmodified name of this object as stored in the database.
void	setProficiency(int newProficiency) Sets a number from 0-100 representing the percent of proficiency the mob or player who has this instance in their Abilities list has in this skill.
void	setSavable(boolean truefalse) Returns whether this skill may be saved to the database, or whether it is strictly a run-time thing that should not be saved.
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	startTickDown(MOB invokerMOB, Environmental affected, int tickTime) Adds this Ability object as an effect on the given affected target, and sets it to unInvoke after the given number of ticks.
void	teach(MOB teacher, MOB student) Teaches this skill to the student mob, presumably from the teacher mob.
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.
int	trainsRequired(MOB mob) Returns trains required to learn this skill
java.lang.String[]	triggerStrings() A set of the command strings the user types to access this command when it is listed as a skill ability.
void	unInvoke() If this skill is uninvokable, this method will uninvoke it, remove it as an effect on the target, and shut it down.
int[]	usageCost(MOB mob, boolean ignoreClassOverride) Returns an integer array telling the system how much mana, movement, or hit points are required to invoke this skill.
int	usageType() Returns a bitmap made up of constants defined by Ability.USAGE_*.

Methods inherited from class java.lang.Object

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

Field Detail

savable

protected boolean savable

miscText

protected java.lang.String miscText

affected

protected Environmental affected

amDestroyed

protected boolean amDestroyed

Constructor Detail

WaterCurrents.AWaterCurrent

public WaterCurrents.AWaterCurrent()

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

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Environmental

The displayable name of this object. May be modified by envStats() object. Is derived from the Name().

Specified by:

name in interface Environmental

Specified by:

name in interface Tickable

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

Name

public java.lang.String Name()

Description copied from interface: Environmental

The raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

Name in interface Environmental

Returns:

the raw base name of this object on the map.

See Also:

Environmental.name()

description

public java.lang.String description()

Description copied from interface: Environmental

The basic description of this object, as shown when the item is directly LOOKed at.

Specified by:

description in interface Environmental

Returns:

the basic detail description of this object

displayText

public java.lang.String displayText()

Description copied from interface: Environmental

Gets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

displayText in interface Environmental

Returns:

the string describing how this object looks in the room

canAffectCode

protected int canAffectCode()

canTargetCode

protected int canTargetCode()

canTarget

public boolean canTarget(int can_code)

Description copied from interface: Ability

Returns whether, when used as a skill, this ability can target itself at an object of the given type. This method derives its answer from the protected integer method canTargetCode(), and requires one of the Ability.CAN_* constants.

Specified by:

canTarget in interface Ability

Parameters:

can_code - a bitmap of one or more Ability.CAN_* constants

Returns:

whether the object type is a valid target

See Also:

StdAbility.canTargetCode()

canAffect

public boolean canAffect(int can_code)

Description copied from interface: Ability

Returns whether, when used as a property/effect, this ability can affect the given type of object. This method derives its answer from the protected integer method canAffectCode(), and requires one of the Ability.CAN_* constants.

Specified by:

canAffect in interface Ability

Parameters:

can_code - a bitmap of one or more Ability.CAN_* constants

Returns:

whether the object object type may have this as a property/effect

See Also:

Ability, StdAbility.canAffectCode()

castingTime

public double castingTime(MOB mob,
                          java.util.Vector cmds)

Description copied from interface: Ability

Returns the number of actions required to completely activate this skill. A value of 0.0 means invoke instantly. This method only applies when the invoker is not in combat.

Specified by:

castingTime in interface Ability

Parameters:

mob - the potential caster

cmds - the potential command set

Returns:

the number of player free actions required to do this

See Also:

Ability.combatCastingTime(MOB, Vector)

combatCastingTime

public double combatCastingTime(MOB mob,
                                java.util.Vector cmds)

Description copied from interface: Ability

Returns the number of actions required to completely activate this skill. A value of 0.0 means invoke instantly. This method only applies when the invoker is in combat.

Specified by:

combatCastingTime in interface Ability

Parameters:

mob - the potential caster

cmds - the potential command set

Returns:

the number of player free actions required to do this

See Also:

Ability.castingTime(MOB, Vector)

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

abilityCode

public int abilityCode()

Description copied from interface: Ability

Returns an optional numeric value whose purpose is entirely contextual. For many skills, this reflects some sort of enhancement. Default is 0.

Specified by:

abilityCode in interface Ability

Returns:

the current optional numeric value or enhancement

setAbilityCode

public void setAbilityCode(int newCode)

Description copied from interface: Ability

Sets an optional numeric value whose purpose is entirely contextual. For many skills, this reflects some sort of enhancement. Default is 0.

Specified by:

setAbilityCode in interface Ability

Parameters:

newCode - the optional numeric value or enhancement

adjustedLevel

public int adjustedLevel(MOB mob,
                         int asLevel)

Description copied from interface: Ability

This method calculates the strength level of this skill for the given mob, and taking into account the given override-level (asLevel). The level returned should be based on a minimum baseline level (usually the class level of the class that qualifies for this skill at the lowest level), and should take into account the number of levels the mob has over and above that in appropriate classes

Specified by:

adjustedLevel in interface Ability

Parameters:

mob - the mob to evaluate the skill level of

asLevel - if greater than 0, this method always returns it

Returns:

the level of power the given mob has in this skill.

bubbleAffect

public boolean bubbleAffect()

Description copied from interface: Ability

This method is used to modify the behavior of the affectEnvStats, affectCharStats, and affectCharState methods. If this returns true, then those methods will be called only on the owner/mob of the item currently being affected by this skill. If false, those methods behave normally.

Specified by:

bubbleAffect in interface Ability

Returns:

whether this skill affects a mob owner of an item

See Also:

Item.owner()

practicesRequired

public int practicesRequired(MOB mob)

Description copied from interface: Ability

Returns practices required to learn this skill

Specified by:

practicesRequired in interface Ability

Returns:

number of practices to learn this skill

See Also:

Ability.trainsRequired(MOB)

trainsRequired

public int trainsRequired(MOB mob)

Description copied from interface: Ability

Returns trains required to learn this skill

Specified by:

trainsRequired in interface Ability

Returns:

number of trains to learn this skill

See Also:

Ability.practicesRequired(MOB)

flags

public long flags()

Description copied from interface: Ability

Returns a bitmap giving some specific information about the scope and purpose of the skill. The bitmap is composed of FLAG_* constants from the Ability interface.

Specified by:

flags in interface Ability

Returns:

FLAG_* constant based bitmap

See Also:

Ability

getTickStatus

public long getTickStatus()

Description copied from interface: Tickable

A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.

Specified by:

getTickStatus in interface Tickable

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

usageType

public int usageType()

Description copied from interface: Ability

Returns a bitmap made up of constants defined by Ability.USAGE_*. It lets the system know which of the values in the usageCost(MOB,boolean) method are relevant. It determines whether this skill requires mana, movement, hit points, or some combination of the three.

Specified by:

usageType in interface Ability

Returns:

a bitmap defined by Ability.USAGE_*

See Also:

Ability

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

expirationDate

public long expirationDate()

Description copied from interface: Environmental

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

expirationDate in interface Environmental

Returns:

the time stamp when this thing expires

See Also:

Environmental.setExpirationDate(long)

setExpirationDate

public void setExpirationDate(long time)

Description copied from interface: Environmental

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

setExpirationDate in interface Environmental

Parameters:

time - the time stamp when this thing expires

See Also:

Environmental.expirationDate()

setName

public void setName(java.lang.String newName)

Description copied from interface: Environmental

Sets the raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

setName in interface Environmental

Parameters:

newName - the raw base name of this object on the map.

See Also:

Environmental.Name()

setDescription

public void setDescription(java.lang.String newDescription)

Description copied from interface: Environmental

Sets the basic description of this object, as shown when the item is directly LOOKed at.

Specified by:

setDescription in interface Environmental

Parameters:

newDescription - the basic detail description of this object

setDisplayText

public void setDisplayText(java.lang.String newDisplayText)

Description copied from interface: Environmental

Sets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

setDisplayText in interface