Package com.planet_ink.coffee_mud.Behaviors

Class Mobile

java.lang.Object

com.planet_ink.coffee_mud.Behaviors.StdBehavior

com.planet_ink.coffee_mud.Behaviors.ActiveTicker

com.planet_ink.coffee_mud.Behaviors.Mobile

All Implemented Interfaces:

Behavior, MobileBehavior, CMObject, Contingent, Modifiable, MsgListener, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

MobileAggressive, MobileGoodGuardian

public class Mobile
extends ActiveTicker
implements MobileBehavior

Field Summary

Fields

Modifier and Type	Field	Description
protected int[]	altStatusTaker
protected boolean	dooropen
protected boolean	firstRun
protected int	leash
protected java.util.Map<Room,java.lang.Integer>	leashHash
protected static java.util.TreeMap<java.lang.String,java.lang.Integer>	localeMap
protected static java.util.Collection<java.lang.String>	localeTags
protected java.util.List<java.lang.Integer>	restrictedLocales
protected int	ticksSuspended
protected int	tickStatus
protected boolean	wander

Fields inherited from class com.planet_ink.coffee_mud.Behaviors.ActiveTicker

chance, grpCount, maxTicks, minGroup, minTicks, tickDown

Fields inherited from interface com.planet_ink.coffee_mud.Behaviors.interfaces.Behavior

CAN_AREAS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, FLAG_LEGALBEHAVIOR, FLAG_MOBILITY, FLAG_POTENTIALLYAGGRESSIVE, FLAG_POTENTIALLYAUTODEATHING, FLAG_TROUBLEMAKING

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Behaviors.StdBehavior

CODES, isSavableBehavior, parms

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
Mobile()

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountForYourself()	Returns a string describing what this behavior does.
protected int	canImproveCode()
boolean	emergencyMove(MOB mob, Room room)
long	flags()	Returns a bitmap made of up Behavior.FLAG_* constant masks which designates certain aspects about this behavior the rest of the system may need to know.
protected static java.util.TreeMap<java.lang.String,java.lang.Integer>	getLocaleMap()
static java.util.Collection<java.lang.String>	getMobileRemovables()
int	getTickStatus()	A coded status for this object during the period where its tick method is being called.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	okRoomForMe(MOB mob, Room currentRoom, Room newRoom, boolean ignoreAtmosphere)
void	setParms(java.lang.String newParms)	Sets the raw parameter string for this behavior.
void	suspendMobility(int numTicks)	Suspend mobility for a specified number of ticks
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.

Methods inherited from class com.planet_ink.coffee_mud.Behaviors.ActiveTicker

canAct, canChance, getCleanedParms, getParmsNoTicks, rebuildParms, tickReset

Methods inherited from interface com.planet_ink.coffee_mud.Behaviors.interfaces.Behavior

canImprove, canImprove, endBehavior, externalFiles, getParms, grantsAggressivenessTo, parmsFormat, registerDefaultQuest, setSavable, startBehavior

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

amDestroyed, destroy, isSavable

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

executeMsg, okMessage

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Behaviors.StdBehavior

amDestroyed, canActAtAll, canFreelyBehaveNormal, canImprove, canImprove, compareTo, copyOf, destroy, endBehavior, executeMsg, externalFiles, getBehaversMOB, getBehaversRoom, getCodeNum, getInternalCodeNum, getParms, getSaveStatIndex, getStat, getStatCodes, grantsAggressivenessTo, I, initializeClass, isSavable, isStat, L, name, newInstance, okMessage, parmsFormat, registerDefaultQuest, sameAs, setSavable, setStat, startBehavior

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

name

Field Detail

wander

protected boolean wander

dooropen

protected boolean dooropen

firstRun

protected boolean firstRun

leash

protected int leash

leashHash

protected java.util.Map<Room,java.lang.Integer> leashHash

restrictedLocales

protected java.util.List<java.lang.Integer> restrictedLocales

altStatusTaker

protected int[] altStatusTaker

tickStatus

protected int tickStatus

ticksSuspended

protected int ticksSuspended

localeMap

protected static final java.util.TreeMap<java.lang.String,java.lang.Integer> localeMap

localeTags

protected static final java.util.Collection<java.lang.String> localeTags

Constructor Detail

Mobile

public Mobile()

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 ActiveTicker

Returns:

the name of this class

canImproveCode

protected int canImproveCode()

Overrides:

canImproveCode in class ActiveTicker

flags

public long flags()

Description copied from interface: Behavior

Returns a bitmap made of up Behavior.FLAG_* constant masks which designates certain aspects about this behavior the rest of the system may need to know.

Specified by:

flags in interface Behavior

Overrides:

flags in class StdBehavior

Returns:

a bitmap made up of Behavior.FLAG_* constants

accountForYourself

public java.lang.String accountForYourself()

Description copied from interface: Behavior

Returns a string describing what this behavior does. Mostly for thought and behavior reading systems.

Specified by:

accountForYourself in interface Behavior

Overrides:

accountForYourself in class StdBehavior

Returns:

a string describing what this behavior does.

getTickStatus

public int 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

Overrides:

getTickStatus in class StdBehavior

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

okRoomForMe

public boolean okRoomForMe(MOB mob,
                           Room currentRoom,
                           Room newRoom,
                           boolean ignoreAtmosphere)

getLocaleMap

protected static final java.util.TreeMap<java.lang.String,java.lang.Integer> getLocaleMap()

getMobileRemovables

public static java.util.Collection<java.lang.String> getMobileRemovables()

setParms

public void setParms(java.lang.String newParms)

Description copied from interface: Behavior

Sets the raw parameter string for this behavior. Parameters are meant to modify or specify specific behavior of this Behavior.

Specified by:

setParms in interface Behavior

Overrides:

setParms in class ActiveTicker

Parameters:

newParms - the parameter string for this behavior

See Also:

Behavior.getParms()

emergencyMove

public boolean emergencyMove(MOB mob,
                             Room room)

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 StdBehavior

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

suspendMobility

public void suspendMobility(int numTicks)

Description copied from interface: MobileBehavior

Suspend mobility for a specified number of ticks

Specified by:

suspendMobility in interface MobileBehavior

Parameters:

numTicks - the number of ticks to suspend mobility for.