Package com.planet_ink.coffee_mud.Items.Basic

Class StdNavigableBoardable

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Basic.StdContainer

com.planet_ink.coffee_mud.Items.Basic.StdPortal

com.planet_ink.coffee_mud.Items.Basic.StdBoardable

com.planet_ink.coffee_mud.Items.Basic.StdSiegableBoardable

com.planet_ink.coffee_mud.Items.Basic.StdNavigableBoardable

All Implemented Interfaces:

Affectable, Behavable, CloseableLockable, CMObject, Combatant, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, PrivateProperty, Readable, Rideable, Rider, StatsAffecting, Tickable, Exit, Boardable, Container, Item, NavigableItem, SiegableItem, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenNavigableBoardable

public class StdNavigableBoardable
extends StdSiegableBoardable
implements NavigableItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StdNavigableBoardable.NavigatingCommand

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

Rideable.Basis

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.SiegableItem

SiegableItem.SiegeCommand

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	anchor_name
protected java.lang.String	anchor_verbed
protected boolean	anchorDown
protected int	courseDirection
protected java.util.List<java.lang.Integer>	courseDirections
protected int	directionFacing
protected Item	following
protected Room	prevItemRoom
protected java.util.List<Item>	smallTenderRequests
protected Item	tenderItem
protected int	ticksPerTurn
protected int	ticksSinceLastTurn
protected int	ticksSinceMove
protected java.lang.String	verb_sail
protected java.lang.String	verb_sailing

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Boardable

NAME_REPL_MARKERS, NAME_REPL_STRINGS

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.NavigableItem

COURSE_STEER_MASK

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdBoardable

area, head_offTheDeck, homePortID, internalPrice, noun_word, ownerName, price, readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containType, defaultsClosed, defaultsLocked, hasALid, hasALock, isLocked, isOpen, openDelayTicks

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdPortal

closedText, dismountString, doorName, mountString, putString, rideString, stateString, stateSubjectStr, tempExitPairs

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdSiegableBoardable

aimings, coordinates, disableCmds, lastSpamCt, lastSpamMsg, siegeCombatRoom, siegeTarget

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

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
StdNavigableBoardable()

Method Summary

Modifier and Type	Method	Description
protected boolean	beginNavigate(MOB mob, Room R, int dir)
protected boolean	canJumpFromHere(Room R)
boolean	canSteer(MOB mob, Room R)	Returns whether the given mob is allowed to steer the craft from the given internal room.
protected boolean	canTenderFromHere(Room R)
protected Room	createFirstRoom()
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
long	expirationDate()	If this object expires, it should have a timestamp saying when it expires, in real time.
protected StdNavigableBoardable.NavigatingCommand	findNavCommand(java.lang.String word, java.lang.String secondWord)
protected Room	findSafeRoom(Area A)
protected int	getAnyExitDir(Room R)
protected java.lang.String	getAreaClassType()
protected static MOB	getBestRider(Room R, Rideable rI)
protected int	getBottomCourse()
protected int[]	getCoordAdjustments(int[] newOnes)
java.util.List<java.lang.Integer>	getCurrentCourse()	Returns the future course of this ship.
int	getDirectionFacing()	Returns which direction the ship is currently facing.
protected int	getDirectionFacing(int direction)
protected java.util.List<java.lang.Integer>	getFollowingCourse(Item followingI)
protected int[]	getMagicCoords()
int	getMaxSpeed()	Returns this ships max speed, typically >= 1
java.lang.String	getTacticalView(SiegableItem viewer)	A unique display message for siegable objects and their relationship to this object.
protected int	getTopCourse()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isAnchorDown()	Returns whether the anchor is down, thus holding the ship in place.
Rideable.Basis	navBasis()	The type of navigable object this is.
boolean	navigate(int direction)	Forces a normal navigation move from the ships current location to the location in the given direction.
protected com.planet_ink.coffee_mud.Items.Basic.StdNavigableBoardable.NavResult	navMove(int direction)
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
protected static boolean	ownerSecurityCheck(java.lang.String ownerName, MOB mob)
protected boolean	preNavigateCheck(Room thisRoom, int direction, Room destRoom)
void	recoverPhyStats()	This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method.
protected int	removeTopCourse()
protected boolean	requiresSafetyMove()
protected boolean	safetyMove()
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
void	setAnchorDown(boolean truefalse)	Sets whether the anchor is down, thus holding the ship in place.
void	setCurrentCourse(java.util.List<java.lang.Integer> course)	Sets the future course of this ship.
void	setDirectionFacing(int direction)	Sets which direction the ship is currently facing.
void	setExpirationDate(long time)	If this object expires, it should have a timestamp saying when it expires, in real time.
void	setStat(java.lang.String code, java.lang.String val)	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
protected boolean	steer(MOB mob, Room R, int dir)
protected void	stopFollowing(MOB mob)
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
protected int	ticksPerTurn()

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, setBasePhyStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Boardable

