com.planet_ink.coffee_mud.Items.CompTech
Class StdCompPanel

java.lang.Object
  extended by com.planet_ink.coffee_mud.Items.Basic.StdItem
      extended by com.planet_ink.coffee_mud.Items.Basic.StdContainer
          extended by com.planet_ink.coffee_mud.Items.BasicTech.StdElecContainer
              extended by com.planet_ink.coffee_mud.Items.CompTech.StdElecCompContainer
                  extended by com.planet_ink.coffee_mud.Items.CompTech.StdCompPanel
All Implemented Interfaces:
Affectable, Behavable, CloseableLockable, CMObject, Contingent, DBIdentifiable, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Container, ElecPanel, Electronics, Item, TechComponent, Technical, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>
Direct Known Subclasses:
GenShipPanel

public class StdCompPanel
extends StdElecCompContainer
implements ElecPanel, TechComponent


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
 
Field Summary
protected  java.lang.String circuitKey
           
protected  Technical.TechType panelType
           
protected  int powerNeeds
           
 
Fields inherited from class com.planet_ink.coffee_mud.Items.CompTech.StdElecCompContainer
installedFactor, maxRechargePer
 
Fields inherited from class com.planet_ink.coffee_mud.Items.BasicTech.StdElecContainer
activated, cachedManufact, manufacturer, power, powerCapacity
 
Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer
capacity, containType, defaultsClosed, defaultsLocked, hasALid, hasALock, isLocked, isOpen, openDelayTicks
 
Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem
affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, name, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues
 
Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.ElecPanel
PANELTYPES
 
Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container
CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS
 
Constructor Summary
StdCompPanel()
           
 
Method Summary
 boolean canContain(Item I)
          Returns whether this container is allowed to contain the given object.
 void destroy()
          Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
 void executeMsg(Environmental myHost, CMMsg msg)
          The general message event handler for the object.
 Technical.TechType getTechType()
          Returns the tech type enum for this technical object, which describes more about its functionality, and is in fact a kind of class proxy.
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 boolean okMessage(Environmental myHost, CMMsg msg)
          The general message event previewer for the object.
 Technical.TechType panelType()
          Gets the type of panel this is, which shows what sorts of items can be "installed into it.
 int powerNeeds()
          Returns the immediate power needs of this electrical item.
 boolean sameAs(Environmental E)
          Whether this object instance is functionally identical to the object passed in.
 void setOwner(ItemPossessor newOwner)
          Sets the Room or MOB representing where this item is located.
 void setPanelType(Technical.TechType type)
          Sets the type of panel this is, which shows what sorts of items can be "installed into it.
 
Methods inherited from class com.planet_ink.coffee_mud.Items.CompTech.StdElecCompContainer
getComputedEfficiency, getInstalledFactor, getRechargeRate, isAllWiringHot, isInstalled, isThisPanelActivated, reportError, setInstalledFactor, setRechargeRate, subjectToWearAndTear
 
Methods inherited from class com.planet_ink.coffee_mud.Items.BasicTech.StdElecContainer
activate, activated, getFinalManufacturer, getManufacturerName, powerCapacity, powerRemaining, setManufacturerName, setPowerCapacity, setPowerRemaining, setTechLevel, techLevel
 
Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer
capacity, containTypes, defaultsClosed, defaultsLocked, emptyPlease, getContents, getDeepContents, hasADoor, hasALock, hasContent, isInside, isLocked, isOpen, keyName, numberOfItems, openDelayTicks, recursiveWeight, setCapacity, setContainTypes, setDoorsNLocks, setKeyName, setMiscText, setOpenDelayTicks, tick
 
Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem
abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, Name, name, newInstance, numBehaviors, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, removeFromOwnerContainer, riding, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, tackOns, text, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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, powerRemaining, setManufacturerName, setPowerCapacity, setPowerRemaining
 
Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Technical
setTechLevel, techLevel
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

powerNeeds

protected volatile int powerNeeds

circuitKey

protected volatile java.lang.String circuitKey

panelType

