Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface CommonCommands

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CommonMsgs

public interface CommonCommands
extends CMLibrary

Message handlers for the basic common commands, like get, drop, put, etc. Also handles postings for many common activities that aren't always generated by a user Command. Can also generate traditional command entries. This is the high-level functionality for all of these types of commands, and should be used most of the time when you want a mob to do these things, as it goes through the normal command process.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CommonCommands.LookView	Enum for special mob room view settings, decoded from player mob attributes.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
void	addGlobalMonitor(MsgMonitor M)	Adds a new listener to global messages.
void	delGlobalMonitor(MsgMonitor M)	Removes a listener to global messages.
java.lang.Object	forceInternalCommand(MOB mob, java.lang.String command, java.lang.Object... parms)	This method does a forced internal execute of a specific command with the given parameters.
boolean	forceStandardCommand(MOB mob, java.lang.String command, java.util.List<java.lang.String> parms)	This method does a forced execution of a normal command using the normal channels used by players.
java.lang.StringBuilder	getEquipment(MOB viewer, MOB mob)	Builds a string list of the things the given mob is wearing.
java.lang.StringBuilder	getEquipmentLong(MOB viewer, MOB mob)	Builds a string list of the things the given mob is wearing, in long view, which includes wear slots.
java.lang.String	getExamineItemString(MOB mob, Item item)	This method builds a string of the things a mob knows about an item from taking a good hard longlook at it.
java.lang.String	getFullRoomView(MOB mob, Room room, CommonCommands.LookView lookCode, boolean doMXP)	Builds the complete room view for the given mob.
java.lang.StringBuilder	getInventory(MOB viewer, MOB mob)	Builds a string list of the things the given viewer can see in the given mobs inventory.
java.lang.StringBuilder	getScore(MOB mob)	Builds the standard SCORE command response.
void	handleBeingDropped(CMMsg msg)	Handler function for when a mob drops an item
void	handleBeingGetted(CMMsg msg)	Handler function for when a mob gets an item
void	handleBeingGivenTo(CMMsg msg)	Handler function for when a mob is given an item by another mob.
void	handleBeingHeld(CMMsg msg)	Handler function for when a mob holds an item.
void	handleBeingLookedAt(CMMsg msg)	Handler function for when a mob looks at something, or examines it closely.
void	handleBeingRead(CMMsg msg)	Handler function for when a mob reads something
void	handleBeingRemoved(CMMsg msg)	Handler function for when a mob removes an item
void	handleBeingSniffed(CMMsg msg)	Handler function for when a mob sniffs an item or mob or room or something.
void	handleBeingSpokenTo(MOB speaker, MOB me, java.lang.String msg)	Handler function called when a mob is spoken to by another mob with targeted speech.
void	handleBeingWielded(CMMsg msg)	Handler function for when a mob wields a weapon.
void	handleBeingWorn(CMMsg msg)	Handler function for when a mob wears an item
void	handleComeToLife(MOB mob, CMMsg msg)	Handler function that is called when a mob enters the game, either by logging in, or respawning, or remorting.
void	handleHygienicMessage(CMMsg msg, int minHygiene, long adjHygiene)	Handler function called when a mob does something that might affect their hygiene, typically in a cleanly way.
void	handleIntroductions(MOB speaker, MOB me, java.lang.String said)	Handler function called when a mob is spoken to by another mob in the same room, and the introduction system is enabled.
void	handleObserveComesToLife(MOB observer, MOB lifer, CMMsg msg)	Handler function that is called when a mob observes another mob enter the game, either by logging in, or respawning, or remorting.
void	handleRecall(CMMsg msg)	Handler function for when a mob recalls back to their beacon room
void	handleSit(CMMsg msg)	Handler function for when a mob sits down
void	handleSleep(CMMsg msg)	Handler function for when a mob goes to sleep
void	handleStand(CMMsg msg)	Handler function for when a mob stands up
boolean	handleUnknownCommand(MOB mob, java.util.List<java.lang.String> command)	Handler-like function that is called whenever the given mob enters a command that cannot be resolved to an actual mud command, social, or skill.
boolean	isHygienicMessage(CMMsg msg)	Returns true if the given message reflects something that would improve someone's hygiene, such as washing.
void	lookAtExits(Room room, MOB mob)	Constructs a full table of the exits for the given room and sends them as a tell message to the given mob.
void	lookAtExitsShort(Room room, MOB mob)	Constructs an abbreviated list of the exits for the given room and sends them as a tell message to the given mob.
java.lang.String	makeContainerTypes(Container E)	This method builds a string of the things a container can contain..
void	monitorGlobalMessage(Room room, CMMsg msg)	When a message is generated and sent anywhere in the mud, this method is called to allow any global followers to inspect the message and possibly react.
java.lang.String	parseVaries(MOB mob, Area area, Room room, java.lang.String text)	Parse variable display and description texts to generate the dynamic text seen in some rooms.
void	postChannel(MOB mob, java.lang.String channelName, java.lang.String message, boolean systemMsg)	Method to post a chat message onto a channel from a specific mob.
void	postChannel(java.lang.String channelName, java.lang.Iterable<Pair<Clan,java.lang.Integer>> clanList, java.lang.String message, boolean systemMsg)	Method to post an informational, system-generated message to a channel.
boolean	postCommandFail(MOB mob, Environmental target, Environmental tools, java.util.List<java.lang.String> command, java.lang.String msgStr)	Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.
boolean	postCommandFail(MOB mob, java.util.List<java.lang.String> commands, java.lang.String msgStr)	Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.
boolean	postCommandRejection(MOB mob, Environmental target, Environmental tools, java.util.List<java.lang.String> command)	Method called when certain (but not all -- maybe someday) commands fail because of a message rejection specifically.
boolean	postCommandRejection(MOB mob, java.util.List<java.lang.String> commands)	Method called by the system when certain (but not all -- maybe someday) commands fail because of a message rejection specifically.
void	postDraw(MOB mob, boolean doHold, boolean ifNecessary)	Shortcut method for making a mob draw their first available weapon from a sheath.
boolean	postDrop(MOB mob, Environmental dropThis, boolean quiet, boolean optimized, boolean intermediate)	Shortcut method to make a mob drop an item onto the room.
void	postFlee(MOB mob, java.lang.String whereTo)	Shortcut method for making a mob panic and flee the room.
void	postFollow(MOB follower, MOB leader, boolean quiet)	Shortcut method for making one mob attempt to follow another.
boolean	postGet(MOB mob, Item container, Item getThis, boolean quiet)	Shortcut method for making a mob get something from the room, or from a container.
boolean	postGive(MOB mob, MOB targetM, Item giveThis, boolean quiet)	Shortcut method to make one mob given an item to another
void	postLook(MOB mob, boolean quiet)	Shortcut method for making a mob look around the room
boolean	postOpen(MOB mob, Environmental openThis, boolean quiet)	Shortcut method to make a mob try to open something
boolean	postPut(MOB mob, Item container, Item getThis, boolean quiet)	Shortcut method for making a mob put an item into a container.
void	postRead(MOB mob, Physical target, java.lang.String readOff, boolean quiet)	Shortcut method for making a mob read something.
boolean	postRemove(MOB mob, Item item, boolean quiet)	Shortcut method to make a mob remove an item and put it into their inventory.
void	postSay(MOB mob, MOB target, java.lang.String text)	Shortcut method for forcing the given mob to do the command: sayto [target] [text]
void	postSay(MOB mob, MOB target, java.lang.String text, boolean isPrivate, boolean tellFlag)	Shortcut method for forcing the given mob to do the command: tell [target] [text] ...
void	postSay(MOB mob, java.lang.String text)	Shortcut method for forcing the given mob to do the command: say [text]
void	postSheath(MOB mob, boolean ifPossible)	Shortcut method for making a mob sheath a weapon into an available sheath.
void	postSleep(MOB mob)	Shortcut method for making a mob lay down and go to sleep
void	postStand(MOB mob, boolean ifNecessary, boolean quietly)	Shortcut method for making a mob stand up.
boolean	postWear(MOB mob, Item item, boolean quiet)	Shortcut method to make a mob attempt to wear an item.
void	tickAging(MOB mob, long millisSinceLast)	Adjusts the mobs age based on ellapsed time, and checks for age related diseases and wish someone a happy birthday.
int	tickManaConsumption(MOB mob, int manaConsumeCounter)	An optional system that consumes mana based on effects cast by the player.
java.lang.Object	unforcedInternalCommand(MOB mob, java.lang.String command, java.lang.Object... parms)	This method does a normal internal execute of a specific command with the given parameters.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