dockHere, getArea, getBoardableItem, getHomePortID, getIsDocked, rename, securityCheck, setArea, setDockableItem, setHomePortID, unDock

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CloseableLockable

hasALock, isLocked, isOpen

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Combatant

getCombatant, getDirectionToTarget, healthText, isInCombat, killMeDead, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setCombatant, setRangeToTarget

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical

description, displayText, genericName, name

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable

isReadable, readableText, setReadable, setReadableText

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

addRider, amRiding, delRider, dismountString, fetchRider, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, isMobileRideBasis, mobileRideBasis, mountString, numRiders, putString, rideBasis, riderCapacity, riders, rideString, setDismountString, setMountString, setPutString, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, stateString, stateStringSubject

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.SiegableItem

amDead, getCombatField, getMaxHullPoints, getSiegeWeaponAimings, getTacticalCoords

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdBoardable

abilityImbuesMagic, announceToAllAboard, announceToNonOuterViewers, announceToOuterViewers, announceToOuterViewers, announceToOuterViewers, announceToOuterViewers, canViewOuterRoom, cleanMsgForRepeat, confirmAreaMessage, copyOf, destroy, destroyThisBoardable, dismountString, dockHere, findNearestDocks, getBoardableItem, getDestinationRoom, getHomePortID, getIsDocked, getOwnerName, getPrice, getRandomOutsideRoom, getTitleID, haveEveryoneLookOutside, isProperlyOwned, isSavable, keyName, mountString, newInstance, okAreaMessage, putString, readableText, rename, renameDestinationRooms, securityCheck, sendAreaMessage, sendAreaMessage, setDatabaseID, setDockableItem, setHomePortID, setKeyName, setMiscText, setOwnerName, setPrice, setReadableText, stopTicking, text, transferOwnership, unDock, value

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

canContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasALock, hasContent, isInside, isLocked, isOpen, numberOfItems, recursiveWeight, setCapacity, setContainTypes

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, displayText, eachBehavior, eachEffect, eachScript, effects, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, numBehaviors, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, removeFromOwnerContainer, riding, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDescription, setDisplayText, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setSavable, setSecretIdentity, setUsesRemaining, tackOns, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdPortal

addRider, amRiding, closedText, closeWord, defaultsClosed, defaultsLocked, delRider, displayText, doorName, exitUsage, fetchRider, genericName, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, getTemporaryExits, hasADoor, isMobileRideBasis, isReadable, lastRoomUsedFrom, mobileRideBasis, numRiders, openDelayTicks, openWord, rideBasis, riderCapacity, riders, rideString, setDismountString, setDoorsNLocks, setExitParams, setMountString, setOpenDelayTicks, setPutString, setReadable, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, setTemporaryDoorLink, stateString, stateStringSubject, temporaryDoorLink, viewableText

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdSiegableBoardable

amDead, amInTacticalMode, appendCondition, clearTacticalMode, clearTacticalModeInternal, doCombatDefeat, findSiegeCommand, fixArea, getArea, getCombatant, getCombatField, getDirectionStrToTarget, getDirectionToTarget, getDirectionToTarget, getFactoryAttacker, getLowestTacticalDistanceFromThis, getMaxHullPoints, getSiegeWeaponAimings, getTacticalCoordinates, getTacticalCoords, getTacticalDistance, healthText, isAnyoneAtCoords, isASiegeWeaponReadyToFire, isInCombat, killMeDead, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setArea, setCombatant, setRangeToTarget, startAttack, staticL, subjectToWearAndTear

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

courseDirection

protected volatile int courseDirection

anchorDown

protected volatile boolean anchorDown

