Package com.planet_ink.coffee_mud.MOBS

Class StdRideableWrapper

java.lang.Object

com.planet_ink.coffee_mud.MOBS.StdMobWrapper

com.planet_ink.coffee_mud.MOBS.StdRideableWrapper

All Implemented Interfaces:

AbilityContainer, Affectable, Behavable, CMObject, CMObjectWrapper, Combatant, Contingent, DBIdentifiable, Environmental, Expireable, FactionMember, Followable<MOB>, ItemCollection, ItemPossessor, Modifiable, MsgListener, MUDCmdProcessor, Physical, PhysicalAgent, Rideable, Rider, StatsAffecting, Tattooable, Tickable, MOB, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class StdRideableWrapper
extends StdMobWrapper
implements MOB, Rideable, CMObjectWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor

ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

MOB.Attrib

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

Rideable.Basis

Field Summary

Fields

Modifier and Type	Field	Description
protected Rideable	rideable

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

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

AGE_MILLIS_THRESHOLD, END_SHEATH_TIME, START_SHEATH_TIME

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

METAFLAG_AS, METAFLAG_ASMESSAGE, METAFLAG_FORCED, METAFLAG_INORDER, METAFLAG_MPFORCED, METAFLAG_ORDER, METAFLAG_POSSESSED, METAFLAG_QUIETLY, METAFLAG_REVERSED, METAFLAG_SNOOPED

Fields inherited from class com.planet_ink.coffee_mud.MOBS.StdMobWrapper

baseCharStats, basePhyStats, curState, destroyed, lastLocation, location, mob, riding, triggerer

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

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

Constructor Summary

Constructors

Constructor	Description
StdRideableWrapper()

Method Summary

Modifier and Type	Method	Description
void	addRider(Rider mob)	Adds a new Rider to this Rideable.
boolean	amRiding(Rider mob)	Returns whether Rider is currently mounted on this Rideable
void	delRider(Rider mob)	Removes a Rider from this Rideable.
java.lang.String	dismountString(Rider R)	Returns a string grammatically correct for the given rider when they are dismounting this Rideable
Rider	fetchRider(int which)	Returns a particular Rider mounted on this Rideable.
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)	This method recursively returns whoever this mob is riding, and if they are a rideable, who all is riding with him.
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
CMObject	newInstance()	Returns a new instance of this class.
int	numRiders()	Returns the number of riders currently mounted on this Rideable
java.lang.String	putString(Rider R)	Returns a string grammatically correct for the given rider when they are putting something on this Rideable
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.
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
void	setWrappedObject(CMObject obj)	Set the object wrapped by this one.
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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.AbilityContainer

abilities, addAbility, allAbilities, delAbility, delAllAbilities, fetchAbility, fetchAbility, fetchRandomAbility, numAbilities, numAllAbilities

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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, initializeClass

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObjectWrapper

getWrappedObject

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Combatant

amDead, getCombatant, getDirectionToTarget, healthText, isInCombat, killMeDead, makePeace, mayIFight, mayPhysicallyAttack, rangeToTarget, setCombatant, setRangeToTarget

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable

expirationDate, setExpirationDate

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.FactionMember

addFaction, adjustFaction, copyFactions, factions, fetchFaction, fetchFactionData, fetchFactionRanges, getFactionListing, hasFaction, removeFaction

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Followable

addFollower, amFollowing, amUltimatelyFollowing, delFollower, fetchFollower, fetchFollower, fetchFollowerOrder, followers, getGroupMembers, getGroupMembersAndRideables, isFollowedBy, numFollowers, setFollowing, totalFollowers

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemCollection

addItem, delAllItems, delItem, eachItem, findItem, findItem, findItems, findItems, getItem, getRandomItem, isContent, items, numItems

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor

addItem, getContextName, moveItemTo, moveItemTo

Methods inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