addGlobalMonitor

void addGlobalMonitor(MsgMonitor M)

Adds a new listener to global messages. See the monitor method for more information on what that means.

Parameters:

M - the monitor object to call back

See Also:

MsgMonitor, monitorGlobalMessage(Room, CMMsg), delGlobalMonitor(MsgMonitor)

delGlobalMonitor

void delGlobalMonitor(MsgMonitor M)

Removes a listener to global messages. See the monitor method for more information on what that means.

Parameters:

M - the monitor object to call back

See Also:

MsgMonitor, monitorGlobalMessage(Room, CMMsg), addGlobalMonitor(MsgMonitor)

monitorGlobalMessage

void monitorGlobalMessage(Room room,
                          CMMsg msg)

When a message is generated and sent anywhere in the mud, this method is called to allow any global followers to inspect the message and possibly react. Messages reflect things like actions taken, the responses to those actions, and other substantive events. Global listeners, which are extremely special cases and should be few in number are the monitors.

Parameters:

room - the room in which the event occurred

msg - the message sent to that room.

See Also:

addGlobalMonitor(MsgMonitor), delGlobalMonitor(MsgMonitor)

forceStandardCommand

boolean forceStandardCommand(MOB mob,
                             java.lang.String command,
                             java.util.List<java.lang.String> parms)