courseDirections

protected final java.util.List<java.lang.Integer> courseDirections

directionFacing

protected volatile int directionFacing

ticksSinceMove

protected volatile int ticksSinceMove

ticksSinceLastTurn

protected volatile int ticksSinceLastTurn

tenderItem

protected volatile Item tenderItem

smallTenderRequests

protected java.util.List<Item> smallTenderRequests

prevItemRoom

protected volatile Room prevItemRoom

following

protected volatile Item following

ticksPerTurn

protected int ticksPerTurn

verb_sail

protected java.lang.String verb_sail

verb_sailing

protected java.lang.String verb_sailing

anchor_name

protected java.lang.String anchor_name

anchor_verbed

protected java.lang.String anchor_verbed

Constructor Detail

StdNavigableBoardable

public StdNavigableBoardable()

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 StdSiegableBoardable

Returns:

the name of this class

getAreaClassType

protected java.lang.String getAreaClassType()

Overrides:

getAreaClassType in class StdBoardable

createFirstRoom

protected Room createFirstRoom()

Overrides:

createFirstRoom in class StdBoardable

navBasis

public Rideable.Basis navBasis()

Description copied from interface: NavigableItem

The type of navigable object this is.

Specified by:

navBasis in interface NavigableItem

Returns:

the Basis* enum describing how this is navigated

See Also:

Rideable.Basis

recoverPhyStats

public void recoverPhyStats()

Description copied from interface: Affectable

This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method. Surrounding objects include the room where the object is located, the Ability objects in the Effects list, the Behaviors in the behaviors list, and race/charclass/area if applicable. Those methods will then make all necessary adjustments to the values in the new phyStats() object. When it returns, phyStats() will have a totally updated object. This method must be called in code whenever the object is placed on the map, or when anything changes in its environment, such as location, effects, or other states.

Specified by:

recoverPhyStats in interface Affectable

Overrides:

recoverPhyStats in class StdPortal

See Also:

Affectable.basePhyStats(), Affectable.phyStats(), Affectable.addEffect(Ability), Behavable.addBehavior(Behavior), PhyStats

findNavCommand

protected StdNavigableBoardable.NavigatingCommand findNavCommand(java.lang.String word,
                                                                 java.lang.String secondWord)

ticksPerTurn

protected int ticksPerTurn()

getMaxSpeed

public int getMaxSpeed()

Description copied from interface: NavigableItem

Returns this ships max speed, typically >= 1

Specified by:

getMaxSpeed in interface NavigableItem

Returns:

this ships max speed, typically >= 1

canTenderFromHere

protected boolean canTenderFromHere(Room R)

canSteer

public boolean canSteer(MOB mob,
                        Room R)

Description copied from interface: NavigableItem

Returns whether the given mob is allowed to steer the craft from the given internal room.

Specified by:

canSteer in interface NavigableItem

Parameters:

mob - the mob in the navigable area

R - the room in the navigable area

Returns:

true if steering can happen

stopFollowing

protected void stopFollowing(MOB mob)

canJumpFromHere

protected boolean canJumpFromHere(Room R)

okMessage

