com.planet_ink.coffee_mud.Behaviors
Class BrotherHelper

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

All Implemented Interfaces:

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

public class BrotherHelper
extends StdBehavior

Field Summary

protected boolean	nameOnly
protected int	num

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

BrotherHelper()

Method Summary

void	executeMsg(Environmental affecting, 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.
static boolean	isBrother(MOB target, MOB observer, boolean nameOnly)
int	numAllowed()
void	setParms(java.lang.String parms) Sets the raw parameter string for this behavior.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

nameOnly

protected boolean nameOnly

num

protected int num

Constructor Detail

BrotherHelper

public BrotherHelper()

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

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 StdBehavior

Parameters:

parms - the parameter string for this behavior

See Also:

Behavior.getParms()

numAllowed

public int numAllowed()

isBrother

public static boolean isBrother(MOB target,
                                MOB observer,
                                boolean nameOnly)

executeMsg

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

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

msg - the CMMsg that needs to be executed

See Also:

CMMsg