com.planet_ink.coffee_mud.Items.interfaces
Interface BoardableShip

All Superinterfaces:

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

All Known Subinterfaces:

SailingShip, SpaceShip

All Known Implementing Classes:

GenSailingShip, GenSpaceShip, StdBoardable, StdBoardableShip, StdSpaceShip

public interface BoardableShip
extends Environmental

A Boardable Ship, which is an object that's boardable, rooms are attached to it so you can get in.

Field Summary

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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Method Summary

void	dockHere(Room R) Designates that this ship is landed and docked in the given planetary room.
java.lang.String	getHomePortID() Returns the room ID of the ships home port.
Room	getIsDocked() Returns the Room where this ship is docked, or NULL if in space.
Area	getShipArea() Space ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
Item	getShipItem() Ships are unique in having an Item stand-in for port-side access, as well as an Area object.
void	renameShip(java.lang.String newName) Renames the ship to something else
void	setDockableItem(Item dockableItem) When a boardable ship area is created, it is bound to an item that resides in a room when docked, or possibly, always.
void	setHomePortID(java.lang.String portID) Sets the room ID of the ships home port
void	setShipArea(java.lang.String xml) Space ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
Room	unDock(boolean moveToOutside) Designates that this ship is no longer docked, and whether it should also be moved into its na

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

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

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

getTickStatus, name, tick

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

affectCharState, affectCharStats, affectPhyStats

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

executeMsg, okMessage

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Method Detail

dockHere

void dockHere(Room R)

Designates that this ship is landed and docked in the given planetary room.

Parameters:

R - the coordinate toom in which the ship is docked.

setDockableItem

void setDockableItem(Item dockableItem)

When a boardable ship area is created, it is bound to an item that resides in a room when docked, or possibly, always.

Parameters:

dockableItem - the item that acts as dockable item

unDock

Room unDock(boolean moveToOutside)

Designates that this ship is no longer docked, and whether it should also be moved into its na

Parameters:

moveToOutside - true to put in space/ocean, or false to leave in limbo

Returns:

one of the internal rooms that was connected to the dock

getIsDocked

Room getIsDocked()

Returns the Room where this ship is docked, or NULL if in space.

Returns:

the Room where this ship is docked, or NULL if in space.

getShipArea

Area getShipArea()

Space ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method returns the area object that represents the contents of the ship.

Returns:

the official area version of this ship

setShipArea

void setShipArea(java.lang.String xml)

Space ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method sets the area object that represents the contents of the ship.

Parameters:

xml - area xml for the ship

renameShip

void renameShip(java.lang.String newName)

Renames the ship to something else

Parameters:

newName - the new ship name

getHomePortID

java.lang.String getHomePortID()

Returns the room ID of the ships home port.

Returns:

the ships home port

setHomePortID

void setHomePortID(java.lang.String portID)

Sets the room ID of the ships home port

Parameters:

portID - the ships home port

getShipItem

Item getShipItem()

Ships are unique in having an Item stand-in for port-side access, as well as an Area object. This method returns that Item.

Returns:

the official space version of this ship