addExpertise, addPriorityEffect, amActive, baseCharStats, baseState, baseWeight, bringToLife, bringToLife, charStats, clans, curState, delAllExpertises, delExpertise, dispossess, expertises, fetchExpertise, fetchFirstWornItem, fetchHeldItem, fetchItem, fetchWieldedItem, fetchWornItems, findAbility, flagVariableEq, freeWearPositions, getAbilityUsageCache, getAgeMinutes, getAttributesBitmap, getClanRole, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getLiegeID, getMoney, getMoneyVariation, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getStartRoom, getTrains, getVictim, getWearPositions, getWimpHitPoint, hasOnlyGoldInInventory, isAttributeSet, isMarriedToLiege, isMine, isMonster, isPlayer, isPossessing, isRacialAbility, lastTickedDateTime, location, maxCarry, maxFollowers, maxItems, maxState, numAllEffects, personalEffects, playerStats, recoverCharStats, recoverMaxState, removeFromGame, resetToMaxState, session, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBaseState, setClan, setExperience, setLiegeID, setLocation, setMoney, setMoneyVariation, setPlayerStats, setPractices, setQuestPoint, setSession, setSoulMate, setStartRoom, setTrains, setTriggerer, setVictim, setWimpHitPoint, soulMate, tell, tell, titledName, titledName, triggerer, willFollowOrdersOf

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener

executeMsg, okMessage

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MUDCmdProcessor

actions, clearCommandQueue, commandQueSize, dequeCommand, doCommand, enqueCommand, enqueCommands, getTopCommand, prequeCommand, prequeCommands, setActions

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.core.interfaces.Physical

description, displayText, genericName, name

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

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.MOBS.StdMobWrapper

abilities, actions, addAbility, addBehavior, addEffect, addExpertise, addFaction, addFollower, addItem, addItem, addNonUninvokableEffect, addPriorityEffect, addScript, addTattoo, addTattoo, addTattoo, adjustFaction, affectCharState, affectCharStats, affectPhyStats, allAbilities, amActive, amDead, amDestroyed, amFollowing, amUltimatelyFollowing, baseCharStats, basePhyStats, baseState, baseWeight, behaviors, bringToLife, bringToLife, canSaveDatabaseID, charStats, clans, clearCommandQueue, commandQueSize, compareTo, copyFactions, copyOf, curState, databaseID, delAbility, delAllAbilities, delAllBehaviors, delAllEffects, delAllExpertises, delAllItems, delAllScripts, delBehavior, delEffect, delExpertise, delFollower, delItem, delScript, delTattoo, delTattoo, dequeCommand, description, description, destroy, displayText, displayText, dispossess, doCommand, eachBehavior, eachEffect, eachItem, eachScript, effects, enqueCommand, enqueCommands, executeMsg, expertises, expirationDate, factions, fetchAbility, fetchAbility, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchExpertise, fetchFaction, fetchFactionData, fetchFactionRanges, fetchFirstWornItem, fetchFollower, fetchFollower, fetchFollowerOrder, fetchHeldItem, fetchItem, fetchRandomAbility, fetchScript, fetchWieldedItem, fetchWornItems, findAbility, findItem, findItem, findItems, findItems, findTattoo, findTattooStartsWith, flagVariableEq, followers, freeWearPositions, genericName, getAbilityUsageCache, getAgeMinutes, getAttributesBitmap, getClanRole, getCombatant, getContextName, getDirectionToTarget, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getFactionListing, getGroupMembers, getGroupMembersAndRideables, getItem, getLiegeID, getMoney, getMoneyVariation, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getRandomItem, getSaveStatIndex, getStartRoom, getStat, getStatCodes, getTickStatus, getTopCommand, getTrains, getVictim, getWearPositions, getWimpHitPoint, getWrappedObject, hasFaction, hasOnlyGoldInInventory, healthText, image, initializeClass, isAttributeSet, isContent, isFollowedBy, isGeneric, isInCombat, isMarriedToLiege, isMine, isMonster, isPlayer, isPossessing, isRacialAbility, isSavable, isStat, items, killMeDead, L, lastTickedDateTime, location, makePeace, maxCarry, maxFollowers, maxItems, maxRange, maxState, mayIFight, mayPhysicallyAttack, minRange, miscTextFormat, moveItemTo, moveItemTo, name, name, Name, numAbilities, numAllAbilities, numAllEffects, numBehaviors, numEffects, numFollowers, numItems, numScripts, okMessage, personalEffects, phyStats, playerStats, prequeCommand, prequeCommands, rangeToTarget, rawImage, recoverCharStats, recoverMaxState, recoverPhyStats, removeFaction, removeFromGame, resetToMaxState, riding, sameAs, scripts, session, setActions, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBasePhyStats, setBaseState, setClan, setCombatant, setDatabaseID, setDescription, setDisplayText, setExperience, setExpirationDate, setFollowing, setImage, setLiegeID, setLocation, setMiscText, setMoney, setMoneyVariation, setName, setPlayerStats, setPractices, setQuestPoint, setRangeToTarget, setRiding, setSavable, setSession, setSoulMate, setStartRoom, setStat, setTrains, setTriggerer, setVictim, setWimpHitPoint, soulMate, tattoos, tell, tell, text, tick, titledName, titledName, totalFollowers, triggerer, willFollowOrdersOf

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tattooable