This method does a forced execution of a normal command using the normal channels used by players.

Parameters:

mob - the mob to execute the command

command - the command ID() to execute

parms - the arguments to the command, including the command word

Returns:

the boolean response from the command, which is mostly meaningless

forceInternalCommand

java.lang.Object forceInternalCommand(MOB mob,
                                      java.lang.String command,
                                      java.lang.Object... parms)

This method does a forced internal execute of a specific command with the given parameters. Please see each Command class for information about which commands support internal execution, and what their parameters are, if any.

Parameters:

mob - the mob to execute the command

command - the command class ID() to execute

parms - the parameters required by the commands internal execute method

Returns:

the response object from the internal execute command

See Also:

unforcedInternalCommand(MOB, String, Object...), forceStandardCommand(MOB, String, List)

unforcedInternalCommand

java.lang.Object unforcedInternalCommand(MOB mob,
                                         java.lang.String command,
                                         java.lang.Object... parms)

This method does a normal internal execute of a specific command with the given parameters. Please see each Command class for information about which commands support internal execution, and what their parameters are, if any.

Parameters:

mob - the mob to execute the command

command - the command class ID() to execute

parms - the parameters required by the commands internal execute method

Returns:

the response object from the internal execute command

See Also:

forceInternalCommand(MOB, String, Object...), forceStandardCommand(MOB, String, List)

handleUnknownCommand

boolean handleUnknownCommand(MOB mob,
                             java.util.List<java.lang.String> command)

Handler-like function that is called whenever the given mob enters a command that cannot be resolved to an actual mud command, social, or skill.

Parameters:

mob - the player who entered the bad command

command - the parsed command as entered.

