com.planet_ink.coffee_mud.Items.interfaces
Interface ShipWarComponent

All Superinterfaces:

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

All Known Implementing Classes:

GenShipShieldGenerator, GenShipWeapon, StdShipShieldGenerator, StdShipWeapon

public interface ShipWarComponent
extends TechComponent

A ship war component can be a gun or a shield generator. They are an installed component that mitigates or delivers damage of various sorts to or from a space ship.

Nested Class Summary

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

TechComponent.ShipDir

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

Technical.TechCommand, Technical.TechType

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

Wearable.CODES

Field Summary

static int[]

AVAIL_DAMAGE_TYPES These are all the ordinary recognized damage message types that the several shields can even possibly mitigate or weapons deliver.

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

Method Summary

int[]	getDamageMsgTypes() Gets the set of CMMsg message types that can be blocked and or managed by these shields, or is generated by this gun on any one attack.
TechComponent.ShipDir[]	getPermittedDirections() Gets the total set of ship directions that this shield can ever cover or weapons fire at.
int	getPermittedNumDirections() Gets the total number of quarters or sections of the ship that can be covered by this shield or shot by a gun at any one time.
void	setDamageMsgTypes(int[] newTypes) Sets the set of CMMsg message types that can be blocked and or managed by these shields, or is generated by this gun on any one attack.
void	setPermittedDirections(TechComponent.ShipDir[] newPossDirs) Sets the total set of ship directions that this shield can ever cover or weapons fire at.
void	setPermittedNumDirections(int numDirs) Sets the total number of quarters or sections of the ship that can be covered by this shield or shot by a gun at any one time.

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

getInstalledFactor, getRechargeRate, isInstalled, setInstalledFactor, setRechargeRate

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

activate, activated, getFinalManufacturer, getManufacturerName, powerCapacity, powerNeeds, powerRemaining, setManufacturerName, setPowerCapacity, setPowerRemaining

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

getTechType, setTechLevel, techLevel

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

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

Field Detail

AVAIL_DAMAGE_TYPES

static final int[] AVAIL_DAMAGE_TYPES

These are all the ordinary recognized damage message types that the several shields can even possibly mitigate or weapons deliver.

Method Detail

setPermittedDirections

void setPermittedDirections(TechComponent.ShipDir[] newPossDirs)

Sets the total set of ship directions that this shield can ever cover or weapons fire at. Some shields or guns may only be mounted on* the front, rear, or other areas of the ship. This tells the system the complete set of coverage by the shield or weapon, even if it is incapable of covering them all at once.

Parameters:

newPossDirs - the total set of ship directions

See Also:

getPermittedDirections()

getPermittedDirections

TechComponent.ShipDir[] getPermittedDirections()

Gets the total set of ship directions that this shield can ever cover or weapons fire at. Some shields or guns may only be mounted on* the front, rear, or other areas of the ship. This tells the system the complete set of coverage by the shield or weapon, even if it is incapable of covering them all at once.

Returns:

the total set of ship directions

See Also:

ShipWarComponent#setPermittedDirections(ShipDir[])

setPermittedNumDirections

void setPermittedNumDirections(int numDirs)

Sets the total number of quarters or sections of the ship that can be covered by this shield or shot by a gun at any one time. The sections are always contiguous, centered on a particular section, and moving outward as per the ShipDir list order.

Parameters:

numDirs - the total number of sections covered

See Also:

TechComponent.ShipDir, getPermittedDirections(), setPermittedNumDirections(int)

getPermittedNumDirections

int getPermittedNumDirections()

Gets the total number of quarters or sections of the ship that can be covered by this shield or shot by a gun at any one time. The sections are always contiguous, centered on a particular section, and moving outward as per the ShipDir list order.

Returns:

the total number of sections covered

See Also:

TechComponent.ShipDir, getPermittedDirections(), setPermittedNumDirections(int)

setDamageMsgTypes

void setDamageMsgTypes(int[] newTypes)

Sets the set of CMMsg message types that can be blocked and or managed by these shields, or is generated by this gun on any one attack. Really, only one value makes sense on a gun and a shield, but multiple are supported.

Parameters:

newTypes - the set of message types

See Also:

CMMsg.TYP_ACID, getDamageMsgTypes()

getDamageMsgTypes

int[] getDamageMsgTypes()

Gets the set of CMMsg message types that can be blocked and or managed by these shields, or is generated by this gun on any one attack. Really, only one value makes sense on a gun and a shield, but multiple are supported.

Returns:

the set of message types

See Also:

CMMsg.TYP_ACID, setDamageMsgTypes(int[])