com.planet_ink.coffee_mud.Items.Software
Class GenShipProgram

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Software.StdProgram
          com.planet_ink.coffee_mud.Items.Software.GenSoftware
              com.planet_ink.coffee_mud.Items.Software.GenShipProgram

All Implemented Interfaces:

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

Direct Known Subclasses:

RocketShipProgram, ShipTelnetProgram

public class GenShipProgram
extends GenSoftware

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

protected java.lang.String	circuitKey
protected java.lang.String	readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Software.StdProgram

currentScreen, nextMsg

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

Constructor Summary

GenShipProgram()

Method Summary

boolean	checkActivate(MOB mob, java.lang.String message)
boolean	checkDeactivate(MOB mob, java.lang.String message)
boolean	checkPowerCurrent(int value)
boolean	checkTyping(MOB mob, java.lang.String message)
java.lang.String	getActivationMenu() Returns the menu name of this software, so that it can be identified on its parent screen.
java.lang.String	getInternalName() Returns the internal name of this software.
java.lang.String	getParentMenu() The parent menu that this software gets access from.
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	isActivationString(java.lang.String word) Returns whether the given computer-entry command should be responded to by THIS software object on an activation command.
boolean	isCommandString(java.lang.String word, boolean isActive) Returns whether the given computer-entry command should be responded to by THIS software object on a WRITE/ENTER command.
boolean	isDeActivationString(java.lang.String word) Returns whether the given computer-entry command should be responded to by THIS software object on a deactivation command.
void	onActivate(MOB mob, java.lang.String message)
void	onDeactivate(MOB mob, java.lang.String message)
void	onPowerCurrent(int value)
void	onTyping(MOB mob, java.lang.String message)
void	setCircuitKey(java.lang.String key) Software runs on computers, and computers run on power systems.

Methods inherited from class com.planet_ink.coffee_mud.Items.Software.GenSoftware

getStat, getStatCodes, isGeneric, readableText, sameAs, setMiscText, setReadableText, setStat, text

Methods inherited from class com.planet_ink.coffee_mud.Items.Software.StdProgram

addScreenMessage, display, display, display, displayPerSec, executeMsg, forceNewMenuRead, forceNewMessageScan, forceUpMenu, getCurrentScreenDisplay, getScreenMessage, okMessage, setCurrentScreenDisplay, setTechLevel, techLevel

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, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getCodeNum, getSaveStatIndex, getTickStatus, I, image, initializeClass, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, Name, name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, tick, 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.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, 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, setReadable

Field Detail

circuitKey

protected java.lang.String circuitKey

readableText

protected java.lang.String readableText

Constructor Detail

GenShipProgram

public GenShipProgram()

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 GenSoftware

Returns:

the name of this class

setCircuitKey

public void setCircuitKey(java.lang.String key)

Description copied from interface: Software

Software runs on computers, and computers run on power systems. This method tells the software what the power system "circuit" key is that the computer host is running on, allowing the software to find other equipment on the same circuit and control it.

Specified by:

setCircuitKey in interface Software

Overrides:

setCircuitKey in class StdProgram

Parameters:

key - the circuit key

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 StdProgram

Returns:

the tech type eum

See Also:

Technical.TechType

getParentMenu

public java.lang.String getParentMenu()

Description copied from interface: Software

The parent menu that this software gets access from. When Software is available from root, "" is returned.

Specified by:

getParentMenu in interface Software

Overrides:

getParentMenu in class StdProgram

Returns:

parent menu that this software gets access from

getInternalName

public java.lang.String getInternalName()

Description copied from interface: Software

Returns the internal name of this software.

Specified by:

getInternalName in interface Software

Overrides:

getInternalName in class StdProgram

Returns:

the internal name of this software.

isActivationString

public boolean isActivationString(java.lang.String word)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on an activation command.

Specified by:

isActivationString in interface Software

Overrides:

isActivationString in class StdProgram

Parameters:

word - the computer-entry command entered

Returns:

true if this software should respond.

isDeActivationString

public boolean isDeActivationString(java.lang.String word)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on a deactivation command.

Specified by:

isDeActivationString in interface Software

Overrides:

isDeActivationString in class StdProgram

Parameters:

word - the computer-entry command entered

Returns:

true if this software should respond.

isCommandString

public boolean isCommandString(java.lang.String word,
                               boolean isActive)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on a WRITE/ENTER command.

Specified by:

isCommandString in interface Software

Overrides:

isCommandString in class StdProgram

Parameters:

word - the computer-entry command

isActive - true if the software is already activated

Returns:

true if this software can respond

getActivationMenu

public java.lang.String getActivationMenu()

Description copied from interface: Software

Returns the menu name of this software, so that it can be identified on its parent screen.

Specified by:

getActivationMenu in interface Software

Overrides:

getActivationMenu in class StdProgram

Returns:

the menu name of this software

checkActivate

public boolean checkActivate(MOB mob,
                             java.lang.String message)

Overrides:

checkActivate in class StdProgram

checkDeactivate

public boolean checkDeactivate(MOB mob,
                               java.lang.String message)

Overrides:

checkDeactivate in class StdProgram

checkTyping

public boolean checkTyping(MOB mob,
                           java.lang.String message)

Overrides:

checkTyping in class StdProgram

checkPowerCurrent

public boolean checkPowerCurrent(int value)

Overrides:

checkPowerCurrent in class StdProgram

onActivate

public void onActivate(MOB mob,
                       java.lang.String message)

Overrides:

onActivate in class StdProgram

onDeactivate

public void onDeactivate(MOB mob,
                         java.lang.String message)

Overrides:

onDeactivate in class StdProgram

onTyping

public void onTyping(MOB mob,
                     java.lang.String message)

Overrides:

onTyping in class StdProgram

onPowerCurrent

public void onPowerCurrent(int value)

Overrides:

onPowerCurrent in class StdProgram