Returns:

true if the command remained unknown, false if rejected

postCommandFail

boolean postCommandFail(MOB mob,
                        java.util.List<java.lang.String> commands,
                        java.lang.String msgStr)

Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.

Parameters:

mob - the mob who tried the command

commands - the command that was typed in

msgStr - the message explaining the failure, using <S-NAME>, <T-NAME>, etc..

Returns:

true if the command failure went through, and false if the command failure failed

postCommandFail

boolean postCommandFail(MOB mob,
                        Environmental target,
                        Environmental tools,
                        java.util.List<java.lang.String> command,
                        java.lang.String msgStr)

Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.

Parameters:

mob - the mob who tried the command

target - the target of the command, if applicable and identified

tools - the tool used by the command, if applicable and identified

command - the command that was typed in

msgStr - the message explaining the failure, using <S-NAME>, <T-NAME>, etc..

Returns:

true if the command failure went through, and false if the command failure failed

postCommandRejection

boolean postCommandRejection(MOB mob,
                             java.util.List<java.lang.String> commands)

Method called by the system when certain (but not all -- maybe someday) commands fail because of a message rejection specifically. So, presumably the command was entered correctly, but something in the world stopped it from happening.

Parameters:

mob - the mob who did the command

commands - the command string entered

Returns:

true if the command completed being rejected, or false if the rejection was rejected

postCommandRejection

boolean postCommandRejection(MOB mob,
                             Environmental target,
                             Environmental tools,
                             java.util.List<java.lang.String> command)

Method called when certain (but not all -- maybe someday) commands fail because of a message rejection specifically. So, presumably the command was entered correctly, but something in the world stopped it from happening.

Parameters:

mob - the mob who did the command

target - the target of the command, if applicable

tools - a tool used by the command, if applicable

command - the command string entered

Returns:

true if the command completed being rejected, or false if the rejection was rejected

postChannel

void postChannel(MOB mob,
                 java.lang.String channelName,
                 java.lang.String message,
                 boolean systemMsg)

Method to post a chat message onto a channel from a specific mob.

Parameters:

mob - the mob to do the chatting

channelName - the channel to chat on

message - the message to send to the channel

systemMsg - true to format as a system message, false for a normal chat message

postChannel

void postChannel(java.lang.String channelName,
                 java.lang.Iterable<Pair<Clan,java.lang.Integer>> clanList,
                 java.lang.String message,
                 boolean systemMsg)

Method to post an informational, system-generated message to a channel. Most channels are generic, but some are clan-only, meaning that a message sent by a member of clan A is only seen by other members of clan A, even on the same channel. This is why the clanList is included, so that the channel knows which clans can read it, if that's applicable.

Parameters:

channelName - the name of the channel to post the message to

clanList - null normally, or a list of clans for possible focus

message - the message to send to the channel

systemMsg - true to format as a system message, false for a normal chat message

postDrop

boolean postDrop(MOB mob,
                 Environmental dropThis,
                 boolean quiet,
                 boolean optimized,
                 boolean intermediate)

Shortcut method to make a mob drop an item onto the room.

Parameters:

mob - the mob to do the dropping

dropThis - the item to drop

quiet - true to do so without a visible room message

optimized - true if this is part of a mass-drop (no stat recalc)

intermediate - true if this is only the first part of a GIVE

Returns:

true if the item was successfully dropped

postGive

boolean postGive(MOB mob,
                 MOB targetM,
                 Item giveThis,
                 boolean quiet)

Shortcut method to make one mob given an item to another

Parameters:

mob - the mob to do the giving

targetM - the mob to do the receiving of the giving

giveThis - the item to give

quiet - true to do so without a visible room message

Returns:

true if the item was successfully given

postOpen

boolean postOpen(MOB mob,
                 Environmental openThis,
                 boolean quiet)

Shortcut method to make a mob try to open something

Parameters:

mob - the mob to do the opening