addTattoo, addTattoo, addTattoo, delTattoo, delTattoo, findTattoo, findTattooStartsWith, tattoos

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name, tick

Field Detail

rideable

protected Rideable rideable

Constructor Detail

StdRideableWrapper

public StdRideableWrapper()

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 StdMobWrapper

Returns:

the name of this class

setWrappedObject

public void setWrappedObject(CMObject obj)

Description copied from interface: CMObjectWrapper

Set the object wrapped by this one.

Specified by:

setWrappedObject in interface CMObjectWrapper

Overrides:

setWrappedObject in class StdMobWrapper

Parameters:

obj - the object to wrap

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Overrides:

newInstance in class StdMobWrapper

Returns:

a new instance of this class

isMobileRideBasis

public boolean isMobileRideBasis()

Description copied from interface: Rideable

Whether the type of rideable is mobile.

Specified by:

isMobileRideBasis in interface Rideable

Returns:

Whether this type of rideable is mobile

See Also:

Rideable

rideBasis

public Rideable.Basis rideBasis()

Description copied from interface: Rideable

The type of rideable object this is.

Specified by:

rideBasis in interface Rideable

Returns:

the RIDEABLE_* constant describing how this is ridden

See Also:

Rideable

setRideBasis

public void setRideBasis(Rideable.Basis basis)

Description copied from interface: Rideable

Sets type of rideable object this is.

Specified by:

setRideBasis in interface Rideable

Parameters:

basis - the RIDEABLE_* constant describing how this is ridden

See Also:

Rideable

riderCapacity

public int riderCapacity()

Description copied from interface: Rideable

The number of Riders which may ride upon this Rideable

Specified by:

riderCapacity in interface Rideable

Returns:

the maximum riders

See Also:

Rider

setRiderCapacity

public void setRiderCapacity(int newCapacity)

Description copied from interface: Rideable

Sets the number of Riders which may ride upon this Rideable

Specified by:

setRiderCapacity in interface Rideable

Parameters:

newCapacity - the maximum riders

See Also:

Rider

numRiders

public int numRiders()

Description copied from interface: Rideable

Returns the number of riders currently mounted on this Rideable

Specified by:

numRiders in interface Rideable

Returns:

the number of current Riders

See Also:

Rider

riders

public java.util.Enumeration<Rider> riders()

Description copied from interface: Rideable

Returns an iterator of the riders on this rideable

Specified by:

riders in interface Rideable

Returns:

the riders

See Also:

Rider

fetchRider

public Rider fetchRider(int which)

Description copied from interface: Rideable

Returns a particular Rider mounted on this Rideable. May return null in the case of a race condition

