Affectable
, Behavable
, CloseableLockable
, CMObject
, Contingent
, DBIdentifiable
, Environmental
, Expireable
, Modifiable
, MsgListener
, Physical
, PhysicalAgent
, Readable
, Rideable
, Rider
, StatsAffecting
, Tickable
, Container
, Item
, Wearable
, java.lang.Cloneable
, java.lang.Comparable<CMObject>
Boat
, Chair
, GenRideable
, HorseCart
, StdCageRideable
, StdComputerConsole
, StdSiegeWeapon
, StdTub
public class StdRideable extends StdContainer implements Rideable
Rideable.Basis
Wearable.CODES
Modifier and Type | Field | Description |
---|---|---|
protected java.lang.String |
dismountString |
|
protected java.lang.String |
mountString |
|
protected java.lang.String |
putString |
|
protected Rideable.Basis |
rideBasis |
|
protected int |
riderCapacity |
|
protected java.util.List<Rider> |
riders |
|
protected java.lang.String |
rideString |
|
protected java.lang.String |
stateString |
|
protected java.lang.String |
stateSubjectStr |
idConverter
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_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS
capacity, containType, defaultsClosed, defaultsLocked, hasALid, hasALock, isLocked, isOpen, openDelayTicks
_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues
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
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 | Description |
---|---|
StdRideable() |
Modifier and Type | Method | Description |
---|---|---|
void |
addRider(Rider mob) |
Adds a new Rider to this Rideable.
|
void |
affectPhyStats(Physical affected,
PhyStats affectableStats) |
This method is called by the recoverPhyStats() method on other Environmental objects.
|
boolean |
amRiding(Rider mob) |
Returns whether Rider is currently mounted on this Rideable
|
protected void |
cloneFix(Item E) |
|
void |
delRider(Rider mob) |
Removes a Rider from this Rideable.
|
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.
|
java.lang.String |
dismountString(Rider R) |
Returns a string grammatically correct for the given rider when
they are dismounting this Rideable
|
java.lang.String |
displayText(MOB mob) |
Returns the displayText, but as seen by the given viewer.
|
void |
executeMsg(Environmental myHost,
CMMsg msg) |
The general message event handler for the object.
|
Rider |
fetchRider(int which) |
Returns a particular Rider mounted on this Rideable.
|
java.lang.String |
genericName() |
Returns a generic name for this object, devoid of its particular
identifying details.
|
java.lang.String |
getDismountString() |
Returns a custom string grammatically correct for the given rider when
they are dismounting this Rideable
|
java.lang.String |
getMountString() |
Returns a custom string grammatically correct for the given rider when
they are mounting this Rideable
|
java.lang.String |
getPutString() |
Returns a custom string grammatically correct for the given rider when
they are putting something on this Rideable
|
java.util.Set<MOB> |
getRideBuddies(java.util.Set<MOB> list) |
Adds all of the MOB Riders on this Rideable to the given Set and returns it
|
java.lang.String |
getRideString() |
Returns a custom verb string describing what one does when one rides
this Rideable from room to room.
|
java.lang.String |
getStateString() |
Returns the custom string grammatically correct for the given rider when
they are mounted on this Rideable
|
java.lang.String |
getStateStringSubject() |
Returns a custom string grammatically correct for this Rideable when
Riders are mounted
|
java.lang.String |
ID() |
The CoffeeMud Java Class ID shared by all instances of
this object.
|
boolean |
isMobileRideBasis() |
Whether the type of rideable is mobile.
|
boolean |
mobileRideBasis() |
Whether this Rideable moves when the Rider wants to move it.
|
java.lang.String |
mountString(int commandType,
Rider R) |
Returns a string grammatically correct for the given rider when
they are mounting this Rideable
|
int |
numRiders() |
Returns the number of riders currently mounted on this Rideable
|
boolean |
okMessage(Environmental myHost,
CMMsg msg) |
The general message event previewer for the object.
|
java.lang.String |
putString(Rider R) |
Returns a string grammatically correct for the given rider when
they are putting something on this Rideable
|
void |
recoverPhyStats() |
This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to
all surrounding objects with affectPhyStats(Environmental,PhyStats) method.
|
Rideable.Basis |
rideBasis() |
The type of rideable object this is.
|
int |
riderCapacity() |
The number of Riders which may ride upon this Rideable
|
java.util.Enumeration<Rider> |
riders() |
Returns an iterator of the riders on this rideable
|
java.lang.String |
rideString(Rider R) |
Returns a verb string describing what one does when one rides
this Rideable from room to room.
|
boolean |
savable() |
|
void |
setDismountString(java.lang.String str) |
Sets a string grammatically correct for the given rider when
they are dismounting this Rideable
|
void |
setMountString(java.lang.String str) |
Setss a string grammatically correct for the given rider when
they are mounting this Rideable
|
void |
setPutString(java.lang.String str) |
Set a string grammatically correct for the given rider when
they are putting something on this Rideable
|
void |
setRideBasis(Rideable.Basis basis) |
Sets type of rideable object this is.
|
void |
setRiderCapacity(int newCapacity) |
Sets the number of Riders which may ride upon this Rideable
|
void |
setRideString(java.lang.String str) |
Sets a verb string describing what one does when one rides
this Rideable from room to room.
|
void |
setStateString(java.lang.String str) |
Returns a string grammatically correct for the given rider when
they are mounted on this Rideable
|
void |
setStateStringSubject(java.lang.String str) |
Sets a string grammatically correct for this Rideable when
Riders are mounted
|
java.lang.String |
stateString(Rider R) |
Returns a string grammatically correct for the given rider when
they are mounted on this Rideable
|
java.lang.String |
stateStringSubject(Rider R) |
Returns a string grammatically correct for this Rideable when
Riders are mounted
|
boolean |
subjectToWearAndTear() |
Whether the usesRemaining() number above is used to determine the percentage health of
the item.
|
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, setBasePhyStats
addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts
copyOf, initializeClass, newInstance
amDestroyed, isSavable, setSavable
canSaveDatabaseID, databaseID, setDatabaseID
description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text
expirationDate, setExpirationDate
baseGoldValue, container, material, owner, rawSecretIdentity, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, ultimateContainer, usesRemaining, value
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
description, name
isReadable, readableText, setReadable, setReadableText
affectCharState, affectCharStats
canContain, capacity, containTypes, defaultsClosed, defaultsLocked, emptyPlease, getContents, getDeepContents, hasADoor, hasALock, hasContent, isInside, isLocked, isOpen, keyName, numberOfItems, openDelayTicks, recursiveWeight, setCapacity, setContainTypes, setDoorsNLocks, setKeyName, setMiscText, setOpenDelayTicks, tick
abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, 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, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, tackOns, text, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear
getTickStatus, name, tick
amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear
protected Rideable.Basis rideBasis
protected int riderCapacity
protected java.util.List<Rider> riders
protected java.lang.String putString
protected java.lang.String rideString
protected java.lang.String stateString
protected java.lang.String stateSubjectStr
protected java.lang.String mountString
protected java.lang.String dismountString
public java.lang.String ID()
CMObject
ID
in interface CMObject
ID
in class StdContainer
public boolean subjectToWearAndTear()
Item
subjectToWearAndTear
in interface Item
subjectToWearAndTear
in class StdItem
public void destroy()
Contingent
destroy
in interface Contingent
destroy
in class StdItem
public boolean savable()
public boolean isMobileRideBasis()
Rideable
isMobileRideBasis
in interface Rideable
Rideable
public Rideable.Basis rideBasis()
Rideable
public void setRideBasis(Rideable.Basis basis)
Rideable
setRideBasis
in interface Rideable
basis
- the RIDEABLE_* constant describing how this is riddenRideable
public int riderCapacity()
Rideable
riderCapacity
in interface Rideable
Rider
public void setRiderCapacity(int newCapacity)
Rideable
setRiderCapacity
in interface Rideable
newCapacity
- the maximum ridersRider
public int numRiders()
Rideable
public Rider fetchRider(int which)
Rideable
fetchRider
in interface Rideable
which
- which rider to detchRider
,
Rideable
,
Rideable.numRiders()
public void addRider(Rider mob)
Rideable
public java.util.Enumeration<Rider> riders()
Rideable
public void delRider(Rider mob)
Rideable
public java.util.Set<MOB> getRideBuddies(java.util.Set<MOB> list)
Rideable
getRideBuddies
in interface Rideable
list
- the hashset into which to add all the mob riderspublic java.lang.String genericName()
Physical
genericName
in interface Physical
genericName
in class StdContainer
public boolean mobileRideBasis()
Rideable
mobileRideBasis
in interface Rideable
Rideable.rideBasis()
public java.lang.String stateString(Rider R)
Rideable
stateString
in interface Rideable
R
- The rider object to make grammatically correct.Rider
,
Rideable.setStateString(String)
,
Rideable.getStateString()
public java.lang.String getStateString()
Rideable
getStateString
in interface Rideable
Rider
,
Rideable.setStateString(String)
,
Rideable.stateString(Rider)
public void setStateString(java.lang.String str)
Rideable
setStateString
in interface Rideable
str
- a string describing the riders state of riding this RideableRider
,
Rideable.stateString(Rider)
,
Rideable.getStateString()
public java.lang.String putString(Rider R)
Rideable
putString
in interface Rideable
R
- The rider object to make grammatically correct.Rider
,
Rideable.setPutString(String)
,
Rideable.getPutString()
public java.lang.String getPutString()
Rideable
getPutString
in interface Rideable
Rider
,
Rideable.setPutString(String)
,
Rideable.putString(Rider)
public void setPutString(java.lang.String str)
Rideable
setPutString
in interface Rideable
str
- a string describing the riders state of putting something on this RideableRider
,
Rideable.putString(Rider)
,
Rideable.getPutString()
public java.lang.String rideString(Rider R)
Rideable
rideString
in interface Rideable
R
- The rider object to make grammatically correct.Rider
,
Rideable.setRideString(String)
,
Rideable.getRideString()
public java.lang.String getRideString()
Rideable
getRideString
in interface Rideable
Rider
,
Rideable.setRideString(String)
,
Rideable.rideString(Rider)
public void setRideString(java.lang.String str)
Rideable
setRideString
in interface Rideable
str
- a string describing the riders verb of riding this Rideable somewhereRider
,
Rideable.rideString(Rider)
,
Rideable.getRideString()
public java.lang.String getMountString()
Rideable
getMountString
in interface Rideable
Rider
,
Rideable.setMountString(String)
,
Rideable.mountString(int, Rider)
public java.lang.String mountString(int commandType, Rider R)
Rideable
mountString
in interface Rideable
commandType
- one of the RIDEABLE_ constants as a typeR
- The rider object to make grammatically correct.Rider
,
Rideable.setMountString(String)
,
Rideable.getMountString()
public void setMountString(java.lang.String str)
Rideable
setMountString
in interface Rideable
str
- a string describing the riders state of mounting this RideableRider
,
Rideable.mountString(int, Rider)
,
Rideable.getDismountString()
public java.lang.String dismountString(Rider R)
Rideable
dismountString
in interface Rideable
R
- The rider object to make grammatically correct.Rider
,
Rideable.setDismountString(String)
,
Rideable.getDismountString()
public java.lang.String getDismountString()
Rideable
getDismountString
in interface Rideable
Rider
,
Rideable.setDismountString(String)
,
Rideable.dismountString(Rider)
public void setDismountString(java.lang.String str)
Rideable
setDismountString
in interface Rideable
str
- a string describing the riders state of dismounting this RideableRider
,
Rideable.dismountString(Rider)
,
Rideable.getDismountString()
public java.lang.String stateStringSubject(Rider R)
Rideable
stateStringSubject
in interface Rideable
R
- The rider object to make grammatically correct.Rider
,
Rideable.setStateStringSubject(String)
,
Rideable.getStateStringSubject()
public java.lang.String getStateStringSubject()
Rideable
getStateStringSubject
in interface Rideable
Rider
,
Rideable.setStateStringSubject(String)
,
Rideable.stateStringSubject(Rider)
public void setStateStringSubject(java.lang.String str)
Rideable
setStateStringSubject
in interface Rideable
str
- a string describing the Riderable state of being riddenRider
,
Rideable.stateStringSubject(Rider)
,
Rideable.getStateStringSubject()
public void recoverPhyStats()
Affectable
recoverPhyStats
in interface Affectable
recoverPhyStats
in class StdItem
Affectable.basePhyStats()
,
Affectable.phyStats()
,
Affectable.addEffect(Ability)
,
Behavable.addBehavior(Behavior)
,
PhyStats
public void affectPhyStats(Physical affected, PhyStats affectableStats)
StatsAffecting
affectPhyStats
in interface StatsAffecting
affectPhyStats
in class StdItem
affected
- the host of the PhyStats object being affectedaffectableStats
- the particular PhyStats object being affectedPhyStats
,
Environmental
,
Affectable.basePhyStats()
,
Affectable.phyStats()
,
Affectable.recoverPhyStats()
public java.lang.String displayText(MOB mob)
Physical
displayText
in interface Physical
displayText
in class StdItem
mob
- the mob viewing the physical thingEnvironmental.displayText()
public boolean amRiding(Rider mob)
Rideable
public boolean okMessage(Environmental myHost, CMMsg msg)
MsgListener
okMessage
in interface MsgListener
okMessage
in class StdContainer
myHost
- either the initiator of the event, or the host of this objectmsg
- the CMMsg that wants to be executedCMMsg
,
CMMsg.source()
public void executeMsg(Environmental myHost, CMMsg msg)
MsgListener
executeMsg
in interface MsgListener
executeMsg
in class StdContainer
myHost
- either the initiator of the event, or the host of this objectmsg
- the CMMsg that needs to be executedCMMsg