com.planet_ink.coffee_mud.Behaviors
Class ProtectedCitizen

java.lang.Object
  com.planet_ink.coffee_mud.Behaviors.StdBehavior
      com.planet_ink.coffee_mud.Behaviors.ActiveTicker
          com.planet_ink.coffee_mud.Behaviors.ProtectedCitizen

All Implemented Interfaces:

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

public class ProtectedCitizen
extends ActiveTicker

Field Summary

protected java.lang.String	cityguard
protected java.lang.String[]	claims
protected static java.lang.String	defcityguard
protected static java.lang.String[]	defclaims
protected int	maxAssistance
protected int	radius
protected boolean	wander
protected static java.lang.String	zapper

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

chance, maxTicks, minTicks, tickDown

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

CODES, isSavableBehavior, parms

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.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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

ProtectedCitizen()

Method Summary

java.lang.String	accountForYourself() Returns a string describing what this behavior does.
boolean	assistMOB(MOB mob)
protected int	canImproveCode()
java.lang.String	getCityguardName()
java.lang.String[]	getClaims()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
void	setParms(java.lang.String parms) Sets the raw parameter string for this behavior.
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, getParmsNoTicks, rebuildParms, tickReset

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

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

Methods inherited from class java.lang.Object

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

Field Detail

zapper

protected static java.lang.String zapper

defcityguard

protected static java.lang.String defcityguard

defclaims

protected static java.lang.String[] defclaims

cityguard

protected java.lang.String cityguard

claims

protected java.lang.String[] claims

radius

protected int radius

maxAssistance

protected int maxAssistance

wander

protected boolean wander

Constructor Detail

ProtectedCitizen

public ProtectedCitizen()

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

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.

setParms

public void setParms(java.lang.String parms)

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:

parms - the parameter string for this behavior

See Also:

Behavior.getParms()

getCityguardName

public java.lang.String getCityguardName()

getClaims

public java.lang.String[] getClaims()

assistMOB

public boolean assistMOB(MOB mob)

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