Specified by:

fetchRider in interface Rideable

Parameters:

which - which rider to detch

Returns:

the rider riding

See Also:

Rider, Rideable, Rideable.numRiders()

addRider

public void addRider(Rider mob)

Description copied from interface: Rideable

Adds a new Rider to this Rideable. Is called by Rider.setRiding(Rideable) Should also call Rider.setRiding(Rideable) without recursion

Specified by:

addRider in interface Rideable

Parameters:

mob - Rider object, either an item or a mob

See Also:

Rider, Rideable

delRider

public void delRider(Rider mob)

Description copied from interface: Rideable

Removes a Rider from this Rideable. Is called by Rider.setRiding(null) Should also call Rider.setRiding(null) without recursion

Specified by:

delRider in interface Rideable

Parameters:

mob - Rider object, either an item or a mob

See Also:

Rider, Rideable

amRiding

public boolean amRiding(Rider mob)

Description copied from interface: Rideable

Returns whether Rider is currently mounted on this Rideable

Specified by:

amRiding in interface Rideable

Parameters:

mob - the Rider to check this Rideable for

Returns:

true if the Rider is mounted on this Rideable

See Also:

Rider, Rideable

stateString

public java.lang.String stateString(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are mounted on this Rideable

Specified by:

stateString in interface Rideable

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of riding this Rideable

See Also:

Rider, Rideable.setStateString(String), Rideable.getStateString()

getStateString

public java.lang.String getStateString()

Description copied from interface: Rideable

Returns the custom string grammatically correct for the given rider when they are mounted on this Rideable

Specified by:

getStateString in interface Rideable

Returns:

a custom string describing the riders state of riding this Rideable

See Also:

Rider, Rideable.setStateString(String), Rideable.stateString(Rider)

setStateString

public void setStateString(java.lang.String str)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are mounted on this Rideable

Specified by:

setStateString in interface Rideable

Parameters:

str - a string describing the riders state of riding this Rideable

See Also:

Rider, Rideable.stateString(Rider), Rideable.getStateString()

rideString

public java.lang.String rideString(Rider R)

Description copied from interface: Rideable

Returns a verb string describing what one does when one rides this Rideable from room to room.

Specified by:

rideString in interface Rideable

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders verb of riding this Rideable somewhere

See Also:

Rider, Rideable.setRideString(String), Rideable.getRideString()

getRideString

public java.lang.String getRideString()

Description copied from interface: Rideable

Returns a custom verb string describing what one does when one rides this Rideable from room to room.

Specified by:

getRideString in interface Rideable

Returns:

a custom string describing the riders verb of riding this Rideable somewhere

See Also:

Rider, Rideable.setRideString(String), Rideable.rideString(Rider)

setRideString

public void setRideString(java.lang.String str)

Description copied from interface: Rideable

Sets a verb string describing what one does when one rides this Rideable from room to room.

Specified by:

setRideString in interface Rideable

Parameters:

str - a string describing the riders verb of riding this Rideable somewhere

See Also:

Rider, Rideable.rideString(Rider), Rideable.getRideString()

putString

public java.lang.String putString(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are putting something on this Rideable

Specified by:

putString in interface Rideable

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of putting something on this Rideable

See Also:

Rider, Rideable.setPutString(String), Rideable.getPutString()

getPutString

public java.lang.String getPutString()

Description copied from interface: Rideable

Returns a custom string grammatically correct for the given rider when they are putting something on this Rideable

Specified by:

getPutString in interface Rideable

Returns:

a custom string describing the riders state of putting something on this Rideable

See Also:

Rider, Rideable.setPutString(String), Rideable.putString(Rider)

setPutString

public void setPutString(java.lang.String str)

Description copied from interface: Rideable

Set a string grammatically correct for the given rider when they are putting something on this Rideable

Specified by:

setPutString in interface Rideable

Parameters:

str - a string describing the riders state of putting something on this Rideable

See Also:

Rider, Rideable.putString(Rider), Rideable.getPutString()

stateStringSubject

public java.lang.String stateStringSubject(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for this Rideable when Riders are mounted

Specified by:

stateStringSubject in interface Rideable

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the Riderable state of being ridden

See Also:

Rider, Rideable.setStateStringSubject(String), Rideable.getStateStringSubject()

getStateStringSubject

public java.lang.String getStateStringSubject()

Description copied from interface: Rideable

Returns a custom string grammatically correct for this Rideable when Riders are mounted

Specified by:

getStateStringSubject in interface Rideable

Returns:

a custom string describing the Riderable state of being ridden

See Also:

Rider, Rideable.setStateStringSubject(String), Rideable.stateStringSubject(Rider)

setStateStringSubject

public void setStateStringSubject(java.lang.String str)

Description copied from interface: Rideable

Sets a string grammatically correct for this Rideable when Riders are mounted

Specified by:

setStateStringSubject in interface Rideable

Parameters:

str - a string describing the Riderable state of being ridden

See Also:

Rider, Rideable.stateStringSubject(Rider), Rideable.getStateStringSubject()

mobileRideBasis

public boolean mobileRideBasis()

Description copied from interface: Rideable

Whether this Rideable moves when the Rider wants to move it. Largely derived from rideBasis().

Specified by:

mobileRideBasis in interface Rideable

Returns:

whether this item moves with the rider

See Also:

Rideable.rideBasis()

mountString

public java.lang.String mountString(int commandType,
                                    Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are mounting this Rideable

Specified by:

mountString in interface Rideable

Parameters:

commandType - one of the RIDEABLE_ constants as a type

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of mounting this Rideable

See Also:

Rider, Rideable.setMountString(String), Rideable.getMountString()

getMountString

public java.lang.String getMountString()

Description copied from interface: Rideable

Returns a custom string grammatically correct for the given rider when they are mounting this Rideable

Specified by:

getMountString in interface Rideable

Returns:

a custom string describing the riders state of mounting this Rideable

See Also:

Rider, Rideable.setMountString(String), Rideable.mountString(int, Rider)

setMountString

public void setMountString(java.lang.String str)

Description copied from interface: Rideable

Setss a string grammatically correct for the given rider when they are mounting this Rideable

Specified by:

setMountString in interface Rideable

Parameters:

str - a string describing the riders state of mounting this Rideable

See Also:

Rider, Rideable.mountString(int, Rider), Rideable.getDismountString()

dismountString

public java.lang.String dismountString(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are dismounting this Rideable

Specified by:

dismountString in interface Rideable

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of dismounting this Rideable

See Also:

Rider, Rideable.setDismountString(String), Rideable.getDismountString()

getDismountString

public java.lang.String getDismountString()

Description copied from interface: Rideable

Returns a custom string grammatically correct for the given rider when they are dismounting this Rideable

Specified by:

getDismountString in interface Rideable

Returns:

a custom string describing the riders state of dismounting this Rideable

See Also:

Rider, Rideable.setDismountString(String), Rideable.dismountString(Rider)

setDismountString

public void setDismountString(java.lang.String str)

Description copied from interface: Rideable

Sets a string grammatically correct for the given rider when they are dismounting this Rideable

Specified by:

setDismountString in interface Rideable

Parameters:

str - a string describing the riders state of dismounting this Rideable

See Also:

Rider, Rideable.dismountString(Rider), Rideable.getDismountString()

getRideBuddies

public java.util.Set<MOB> getRideBuddies(java.util.Set<MOB> list)

Description copied from interface: MOB

This method recursively returns whoever this mob is riding, and if they are a rideable, who all is riding with him.

Specified by:

getRideBuddies in interface MOB

Specified by:

getRideBuddies in interface Rideable

Overrides:

getRideBuddies in class StdMobWrapper

Parameters:

list - the required list to populate with riders and rideable

Returns:

the same list sent in

See Also:

Rider, Rideable