Package com.planet_ink.coffee_mud.Behaviors

Class Sailor

java.lang.Object

com.planet_ink.coffee_mud.Behaviors.StdBehavior

com.planet_ink.coffee_mud.Behaviors.Sailor

All Implemented Interfaces:

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

public class Sailor
extends StdBehavior

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	aggressive
protected boolean	aggrLvlChk
protected MaskingLibrary.CompiledZMask	aggrMask
protected java.lang.String	aggrMaskStr
protected boolean	aggrMobs
protected boolean	areaOnly
protected boolean	boarder
protected boolean	combatIsOver
protected boolean	combatMover
protected boolean	combatTech
protected int	complaintTick
protected boolean	defender
protected Boardable	loyalShipArea
protected Item	loyalShipItem
protected boolean	peaceMover
protected Rideable	targetShipItem
protected int	tickBonus
protected int	tickDown
protected int	tickWait
protected boolean	wimpy

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountForYourself()	Returns a string describing what this behavior does.
protected boolean	amInTrouble()
boolean	amOnMyShip(MOB M)
protected boolean	canMoveShip()
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	executeMsg(Environmental affecting, CMMsg msg)	The general message event handler for the object.
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 int	getEscapeRoute(int directionToTarget)
Item	getShip(MOB M)
boolean	grantsAggressivenessTo(MOB M)	Returns the result of a very specific test, namely whether this behavior would be the direct cause of a malicious act against the given MOB object.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isGoodShipDir(Room shipR, int dir)
boolean	isMyShipInCombat(MOB M)
boolean	okMessage(Environmental host, 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.
boolean	tryMend(MOB mob)
boolean	tryTrawl(MOB mob)

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

Field Detail

tickDown

protected volatile int tickDown

tickWait

protected int tickWait

tickBonus

protected int tickBonus

loyalShipArea

protected Boardable loyalShipArea

loyalShipItem

protected Item loyalShipItem

targetShipItem

protected Rideable targetShipItem

combatIsOver

protected boolean combatIsOver

peaceMover

protected boolean peaceMover

combatMover

protected boolean combatMover

combatTech

protected boolean combatTech

boarder

protected boolean boarder

defender

protected boolean defender

aggressive

protected boolean aggressive

aggrMobs

protected boolean aggrMobs

aggrLvlChk

protected boolean aggrLvlChk

aggrMask

protected MaskingLibrary.CompiledZMask aggrMask

aggrMaskStr

protected java.lang.String aggrMaskStr

areaOnly

protected boolean areaOnly

wimpy

protected boolean wimpy

complaintTick

protected volatile int complaintTick

Constructor Detail

Sailor

public Sailor()

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

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.

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

getShip

public Item getShip(MOB M)

amOnMyShip

public boolean amOnMyShip(MOB M)

isMyShipInCombat

public boolean isMyShipInCombat(MOB M)

grantsAggressivenessTo

public boolean grantsAggressivenessTo(MOB M)

Description copied from interface: Behavior

Returns the result of a very specific test, namely whether this behavior would be the direct cause of a malicious act against the given MOB object.

Specified by:

grantsAggressivenessTo in interface Behavior

Overrides:

grantsAggressivenessTo in class StdBehavior

Parameters:

M - the target to test for maliciousness to

Returns:

whether this behavior would harm the mob

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

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Overrides:

copyOf in class StdBehavior

Returns:

a clone of this object

okMessage

public boolean okMessage(Environmental host,
                         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:

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

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

tryMend

public boolean tryMend(MOB mob)

tryTrawl

public boolean tryTrawl(MOB mob)

amInTrouble

protected boolean amInTrouble()

isGoodShipDir

protected boolean isGoodShipDir(Room shipR,
                                int dir)

getEscapeRoute

protected int getEscapeRoute(int directionToTarget)

canMoveShip

protected boolean canMoveShip()

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