protected Technical.TechType panelType
Constructor Detail

StdCompPanel

public StdCompPanel()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Overrides:
ID in class StdElecCompContainer
Returns:
the name of this class

getTechType

public Technical.TechType getTechType()
Description copied from interface: Technical
Returns the tech type enum for this technical object, which describes more about its functionality, and is in fact a kind of class proxy. I hope this doesn't bog things down too much.

Specified by:
getTechType in interface Technical
Overrides:
getTechType in class StdElecContainer
Returns:
the tech type eum
See Also:
Technical.TechType

panelType

public Technical.TechType panelType()
Description copied from interface: ElecPanel
Gets the type of panel this is, which shows what sorts of items can be "installed into it. This method is a sort of companion to Container.containTypes()

Specified by:
panelType in interface ElecPanel
Returns:
the type of panel this is
See Also:
ElecPanel.setPanelType(com.planet_ink.coffee_mud.Items.interfaces.Technical.TechType), Technical.TechType

setPanelType

public void setPanelType(Technical.TechType type)
Description copied from interface: ElecPanel
Sets the type of panel this is, which shows what sorts of items can be "installed into it. This method is a sort of companion to Container.setContainTypes(long)

Specified by:
setPanelType in interface ElecPanel
Parameters:
type - the type of panel this is
See Also:
ElecPanel.setPanelType(com.planet_ink.coffee_mud.Items.interfaces.Technical.TechType), Technical.TechType

powerNeeds

public int powerNeeds()
Description copied from interface: Electronics
Returns the immediate power needs of this electrical item. Typically powerCapacity - powerAvailable

Specified by:
powerNeeds in interface Electronics
Overrides:
powerNeeds in class StdElecCompContainer
Returns:
the amount of power this item can still absorb
See Also:
Electronics.powerRemaining(), Electronics.powerCapacity()

canContain

public boolean canContain(Item I)
Description copied from interface: Container
Returns whether this container is allowed to contain the given object.

Specified by:
canContain in interface Container
Overrides:
canContain in class StdContainer
Parameters:
I - the item to check against the allowed content
Returns:
true if the given item can go in this container, false otherwise
See Also:
Container.setContainTypes(long), Container.containTypes()

destroy

public void destroy()
Description copied from interface: Contingent
Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java. Containers, rooms. and mobs who have their destroy() method called will also call the destroy() methods on all items and other objects listed as content, recursively.

Specified by:
destroy in interface Contingent
Overrides:
destroy in class StdElecCompContainer

setOwner

public void setOwner(ItemPossessor newOwner)
Description copied from interface: Item
Sets the Room or MOB representing where this item is located. Containers are handled by another pointer, container(), so those two methods be used together to determine where a given item is. This method is called by the addItem method on mobs and the addItem interface on Rooms. Alone, this method is insufficient to properly determine an items location, so one of the two above should be called instead.

Specified by:
setOwner in interface Item
Overrides:
setOwner in class StdElecCompContainer
Parameters:
newOwner - the mob or room where the item is located
See Also:
ItemCollection.addItem(Item)

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)
Description copied from interface: MsgListener
The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:
okMessage in interface MsgListener
Overrides:
okMessage in class StdElecCompContainer
Parameters:
myHost - either the initiator of the event, or the host of this object
msg - the CMMsg that wants to be executed
Returns:
whether this message is allowed to execute
See Also:
CMMsg, CMMsg.source()

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)
Description copied from interface: MsgListener
The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:
executeMsg in interface MsgListener
Overrides:
executeMsg in class StdElecCompContainer
Parameters:
myHost - either the initiator of the event, or the host of this object
msg - the CMMsg that needs to be executed
See Also:
CMMsg

sameAs

public boolean sameAs(Environmental E)
Description copied from interface: Environmental
Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:
sameAs in interface Environmental
Overrides:
sameAs in class StdElecCompContainer
Parameters:
E - the object to compare this one to
Returns:
whether this object is the same as the one passed in
See Also:
Modifiable.getStatCodes(), Modifiable.getStat(String)