openThis - the item or exit to open

quiet - true to do so without a visible room message

Returns:

true if the thing was successfully opened

postGet

boolean postGet(MOB mob,
                Item container,
                Item getThis,
                boolean quiet)

Shortcut method for making a mob get something from the room, or from a container.

Parameters:

mob - the mob to do the getting

container - the items current container, or null

getThis - the item to get

quiet - true to do so without a visible message

Returns:

true if the item was successfully gotten

postPut

boolean postPut(MOB mob,
                Item container,
                Item getThis,
                boolean quiet)

Shortcut method for making a mob put an item into a container.

Parameters:

mob - the mob to do the putting

container - the target container to put something into

getThis - the item to put into the container

quiet - true to do so without a visible room message

Returns:

true if the item was successfully put into the container

postRemove

boolean postRemove(MOB mob,
                   Item item,
                   boolean quiet)

Shortcut method to make a mob remove an item and put it into their inventory.

Parameters:

mob - the mob to do the removing

item - the item to be removed

quiet - true to do so without a visible message

Returns:

true if the item was removed

postWear

boolean postWear(MOB mob,
                 Item item,
                 boolean quiet)

Shortcut method to make a mob attempt to wear an item.

Parameters:

mob - the mob to do the wearing

item - the item to be worn

quiet - true to attempt without a visible message

Returns:

true if the item was successfully worn

postLook

void postLook(MOB mob,
              boolean quiet)

Shortcut method for making a mob look around the room

Parameters:

mob - the mob to do the looking

quiet - true to do so without a visible message

postRead

void postRead(MOB mob,
              Physical target,
              java.lang.String readOff,
              boolean quiet)

Shortcut method for making a mob read something.

Parameters:

mob - the mob to do the reading

target - the item to read

readOff - read arguments, such as page or chapter number, or ""

quiet - true to do so without a room-visible message

postFlee

void postFlee(MOB mob,
              java.lang.String whereTo)

Shortcut method for making a mob panic and flee the room.

Parameters:

mob - the mob to flee

whereTo - NOWHERE or a direction in which to flee, or "" to random choose

postSheath

void postSheath(MOB mob,
                boolean ifPossible)

Shortcut method for making a mob sheath a weapon into an available sheath.

Parameters:

mob - the mob to sheath a weapon

ifPossible - true to suppress errors or lack of weapon/sheath

postDraw

void postDraw(MOB mob,
              boolean doHold,
              boolean ifNecessary)

Shortcut method for making a mob draw their first available weapon from a sheath.

Parameters:

mob - the mob to draw the weapon

doHold - true to off-hand the weapon, false for main-hand

ifNecessary - if true, only do so if not currently wielding

postStand

void postStand(MOB mob,
               boolean ifNecessary,
               boolean quietly)

Shortcut method for making a mob stand up.

Parameters:

mob - the mob to stand

ifNecessary - true if they should attempt only if not standing

quietly - true to do so without a visible message

postSleep

void postSleep(MOB mob)

Shortcut method for making a mob lay down and go to sleep

Parameters:

mob - the mob to sleep

postFollow

void postFollow(MOB follower,
                MOB leader,
                boolean quiet)

Shortcut method for making one mob attempt to follow another.

Parameters:

follower - the mob to do the following

leader - the mob to be followed

quiet - true to do so without a visible message

postSay

void postSay(MOB mob,
             MOB target,
             java.lang.String text,
             boolean isPrivate,
             boolean tellFlag)

Shortcut method for forcing the given mob to do the command: tell [target] [text] ... with special options

Parameters:

mob - the speaker

target - the target of the tell

text - the message to say

isPrivate - true to TELL or private SAYTO, false to public SAYTO

tellFlag - true to TELL, false to private SAYTO

postSay

void postSay(MOB mob,
             MOB target,
             java.lang.String text)

Shortcut method for forcing the given mob to do the command: sayto [target] [text]

Parameters:

mob - the mob to do the command

target - the target being spoken to

text - the text to say

postSay

void postSay(MOB mob,
             java.lang.String text)

Shortcut method for forcing the given mob to do the command: say [text]

Parameters:

mob - the mob to do the command

text - the text to say

lookAtExits

void lookAtExits(Room room,
                 MOB mob)

Constructs a full table of the exits for the given room and sends them as a tell message to the given mob.

Parameters:

room - the room to find exits in

mob - the mob to tell about those exits

See Also:

lookAtExitsShort(Room, MOB)

lookAtExitsShort

void lookAtExitsShort(Room room,
                      MOB mob)

Constructs an abbreviated list of the exits for the given room and sends them as a tell message to the given mob.

Parameters:

room - the room to find exits in

mob - the mob to tell about those exits

See Also:

lookAtExits(Room, MOB)

parseVaries

java.lang.String parseVaries(MOB mob,
                             Area area,
                             Room room,
                             java.lang.String text)

Parse variable display and description texts to generate the dynamic text seen in some rooms.

Parameters:

mob - the mob who is looking

area - the area containing the mob

room - the room containing the mob

text - the raw variable text

Returns:

the dynamic text

handleBeingLookedAt

void handleBeingLookedAt(CMMsg msg)

Handler function for when a mob looks at something, or examines it closely. Things like items, mobs, rooms, etc.

Parameters:

msg - the looking or examining message

handleBeingRead

void handleBeingRead(CMMsg msg)

Handler function for when a mob reads something

Parameters:

msg - the reading message

handleRecall

void handleRecall(CMMsg msg)

Handler function for when a mob recalls back to their beacon room

Parameters:

msg - the recall message

handleSit

void handleSit(CMMsg msg)

Handler function for when a mob sits down

Parameters:

msg - the sitting message

handleStand

void handleStand(CMMsg msg)

Handler function for when a mob stands up

Parameters:

msg - the standing message

handleSleep

void handleSleep(CMMsg msg)

Handler function for when a mob goes to sleep

Parameters:

msg - the sleeping message

handleBeingSniffed

void handleBeingSniffed(CMMsg msg)

Handler function for when a mob sniffs an item or mob or room or something.

Parameters:

msg - the item sniffing message

handleBeingGivenTo

void handleBeingGivenTo(CMMsg msg)

Handler function for when a mob is given an item by another mob.

Parameters:

msg - the item giving message

handleBeingGetted

void handleBeingGetted(CMMsg msg)

Handler function for when a mob gets an item

Parameters:

msg - the item getting message

handleBeingDropped

void handleBeingDropped(CMMsg msg)

Handler function for when a mob drops an item

Parameters:

msg - the item removing message

handleBeingRemoved

void handleBeingRemoved(CMMsg msg)

Handler function for when a mob removes an item

Parameters:

msg - the item removing message

handleBeingWorn

void handleBeingWorn(CMMsg msg)

Handler function for when a mob wears an item

Parameters:

msg - the item wearing message

handleBeingWielded

void handleBeingWielded(CMMsg msg)

Handler function for when a mob wields a weapon.

Parameters:

msg - the item wielding message

handleBeingHeld

void handleBeingHeld(CMMsg msg)

Handler function for when a mob holds an item.

Parameters:

msg - the item holding message

handleHygienicMessage

void handleHygienicMessage(CMMsg msg,
                           int minHygiene,
                           long adjHygiene)

Handler function called when a mob does something that might affect their hygiene, typically in a cleanly way. The observer that calls this is typically something that can recognize that the event affect hygiene.

Parameters:

msg - the message that triggered the hygiene efect

minHygiene - the smallest hygiene amount to consider the mob clean

adjHygiene - the amount by which to adjust hygiene, usually +

handleIntroductions

void handleIntroductions(MOB speaker,
                         MOB me,
                         java.lang.String said)

