Package com.planet_ink.coffee_mud.Items.interfaces

Interface Electronics

All Superinterfaces:

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

All Known Subinterfaces:

Computer, ElecPanel, PowerGenerator, PowerSource, ShipEngine, ShipWarComponent, TechComponent

All Known Implementing Classes:

GenAbsorbantShield, GenBlaster, GenBussardCollector, GenCompBattery, GenCompEnviroSystem, GenCompGenerator, GenCompLauncher, GenComputerConsole, GenDeflectionShield, GenDisruptor, GenDisruptor2, GenEclipseField, GenElecCompItem, GenElecCompSensor, GenElecContainer, GenElecItem, GenElecPanel, GenElecWeapon, GenEnergyShield, GenFuellessGenerator, GenGraviticSensor, GenIntegrityShield, GenKineticField, GenLaserGun, GenLightSwitch, GenMutingField, GenPersonalShield, GenPhaser, GenPhaser2, GenReflectionShield, GenShipDampener, GenShipEngine, GenShipGravityGen, GenShipInertialBattery, GenShipOpticalSensor, GenShipPanel, GenShipShieldGenerator, GenShipThruster, GenShipViewScreen, GenShipWeapon, GenShipWindow, GenSolarGenerator, GenSonicGun, GenSpaceDrive, GenSpaceShip, GenStealthShield, GenTickerShield, GenTriCorder, GenWaterPowerGenerator, GenWindGenerator, StdCompBattery, StdCompFuelConsumer, StdCompFuellessGenerator, StdCompGenerator, StdCompLauncher, StdCompPanel, StdComputerConsole, StdElecCompContainer, StdElecCompItem, StdElecCompSensor, StdElecContainer, StdElecItem, StdElecPanel, StdElecWeapon, StdPersonalShield, StdShipDampener, StdShipEngine, StdShipFuellessThruster, StdShipGravityGen, StdShipInertialBattery, StdShipShieldGenerator, StdShipThruster, StdShipWeapon, StdTriCorder

public interface Electronics
extends Item, Technical

Electronics are items that can be turned on and off before their interesting behavior or ability is available, which requires "power" to be operated, and has some capacitance for power that keeps it running for some dramatic amount of time while it is no longer receiving new power. Electronics have manufacturers who make them, and can be of many different sorts.

Nested Class Summary

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

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

idConverter

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

Modifier and Type	Method	Description
void	activate(boolean truefalse)	Sets whether this electrical item is "turned on".
boolean	activated()	Gets whether this electrical item is "turned on".
long	powerCapacity()	Gets the maximum amount of capacitance supported by this electrical item.
int	powerNeeds()	Returns the immediate power needs of this electrical item.
long	powerRemaining()	Gets the amount of power capacitance remaining in this electrical item.
long	powerTarget()	Gets the amount of power capacitance to allow this electrical item to charge up to.
void	setPowerCapacity(long capacity)	Sets the maximum amount of capacitance supported by this electrical item.
void	setPowerRemaining(long remaining)	Sets the amount of power capacitance remaining in this electrical item.
void	setPowerTarget(long remaining)	Sets the amount of power capacitance to allow this electrical item to charge up to.

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

isReadable, readableText, setReadable, setReadableText

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

getFinalManufacturer, getManufacturerName, getTechType, setManufacturerName, setTechLevel, techLevel

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

Method Detail

powerCapacity

long powerCapacity()

Gets the maximum amount of capacitance supported by this electrical item. This is the maximum power the item can store up and utilize before it shuts off. Only the item itself knows how much it wants to use at any particular time.

Returns:

the maximum amount of stored power capacity

See Also:

setPowerCapacity(long)

setPowerCapacity

void setPowerCapacity(long capacity)

Sets the maximum amount of capacitance supported by this electrical item. This is the maximum power the item can store up and utilize before it shuts off. Only the item itself knows how much it wants to use at any particular time.

Parameters:

capacity - the maximum amount of stored power capacity

See Also:

powerCapacity()

powerRemaining

long powerRemaining()

Gets the amount of power capacitance remaining in this electrical item. The item will continue to use this power until it doesn't have enough to operate, and then turn off.

Returns:

the amount of power capacitance remaining

See Also:

setPowerRemaining(long)

setPowerRemaining

void setPowerRemaining(long remaining)

Sets the amount of power capacitance remaining in this electrical item. The item will continue to use this power until it doesn't have enough to operate, and then turn off.

Parameters:

remaining - the amount of power capacitance remaining

See Also:

powerRemaining()

powerTarget

long powerTarget()

Gets the amount of power capacitance to allow this electrical item to charge up to. It should always be less than powerCapacity.

Returns:

the amount of power capacitance max to draw

See Also:

setPowerTarget(long)

setPowerTarget

void setPowerTarget(long remaining)

Sets the amount of power capacitance to allow this electrical item to charge up to. It should always be less than powerCapacity.

Parameters:

remaining - the amount of power capacitance remaining

See Also:

powerTarget()

powerNeeds

int powerNeeds()

Returns the immediate power needs of this electrical item. Typically powerCapacity - powerAvailable

Returns:

the amount of power this item can still absorb

See Also:

powerRemaining(), powerCapacity()

activated

boolean activated()

Gets whether this electrical item is "turned on". An activated item can do the stuff it is supposed to, but off it cannot.

Returns:

whether this electrical item is "turned on"

See Also:

activate(boolean)

activate

void activate(boolean truefalse)

Sets whether this electrical item is "turned on". An activated item can do the stuff it is supposed to, but off it cannot.

Parameters:

truefalse - true to activate, false to deactivate

See Also:

activated()