public boolean okMessage(Environmental myHost,
                         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 StdSiegableBoardable

Parameters:

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

getMagicCoords

protected int[] getMagicCoords()

Overrides:

getMagicCoords in class StdSiegableBoardable

getFollowingCourse

protected java.util.List<java.lang.Integer> getFollowingCourse(Item followingI)

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 StdSiegableBoardable

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

getBestRider

protected static MOB getBestRider(Room R,
                                  Rideable rI)

executeMsg

public void executeMsg(Environmental myHost,
                       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 StdSiegableBoardable

Parameters:

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

msg - the CMMsg that needs to be executed

See Also:

CMMsg

setExpirationDate

public void setExpirationDate(long time)

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

setExpirationDate in interface Expireable

Overrides:

setExpirationDate in class StdBoardable

Parameters:

time - the time stamp when this thing expires

See Also:

Expireable.expirationDate()

getTacticalView

public java.lang.String getTacticalView(SiegableItem viewer)

Description copied from interface: SiegableItem

A unique display message for siegable objects and their relationship to this object. So, this method returns the relationship between this object and the given viewer object.

Specified by:

getTacticalView in interface SiegableItem

Overrides:

getTacticalView in class StdSiegableBoardable

Parameters:

viewer - an object viewing this one

Returns:

a quick display message

expirationDate

public long expirationDate()

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

expirationDate in interface Expireable

Overrides:

expirationDate in class StdBoardable

Returns:

the time stamp when this thing expires

See Also:

Expireable.setExpirationDate(long)

getCoordAdjustments

protected int[] getCoordAdjustments(int[] newOnes)

getDirectionFacing

protected int getDirectionFacing(int direction)

setDirectionFacing

public void setDirectionFacing(int direction)

Description copied from interface: NavigableItem

Sets which direction the ship is currently facing.

Specified by:

setDirectionFacing in interface NavigableItem

Parameters:

direction - the direction the ship is facing.

preNavigateCheck

protected boolean preNavigateCheck(Room thisRoom,
                                   int direction,
                                   Room destRoom)

navigate

public boolean navigate(int direction)

Description copied from interface: NavigableItem

Forces a normal navigation move from the ships current location to the location in the given direction. This will also do tactical moves.

Specified by:

navigate in interface NavigableItem

Parameters:

direction - the direction to move

Returns:

true if it worked, false otherwise

navMove

protected com.planet_ink.coffee_mud.Items.Basic.StdNavigableBoardable.NavResult navMove(int direction)

steer

protected boolean steer(MOB mob,
                        Room R,
                        int dir)

beginNavigate

protected boolean beginNavigate(MOB mob,
                                Room R,
                                int dir)

getAnyExitDir

protected int getAnyExitDir(Room R)

findSafeRoom

protected Room findSafeRoom(Area A)

requiresSafetyMove

protected boolean requiresSafetyMove()

safetyMove

protected boolean safetyMove()

ownerSecurityCheck

protected static boolean ownerSecurityCheck(java.lang.String ownerName,
                                            MOB mob)

getDirectionFacing

public int getDirectionFacing()

Description copied from interface: NavigableItem

Returns which direction the ship is currently facing.

Specified by:

getDirectionFacing in interface NavigableItem

Returns:

the direction the ship is facing.

isAnchorDown

public boolean isAnchorDown()

Description copied from interface: NavigableItem

Returns whether the anchor is down, thus holding the ship in place.

Specified by:

isAnchorDown in interface NavigableItem

Returns:

true if the anchor is down, holding the ship in place.

setAnchorDown

public void setAnchorDown(boolean truefalse)

Description copied from interface: NavigableItem

Sets whether the anchor is down, thus holding the ship in place.

Specified by:

setAnchorDown in interface NavigableItem

Parameters:

truefalse - true if the anchor is down, false if the anchor is up

getTopCourse

protected int getTopCourse()

removeTopCourse

protected int removeTopCourse()

getBottomCourse

protected int getBottomCourse()

getCurrentCourse

public java.util.List<java.lang.Integer> getCurrentCourse()

Description copied from interface: NavigableItem

Returns the future course of this ship. A stop-course direction is always -1, so it is typically the last entry. Otherwise, each entry is a compass direction, possibly masked by COURSE_STEER_MASK in order to specify that it is a TURN ONLY. Directions not marked as turns are automatic movements in that direction.

Specified by:

getCurrentCourse in interface NavigableItem

Returns:

the future course of this ship.

See Also:

NavigableItem.setCurrentCourse(List)

setCurrentCourse

public void setCurrentCourse(java.util.List<java.lang.Integer> course)

Description copied from interface: NavigableItem

Sets the future course of this ship. A stop-course direction is always -1, so it is typically the last entry. Otherwise, each entry is a compass direction, possibly masked by COURSE_STEER_MASK in order to specify that it is a TURN ONLY. Directions not marked as turns are automatic movements in that direction.

Specified by:

setCurrentCourse in interface NavigableItem

Parameters:

course - the new course to set.

See Also:

NavigableItem.getCurrentCourse()

setStat

public void setStat(java.lang.String code,
                    java.lang.String val)

Description copied from interface: Modifiable

An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.

Specified by:

setStat in interface Modifiable

Overrides:

setStat in class StdSiegableBoardable

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()

sameAs

public boolean sameAs(Environmental E)

Description copied from interface: Environmental

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:

sameAs in interface Environmental

Overrides:

sameAs in class StdItem

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)