com.planet_ink.coffee_mud.Items.interfaces
Interface SailingShip

All Superinterfaces:

Affectable, Behavable, BoardableShip, java.lang.Cloneable, CMObject, Combatant, java.lang.Comparable<CMObject>, Contingent, DBIdentifiable, Environmental, Item, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rideable, Rider, StatsAffecting, Tickable, Wearable

All Known Implementing Classes:

GenSailingShip

public interface SailingShip
extends BoardableShip, Item, Combatant, Rideable

A Sailing Ship, which is an object that's boardable, rooms are attached to it so you can get in, and its an item that can appear in rooms, have speed and direction, be in combat, etc.

Nested Class Summary

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

Wearable.CODES

Field Summary

static int

COURSE_STEER_MASK

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

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

RIDEABLE_AIR, RIDEABLE_DESCS, RIDEABLE_ENTERIN, RIDEABLE_LADDER, RIDEABLE_LAND, RIDEABLE_SIT, RIDEABLE_SLEEP, RIDEABLE_TABLE, RIDEABLE_WAGON, RIDEABLE_WATER

Method Summary

java.util.List<java.lang.Integer>	getCurrentCourse() Returns the future course of this ship.
int	getDirectionFacing() Returns which direction the ship is currently facing.
int	getShipSpeed() Returns this ships max speed, typically >= 1
PairList<Weapon,int[]>	getSiegeWeaponAimings() Returns the mapping of this ships siege weapons to the coordinates they are presently aimed at.
boolean	isAnchorDown() Returns whether the anchor is down, thus holding the ship in place.
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 dir) Sets which direction the ship is currently facing.

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

dockHere, getHomePortID, getIsDocked, getShipArea, getShipItem, renameShip, setDockableItem, setHomePortID, setShipArea, unDock

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.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

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

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.Combatant

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

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.core.interfaces.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

COURSE_STEER_MASK

static final int COURSE_STEER_MASK

See Also:

Constant Field Values

Method Detail

getDirectionFacing

int getDirectionFacing()

Returns which direction the ship is currently facing.

Returns:

the direction the ship is facing.

setDirectionFacing

void setDirectionFacing(int dir)

Sets which direction the ship is currently facing.

Parameters:

dir - the direction the ship is facing.

isAnchorDown

boolean isAnchorDown()

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

Returns:

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

getShipSpeed

int getShipSpeed()

Returns this ships max speed, typically >= 1

Returns:

this ships max speed, typically >= 1

setAnchorDown

void setAnchorDown(boolean truefalse)

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

Parameters:

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

getSiegeWeaponAimings

PairList<Weapon,int[]> getSiegeWeaponAimings()

Returns the mapping of this ships siege weapons to the coordinates they are presently aimed at. Each coordinate is int[x,y]

Returns:

the pairings of weapons to coordinates aimed at

getCurrentCourse

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

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.

Returns:

the future course of this ship.

See Also:

setCurrentCourse(List)

setCurrentCourse

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

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.

Parameters:

course - the new course to set.

See Also:

getCurrentCourse()