com.planet_ink.coffee_mud.Behaviors
Class TaxCollector

java.lang.Object
  com.planet_ink.coffee_mud.Behaviors.StdBehavior
      com.planet_ink.coffee_mud.Behaviors.TaxCollector

All Implemented Interfaces:

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

public class TaxCollector
extends StdBehavior

Field Summary

protected DVector	demanded
protected long	graceTime
protected int	lastMonthChecked
static int	OWE_BACKTAXES
static int	OWE_CITIZENTAX
static int	OWE_FINES
static int	OWE_TOTAL
protected DVector	paid
protected java.util.HashSet	peopleWhoOwe
protected java.util.Vector	taxableProperties
protected Item	treasuryItem
protected java.lang.String	treasuryRoomID
protected long	waitTime

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_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_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

TaxCollector()

Method Summary

protected int	canImproveCode()
void	executeMsg(Environmental oking, CMMsg msg) The general message event handler for the object.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	okMessage(Environmental oking, CMMsg msg) The general message event previewer for the object.
void	setParms(java.lang.String newParms) 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.
double[]	totalMoneyOwed(MOB collector, MOB M)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

demanded

protected DVector demanded

paid

protected DVector paid

waitTime

protected long waitTime

graceTime

protected long graceTime

lastMonthChecked

protected int lastMonthChecked

taxableProperties

protected java.util.Vector taxableProperties

peopleWhoOwe

protected java.util.HashSet peopleWhoOwe

treasuryRoomID

protected java.lang.String treasuryRoomID

treasuryItem

protected Item treasuryItem

OWE_TOTAL

public static final int OWE_TOTAL

See Also:

Constant Field Values

OWE_CITIZENTAX

public static final int OWE_CITIZENTAX

See Also:

Constant Field Values

OWE_BACKTAXES

public static final int OWE_BACKTAXES

See Also:

Constant Field Values

OWE_FINES

public static final int OWE_FINES

See Also:

Constant Field Values

Constructor Detail

TaxCollector

public TaxCollector()

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

Overrides:

ID in class StdBehavior

Returns:

the name of this class

canImproveCode

protected int canImproveCode()

Overrides:

canImproveCode in class StdBehavior

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 StdBehavior

Parameters:

newParms - the parameter string for this behavior

See Also:

Behavior.getParms()

totalMoneyOwed

public double[] totalMoneyOwed(MOB collector,
                               MOB M)

executeMsg

public void executeMsg(Environmental oking,
                       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 StdBehavior

Parameters:

oking - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

okMessage

public boolean okMessage(Environmental oking,
                         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 StdBehavior

Parameters:

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

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