Handler function called when a mob is spoken to by another mob in the same room, and the introduction system is enabled. This is to check to see if the speaker is introducing themselves.

Parameters:

speaker - the mob speaking

me - the mob being spoken to

said - what the speaker said

handleBeingSpokenTo

void handleBeingSpokenTo(MOB speaker,
                         MOB me,
                         java.lang.String msg)

Handler function called when a mob is spoken to by another mob with targeted speech.

Parameters:

speaker - the speaker mob

me - the mob being spoken to

msg - the message

handleComeToLife

void handleComeToLife(MOB mob,
                      CMMsg msg)

Handler function that is called when a mob enters the game, either by logging in, or respawning, or remorting.

Parameters:

mob - the player or npc coming to life

msg - the "come to life" message

handleObserveComesToLife

void handleObserveComesToLife(MOB observer,
                              MOB lifer,
                              CMMsg msg)

Handler function that is called when a mob observes another mob enter the game, either by logging in, or respawning, or remorting.

Parameters:

observer - the player or npc observing the life happening

lifer - the player or npc coming to life

msg - the "come to life" message

getScore

java.lang.StringBuilder getScore(MOB mob)

Builds the standard SCORE command response. Moved out of the command since it is used by skills and several other things.

Parameters:

mob - the mob whose score to get

Returns:

the score stats response

getFullRoomView

java.lang.String getFullRoomView(MOB mob,
                                 Room room,
                                 CommonCommands.LookView lookCode,
                                 boolean doMXP)

Builds the complete room view for the given mob. This includes all the items, and mobs, and is dependent on the mobs view attributes.

Parameters:

mob - the player to view the room

room - the room to be viewed

lookCode - the look view code for viewing options

doMXP - true to add MXP where needed

Returns:

the full room view MXP

getEquipment

java.lang.StringBuilder getEquipment(MOB viewer,
                                     MOB mob)

Builds a string list of the things the given mob is wearing.

Parameters:

viewer - the viewer of the worn stuff

mob - the mob wearing the stuff

Returns:

the list of stuff being worn

getEquipmentLong

java.lang.StringBuilder getEquipmentLong(MOB viewer,
                                         MOB mob)

Builds a string list of the things the given mob is wearing, in long view, which includes wear slots.

Parameters:

viewer - the viewer of the worn stuff

mob - the mob wearing the stuff

Returns:

the list of stuff being worn, and wear slots

getInventory

java.lang.StringBuilder getInventory(MOB viewer,
                                     MOB mob)

Builds a string list of the things the given viewer can see in the given mobs inventory.

Parameters:

viewer - the viewer of the inventory

mob - the mob whose inventory needs viewing

Returns:

the list of stuff

getExamineItemString

java.lang.String getExamineItemString(MOB mob,
                                      Item item)

This method builds a string of the things a mob knows about an item from taking a good hard longlook at it.

Parameters:

mob - the mob doing the looking

item - the item being looked at

Returns:

the message of things the mob learns about it

makeContainerTypes

java.lang.String makeContainerTypes(Container E)

This method builds a string of the things a container can contain..

Parameters:

E - the container containing things

Returns:

the message of things the container contains

isHygienicMessage

boolean isHygienicMessage(CMMsg msg)

Returns true if the given message reflects something that would improve someone's hygiene, such as washing.

Parameters:

msg - the message to examine

Returns:

true if it is hygienic

tickAging

void tickAging(MOB mob,
               long millisSinceLast)

Adjusts the mobs age based on ellapsed time, and checks for age related diseases and wish someone a happy birthday.

Parameters:

mob - the mob to tick

millisSinceLast - the ellapsed time

tickManaConsumption

int tickManaConsumption(MOB mob,
                        int manaConsumeCounter)

An optional system that consumes mana based on effects cast by the player.

Parameters:

mob - the mob to consume mana of.

manaConsumeCounter - internally manipulated counter

Returns:

remaining manaConsumeCounter