Package com.planet_ink.coffee_mud.Items.interfaces

Interface Boardable

All Superinterfaces:

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

All Known Subinterfaces:

NavigableItem, SpaceShip

All Known Implementing Classes:

GenBoardable, GenCaravan, GenCastle, GenClanCastle, GenNavigableBoardable, GenSailingShip, GenSiegableBoardable, GenSpaceShip, StdBoardable, StdBoardableShip, StdNavigableBoardable, StdSiegableBoardable, StdSpaceShip

public interface Boardable
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

Modifier and Type	Field	Description
static java.lang.String[]	NAME_REPL_MARKERS	Strings which can around replacement strings in a boardable name to designate that it can be renamed by the player.
static java.lang.String[]	NAME_REPL_STRINGS	Strings which can appear between markers in a boardable name to designate that it can be renamed by the player.

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

idConverter

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

Method Summary

Modifier and Type	Method	Description
void	dockHere(Room R)	Designates that this ship is landed and docked in the given planetary room.
Area	getArea()	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
Item	getBoardableItem()	Ships are unique in having an Item stand-in for port-side access, as well as an Area object.
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.
void	rename(java.lang.String newName)	Renames the boardable to something else
boolean	securityCheck(MOB mob)	Returns whether the given mob has control privileges for this boardable item
void	setArea(java.lang.String xml)	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
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
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.CMObject

copyOf, ID, initializeClass, newInstance

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

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

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

expirationDate, setExpirationDate

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

affectCharState, affectCharStats, affectPhyStats

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

getTickStatus, name, tick

Field Detail

NAME_REPL_STRINGS

static final java.lang.String[] NAME_REPL_STRINGS

Strings which can appear between markers in a boardable name to designate that it can be renamed by the player.

NAME_REPL_MARKERS

static final java.lang.String[] NAME_REPL_MARKERS

Strings which can around replacement strings in a boardable name to designate that it can be renamed by the player.

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.

getArea

Area getArea()

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

setArea

void setArea(java.lang.String xml)

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

rename

void rename(java.lang.String newName)

Renames the boardable to something else

Parameters:

newName - the new 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

getBoardableItem

Item getBoardableItem()

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 item version of this ship

securityCheck

boolean securityCheck(MOB mob)

Returns whether the given mob has control privileges for this boardable item

Parameters:

mob - the mob to check

Returns:

true if the mob is a captain