Package com.planet_ink.coffee_mud.Behaviors

Class Sounder

java.lang.Object

com.planet_ink.coffee_mud.Behaviors.StdBehavior

com.planet_ink.coffee_mud.Behaviors.Sounder

All Implemented Interfaces:

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

public class Sounder
extends StdBehavior

Field Summary

Fields

Modifier and Type	Field	Description
protected CMMsg	lastMsg
protected int	maxTicks
protected int	minTicks
protected boolean	oncePerRound1
protected static int	ROOM_MASK
protected java.lang.String[]	strings
protected static int	TICK_MASK
protected int	tickDown
protected int[]	triggers
protected static int	UNDER_MASK

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountForYourself()	Returns a string describing what this behavior does.
protected int	canImproveCode()
void	doEmote(Tickable ticking, java.lang.String emote)
protected void	emoteHere(Room room, MOB emoter, java.lang.String emote)
void	executeMsg(Environmental host, 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.
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.
protected void	tickReset()

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, externalFiles, flags, getBehaversMOB, getBehaversRoom, getCodeNum, getInternalCodeNum, getParms, getSaveStatIndex, getStat, getStatCodes, getTickStatus, grantsAggressivenessTo, I, initializeClass, isSavable, isStat, L, name, newInstance, okMessage, parmsFormat, registerDefaultQuest, sameAs, setSavable, setStat, startBehavior

Field Detail

minTicks

protected int minTicks

maxTicks

protected int maxTicks

tickDown

protected int tickDown

triggers

protected int[] triggers

strings

protected java.lang.String[] strings

UNDER_MASK

protected static int UNDER_MASK

TICK_MASK

protected static int TICK_MASK

ROOM_MASK

protected static int ROOM_MASK

lastMsg

protected CMMsg lastMsg

oncePerRound1

protected boolean oncePerRound1

Constructor Detail

Sounder

public Sounder()

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 StdBehavior

Returns:

the name of this class

canImproveCode

protected int canImproveCode()

Overrides:

canImproveCode in class StdBehavior

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.

tickReset

protected void tickReset()

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

emoteHere

protected void emoteHere(Room room,
                         MOB emoter,
                         java.lang.String emote)

doEmote

public void doEmote(Tickable ticking,
                    java.lang.String emote)

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

executeMsg

public void executeMsg(Environmental host,
                       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:

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

msg - the CMMsg that needs to be executed

See Also:

CMMsg