CommonMsgs

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.CommonMsgs

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, CommonCommands, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class CommonMsgs
extends StdLibrary
implements CommonCommands
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CommonCommands
  CommonCommands.LookView

Field Summary

Fields
Modifier and Type	Field	Description
`protected Ability`	`awarenessA`
`protected java.util.List<java.lang.ref.WeakReference<MsgMonitor>>`	`globalMonitors`
`protected MOB`	`nonClanTalkerM`
`protected Room`	`talkLocationR`

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

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

CommonMsgs()

Constructors
Constructor	Description
`CommonMsgs()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected java.lang.String`	`dispossessionTimeLeftString(Item item)`
`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.
`protected boolean`	`forceStandardCommand(MOB mob, java.lang.String command, java.util.List<java.lang.String> parms, boolean quietly)`
`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.
`protected java.lang.String`	`getFollowAddendum(Followable iF)`
`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.
`protected java.lang.String`	`getRiderAddendum(Rider iR)`
`java.lang.StringBuilder`	`getScore(MOB mob)`	Builds the standard SCORE command response.
`protected void`	`gmcpSaySend(java.lang.String sayName, MOB mob, MOB target, CMMsg msg)`
`void`	`handleBeingDropped(CMMsg msg)`	Handler function for when a mob drops an item
`protected void`	`handleBeingExitLookedAt(CMMsg msg)`
`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.
`protected void`	`handleBeingItemLookedAt(CMMsg msg)`
`protected void`	`handleBeingItemSniffed(CMMsg msg)`
`void`	`handleBeingLookedAt(CMMsg msg)`	Handler function for when a mob looks at something, or examines it closely.
`protected void`	`handleBeingMobLookedAt(CMMsg msg)`
`void`	`handleBeingMobSniffed(CMMsg msg)`
`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
`protected void`	`handleBeingRoomLookedAt(CMMsg msg)`
`protected void`	`handleBeingRoomSniffed(CMMsg msg)`
`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.
`boolean`	`handleCommandFail(MOB mob, Environmental target, Environmental tools, java.util.List<java.lang.String> command, java.lang.String msgStr)`
`boolean`	`handleCommandFail(MOB mob, java.util.List<java.lang.String> commands, java.lang.String msgStr)`
`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 msg)`	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
`protected void`	`handleRecall(MOB recallingMob, Room recallingRoom, Room recallToRoom)`
`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.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`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.
`protected java.lang.String`	`parseVariesCodes(MOB mob, Area A, Room room, java.lang.String text)`
`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.
`protected java.lang.String`	`relativeCharStatTest(CharStats C, MOB mob, java.lang.String weakword, java.lang.String strongword, int stat)`
`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, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

- Field Detail
  - globalMonitors
```
protected final java.util.List<java.lang.ref.WeakReference<MsgMonitor>> globalMonitors
```
  - awarenessA
```
protected Ability awarenessA
```
  - nonClanTalkerM
```
protected MOB nonClanTalkerM
```
  - talkLocationR
```
protected Room talkLocationR
```
- Constructor Detail
  - CommonMsgs
```
public CommonMsgs()
```
- 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 StdLibrary
    
    Returns:
    
    the name of this class
  - handleUnknownCommand
```
public boolean handleUnknownCommand(MOB mob,
                                    java.util.List<java.lang.String> command)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    handleUnknownCommand in interface CommonCommands
    
    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
  - handleCommandFail
```
public boolean handleCommandFail(MOB mob,
                                 java.util.List<java.lang.String> commands,
                                 java.lang.String msgStr)
```
  - handleCommandFail
```
public boolean handleCommandFail(MOB mob,
                                 Environmental target,
                                 Environmental tools,
                                 java.util.List<java.lang.String> command,
                                 java.lang.String msgStr)
```
  - postCommandFail
```
public boolean postCommandFail(MOB mob,
                               java.util.List<java.lang.String> commands,
                               java.lang.String msgStr)
```
    Description copied from interface: CommonCommands
    
    Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.
    
    Specified by:
    
    postCommandFail in interface CommonCommands
    
    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
```
public boolean postCommandFail(MOB mob,
                               Environmental target,
                               Environmental tools,
                               java.util.List<java.lang.String> command,
                               java.lang.String msgStr)
```
    Description copied from interface: CommonCommands
    
    Method called by the system when certain (but not all -- maybe someday) commands fail because of syntax or bad arguments.
    
    Specified by:
    
    postCommandFail in interface CommonCommands
    
    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
```
public boolean postCommandRejection(MOB mob,
                                    java.util.List<java.lang.String> commands)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    postCommandRejection in interface CommonCommands
    
    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
```
public boolean postCommandRejection(MOB mob,
                                    Environmental target,
                                    Environmental tools,
                                    java.util.List<java.lang.String> command)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    postCommandRejection in interface CommonCommands
    
    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
  - unforcedInternalCommand
```
public java.lang.Object unforcedInternalCommand(MOB mob,
                                                java.lang.String command,
                                                java.lang.Object... parms)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    unforcedInternalCommand in interface CommonCommands
    
    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:
    
    CommonCommands.forceInternalCommand(MOB, String, Object...), CommonCommands.forceStandardCommand(MOB, String, List)
  - forceInternalCommand
```
public java.lang.Object forceInternalCommand(MOB mob,
                                             java.lang.String command,
                                             java.lang.Object... parms)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    forceInternalCommand in interface CommonCommands
    
    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:
    
    CommonCommands.unforcedInternalCommand(MOB, String, Object...), CommonCommands.forceStandardCommand(MOB, String, List)
  - forceStandardCommand
```
protected boolean forceStandardCommand(MOB mob,
                                       java.lang.String command,
                                       java.util.List<java.lang.String> parms,
                                       boolean quietly)
```
  - forceStandardCommand
```
public boolean forceStandardCommand(MOB mob,
                                    java.lang.String command,
                                    java.util.List<java.lang.String> parms)
```
    Description copied from interface: CommonCommands
    
    This method does a forced execution of a normal command using the normal channels used by players.
    
    Specified by:
    
    forceStandardCommand in interface CommonCommands
    
    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
  - monitorGlobalMessage
```
public void monitorGlobalMessage(Room room,
                                 CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    monitorGlobalMessage in interface CommonCommands
    
    Parameters:
    
    room - the room in which the event occurred
    
    msg - the message sent to that room.
    
    See Also:
    
    CommonCommands.addGlobalMonitor(MsgMonitor), CommonCommands.delGlobalMonitor(MsgMonitor)
  - addGlobalMonitor
```
public void addGlobalMonitor(MsgMonitor M)
```
    Description copied from interface: CommonCommands
    
    Adds a new listener to global messages. See the monitor method for more information on what that means.
    
    Specified by:
    
    addGlobalMonitor in interface CommonCommands
    
    Parameters:
    
    M - the monitor object to call back
    
    See Also:
    
    MsgMonitor, CommonCommands.monitorGlobalMessage(Room, CMMsg), CommonCommands.delGlobalMonitor(MsgMonitor)
  - delGlobalMonitor
```
public void delGlobalMonitor(MsgMonitor M)
```
    Description copied from interface: CommonCommands
    
    Removes a listener to global messages. See the monitor method for more information on what that means.
    
    Specified by:
    
    delGlobalMonitor in interface CommonCommands
    
    Parameters:
    
    M - the monitor object to call back
    
    See Also:
    
    MsgMonitor, CommonCommands.monitorGlobalMessage(Room, CMMsg), CommonCommands.addGlobalMonitor(MsgMonitor)
  - getScore
```
public java.lang.StringBuilder getScore(MOB mob)
```
    Description copied from interface: CommonCommands
    
    Builds the standard SCORE command response. Moved out of the command since it is used by skills and several other things.
    
    Specified by:
    
    getScore in interface CommonCommands
    
    Parameters:
    
    mob - the mob whose score to get
    
    Returns:
    
    the score stats response
  - getEquipment
```
public java.lang.StringBuilder getEquipment(MOB viewer,
                                            MOB mob)
```
    Description copied from interface: CommonCommands
    
    Builds a string list of the things the given mob is wearing.
    
    Specified by:
    
    getEquipment in interface CommonCommands
    
    Parameters:
    
    viewer - the viewer of the worn stuff
    
    mob - the mob wearing the stuff
    
    Returns:
    
    the list of stuff being worn
  - getEquipmentLong
```
public java.lang.StringBuilder getEquipmentLong(MOB viewer,
                                                MOB mob)
```
    Description copied from interface: CommonCommands
    
    Builds a string list of the things the given mob is wearing, in long view, which includes wear slots.
    
    Specified by:
    
    getEquipmentLong in interface CommonCommands
    
    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
```
public java.lang.StringBuilder getInventory(MOB viewer,
                                            MOB mob)
```
    Description copied from interface: CommonCommands
    
    Builds a string list of the things the given viewer can see in the given mobs inventory.
    
    Specified by:
    
    getInventory in interface CommonCommands
    
    Parameters:
    
    viewer - the viewer of the inventory
    
    mob - the mob whose inventory needs viewing
    
    Returns:
    
    the list of stuff
  - postChannel
```
public void postChannel(MOB mob,
                        java.lang.String channelName,
                        java.lang.String message,
                        boolean systemMsg)
```
    Description copied from interface: CommonCommands
    
    Method to post a chat message onto a channel from a specific mob.
    
    Specified by:
    
    postChannel in interface CommonCommands
    
    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
```
public void postChannel(java.lang.String channelName,
                        java.lang.Iterable<Pair<Clan,java.lang.Integer>> clanList,
                        java.lang.String message,
                        boolean systemMsg)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    postChannel in interface CommonCommands
    
    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
```
public boolean postDrop(MOB mob,
                        Environmental dropThis,
                        boolean quiet,
                        boolean optimized,
                        boolean intermediate)
```
    Description copied from interface: CommonCommands
    
    Shortcut method to make a mob drop an item onto the room.
    
    Specified by:
    
    postDrop in interface CommonCommands
    
    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
```
public boolean postGive(MOB mob,
                        MOB targetM,
                        Item giveThis,
                        boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method to make one mob given an item to another
    
    Specified by:
    
    postGive in interface CommonCommands
    
    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
```
public boolean postOpen(MOB mob,
                        Environmental openThis,
                        boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method to make a mob try to open something
    
    Specified by:
    
    postOpen in interface CommonCommands
    
    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
```
public boolean postGet(MOB mob,
                       Item container,
                       Item getThis,
                       boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob get something from the room, or from a container.
    
    Specified by:
    
    postGet in interface CommonCommands
    
    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
```
public boolean postPut(MOB mob,
                       Item container,
                       Item getThis,
                       boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob put an item into a container.
    
    Specified by:
    
    postPut in interface CommonCommands
    
    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
```
public boolean postRemove(MOB mob,
                          Item item,
                          boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method to make a mob remove an item and put it into their inventory.
    
    Specified by:
    
    postRemove in interface CommonCommands
    
    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
```
public boolean postWear(MOB mob,
                        Item item,
                        boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method to make a mob attempt to wear an item.
    
    Specified by:
    
    postWear in interface CommonCommands
    
    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
```
public void postLook(MOB mob,
                     boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob look around the room
    
    Specified by:
    
    postLook in interface CommonCommands
    
    Parameters:
    
    mob - the mob to do the looking
    
    quiet - true to do so without a visible message
  - postRead
```
public void postRead(MOB mob,
                     Physical target,
                     java.lang.String readOff,
                     boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob read something.
    
    Specified by:
    
    postRead in interface CommonCommands
    
    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
```
public void postFlee(MOB mob,
                     java.lang.String whereTo)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob panic and flee the room.
    
    Specified by:
    
    postFlee in interface CommonCommands
    
    Parameters:
    
    mob - the mob to flee
    
    whereTo - NOWHERE or a direction in which to flee, or "" to random choose
  - postSheath
```
public void postSheath(MOB mob,
                       boolean ifPossible)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob sheath a weapon into an available sheath.
    
    Specified by:
    
    postSheath in interface CommonCommands
    
    Parameters:
    
    mob - the mob to sheath a weapon
    
    ifPossible - true to suppress errors or lack of weapon/sheath
  - postDraw
```
public void postDraw(MOB mob,
                     boolean doHold,
                     boolean ifNecessary)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob draw their first available weapon from a sheath.
    
    Specified by:
    
    postDraw in interface CommonCommands
    
    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
```
public void postStand(MOB mob,
                      boolean ifNecessary,
                      boolean quietly)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob stand up.
    
    Specified by:
    
    postStand in interface CommonCommands
    
    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
```
public void postSleep(MOB mob)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making a mob lay down and go to sleep
    
    Specified by:
    
    postSleep in interface CommonCommands
    
    Parameters:
    
    mob - the mob to sleep
  - postFollow
```
public void postFollow(MOB follower,
                       MOB leader,
                       boolean quiet)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for making one mob attempt to follow another.
    
    Specified by:
    
    postFollow in interface CommonCommands
    
    Parameters:
    
    follower - the mob to do the following
    
    leader - the mob to be followed
    
    quiet - true to do so without a visible message
  - postSay
```
public void postSay(MOB mob,
                    MOB target,
                    java.lang.String text)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for forcing the given mob to do the command: sayto [target] [text]
    
    Specified by:
    
    postSay in interface CommonCommands
    
    Parameters:
    
    mob - the mob to do the command
    
    target - the target being spoken to
    
    text - the text to say
  - postSay
```
public void postSay(MOB mob,
                    java.lang.String text)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for forcing the given mob to do the command: say [text]
    
    Specified by:
    
    postSay in interface CommonCommands
    
    Parameters:
    
    mob - the mob to do the command
    
    text - the text to say
  - postSay
```
public void postSay(MOB mob,
                    MOB target,
                    java.lang.String text,
                    boolean isPrivate,
                    boolean tellFlag)
```
    Description copied from interface: CommonCommands
    
    Shortcut method for forcing the given mob to do the command: tell [target] [text] ... with special options
    
    Specified by:
    
    postSay in interface CommonCommands
    
    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
  - gmcpSaySend
```
protected void gmcpSaySend(java.lang.String sayName,
                           MOB mob,
                           MOB target,
                           CMMsg msg)
```
  - handleBeingSniffed
```
public void handleBeingSniffed(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob sniffs an item or mob or room or something.
    
    Specified by:
    
    handleBeingSniffed in interface CommonCommands
    
    Parameters:
    
    msg - the item sniffing message
  - handleBeingMobSniffed
```
public void handleBeingMobSniffed(CMMsg msg)
```
  - handleObserveComesToLife
```
public void handleObserveComesToLife(MOB observer,
                                     MOB lifer,
                                     CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function that is called when a mob observes another mob enter the game, either by logging in, or respawning, or remorting.
    
    Specified by:
    
    handleObserveComesToLife in interface CommonCommands
    
    Parameters:
    
    observer - the player or npc observing the life happening
    
    lifer - the player or npc coming to life
    
    msg - the "come to life" message
  - handleComeToLife
```
public void handleComeToLife(MOB mob,
                             CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function that is called when a mob enters the game, either by logging in, or respawning, or remorting.
    
    Specified by:
    
    handleComeToLife in interface CommonCommands
    
    Parameters:
    
    mob - the player or npc coming to life
    
    msg - the "come to life" message
  - handleSit
```
public void handleSit(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob sits down
    
    Specified by:
    
    handleSit in interface CommonCommands
    
    Parameters:
    
    msg - the sitting message
  - handleSleep
```
public void handleSleep(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob goes to sleep
    
    Specified by:
    
    handleSleep in interface CommonCommands
    
    Parameters:
    
    msg - the sleeping message
  - handleStand
```
public void handleStand(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob stands up
    
    Specified by:
    
    handleStand in interface CommonCommands
    
    Parameters:
    
    msg - the standing message
  - handleRecall
```
protected void handleRecall(MOB recallingMob,
                            Room recallingRoom,
                            Room recallToRoom)
```
  - handleRecall
```
public void handleRecall(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob recalls back to their beacon room
    
    Specified by:
    
    handleRecall in interface CommonCommands
    
    Parameters:
    
    msg - the recall message
  - tickManaConsumption
```
public int tickManaConsumption(MOB mob,
                               int manaConsumeCounter)
```
    Description copied from interface: CommonCommands
    
    An optional system that consumes mana based on effects cast by the player.
    
    Specified by:
    
    tickManaConsumption in interface CommonCommands
    
    Parameters:
    
    mob - the mob to consume mana of.
    
    manaConsumeCounter - internally manipulated counter
    
    Returns:
    
    remaining manaConsumeCounter
  - tickAging
```
public void tickAging(MOB mob,
                      long millisSinceLast)
```
    Description copied from interface: CommonCommands
    
    Adjusts the mobs age based on ellapsed time, and checks for age related diseases and wish someone a happy birthday.
    
    Specified by:
    
    tickAging in interface CommonCommands
    
    Parameters:
    
    mob - the mob to tick
    
    millisSinceLast - the ellapsed time
  - relativeCharStatTest
```
protected java.lang.String relativeCharStatTest(CharStats C,
                                                MOB mob,
                                                java.lang.String weakword,
                                                java.lang.String strongword,
                                                int stat)
```
  - handleBeingLookedAt
```
public void handleBeingLookedAt(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob looks at something, or examines it closely. Things like items, mobs, rooms, etc.
    
    Specified by:
    
    handleBeingLookedAt in interface CommonCommands
    
    Parameters:
    
    msg - the looking or examining message
  - makeContainerTypes
```
public java.lang.String makeContainerTypes(Container E)
```
    Description copied from interface: CommonCommands
    
    This method builds a string of the things a container can contain..
    
    Specified by:
    
    makeContainerTypes in interface CommonCommands
    
    Parameters:
    
    E - the container containing things
    
    Returns:
    
    the message of things the container contains
  - getExamineItemString
```
public java.lang.String getExamineItemString(MOB mob,
                                             Item item)
```
    Description copied from interface: CommonCommands
    
    This method builds a string of the things a mob knows about an item from taking a good hard longlook at it.
    
    Specified by:
    
    getExamineItemString in interface CommonCommands
    
    Parameters:
    
    mob - the mob doing the looking
    
    item - the item being looked at
    
    Returns:
    
    the message of things the mob learns about it
  - dispossessionTimeLeftString
```
protected java.lang.String dispossessionTimeLeftString(Item item)
```
  - getRiderAddendum
```
protected java.lang.String getRiderAddendum(Rider iR)
```
  - getFollowAddendum
```
protected java.lang.String getFollowAddendum(Followable iF)
```
  - handleBeingItemLookedAt
```
protected void handleBeingItemLookedAt(CMMsg msg)
```
  - handleBeingItemSniffed
```
protected void handleBeingItemSniffed(CMMsg msg)
```
  - handleIntroductions
```
public void handleIntroductions(MOB speaker,
                                MOB me,
                                java.lang.String msg)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    handleIntroductions in interface CommonCommands
    
    Parameters:
    
    speaker - the mob speaking
    
    me - the mob being spoken to
    
    msg - what the speaker said
  - handleBeingSpokenTo
```
public void handleBeingSpokenTo(MOB speaker,
                                MOB me,
                                java.lang.String msg)
```
    Description copied from interface: CommonCommands
    
    Handler function called when a mob is spoken to by another mob with targeted speech.
    
    Specified by:
    
    handleBeingSpokenTo in interface CommonCommands
    
    Parameters:
    
    speaker - the speaker mob
    
    me - the mob being spoken to
    
    msg - the message
  - handleBeingRoomSniffed
```
protected void handleBeingRoomSniffed(CMMsg msg)
```
  - getFullRoomView
```
public java.lang.String getFullRoomView(MOB mob,
                                        Room room,
                                        CommonCommands.LookView lookCode,
                                        boolean doMXP)
```
    Description copied from interface: CommonCommands
    
    Builds the complete room view for the given mob. This includes all the items, and mobs, and is dependent on the mobs view attributes.
    
    Specified by:
    
    getFullRoomView in interface CommonCommands
    
    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
  - handleBeingRoomLookedAt
```
protected void handleBeingRoomLookedAt(CMMsg msg)
```
  - isHygienicMessage
```
public boolean isHygienicMessage(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Returns true if the given message reflects something that would improve someone's hygiene, such as washing.
    
    Specified by:
    
    isHygienicMessage in interface CommonCommands
    
    Parameters:
    
    msg - the message to examine
    
    Returns:
    
    true if it is hygienic
  - handleHygienicMessage
```
public void handleHygienicMessage(CMMsg msg,
                                  int minHygiene,
                                  long adjHygiene)
```
    Description copied from interface: CommonCommands
    
    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.
    
    Specified by:
    
    handleHygienicMessage in interface CommonCommands
    
    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 +
  - handleBeingExitLookedAt
```
protected void handleBeingExitLookedAt(CMMsg msg)
```
  - handleBeingMobLookedAt
```
protected void handleBeingMobLookedAt(CMMsg msg)
```
  - handleBeingGivenTo
```
public void handleBeingGivenTo(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob is given an item by another mob.
    
    Specified by:
    
    handleBeingGivenTo in interface CommonCommands
    
    Parameters:
    
    msg - the item giving message
  - handleBeingRead
```
public void handleBeingRead(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob reads something
    
    Specified by:
    
    handleBeingRead in interface CommonCommands
    
    Parameters:
    
    msg - the reading message
  - handleBeingGetted
```
public void handleBeingGetted(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob gets an item
    
    Specified by:
    
    handleBeingGetted in interface CommonCommands
    
    Parameters:
    
    msg - the item getting message
  - handleBeingDropped
```
public void handleBeingDropped(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob drops an item
    
    Specified by:
    
    handleBeingDropped in interface CommonCommands
    
    Parameters:
    
    msg - the item removing message
  - handleBeingRemoved
```
public void handleBeingRemoved(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob removes an item
    
    Specified by:
    
    handleBeingRemoved in interface CommonCommands
    
    Parameters:
    
    msg - the item removing message
  - handleBeingWorn
```
public void handleBeingWorn(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob wears an item
    
    Specified by:
    
    handleBeingWorn in interface CommonCommands
    
    Parameters:
    
    msg - the item wearing message
  - handleBeingWielded
```
public void handleBeingWielded(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob wields a weapon.
    
    Specified by:
    
    handleBeingWielded in interface CommonCommands
    
    Parameters:
    
    msg - the item wielding message
  - handleBeingHeld
```
public void handleBeingHeld(CMMsg msg)
```
    Description copied from interface: CommonCommands
    
    Handler function for when a mob holds an item.
    
    Specified by:
    
    handleBeingHeld in interface CommonCommands
    
    Parameters:
    
    msg - the item holding message
  - lookAtExits
```
public void lookAtExits(Room room,
                        MOB mob)
```
    Description copied from interface: CommonCommands
    
    Constructs a full table of the exits for the given room and sends them as a tell message to the given mob.
    
    Specified by:
    
    lookAtExits in interface CommonCommands
    
    Parameters:
    
    room - the room to find exits in
    
    mob - the mob to tell about those exits
    
    See Also:
    
    CommonCommands.lookAtExitsShort(Room, MOB)
  - lookAtExitsShort
```
public void lookAtExitsShort(Room room,
                             MOB mob)
```
    Description copied from interface: CommonCommands
    
    Constructs an abbreviated list of the exits for the given room and sends them as a tell message to the given mob.
    
    Specified by:
    
    lookAtExitsShort in interface CommonCommands
    
    Parameters:
    
    room - the room to find exits in
    
    mob - the mob to tell about those exits
    
    See Also:
    
    CommonCommands.lookAtExits(Room, MOB)
  - parseVariesCodes
```
protected java.lang.String parseVariesCodes(MOB mob,
                                            Area A,
                                            Room room,
                                            java.lang.String text)
```
  - parseVaries
```
public java.lang.String parseVaries(MOB mob,
                                    Area area,
                                    Room room,
                                    java.lang.String text)
```
    Description copied from interface: CommonCommands
    
    Parse variable display and description texts to generate the dynamic text seen in some rooms.
    
    Specified by:
    
    parseVaries in interface CommonCommands
    
    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

Class CommonMsgs

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CommonCommands

Field Summary

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Constructor Summary

Method Summary

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

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

globalMonitors

awarenessA

nonClanTalkerM

talkLocationR

Constructor Detail

CommonMsgs

Method Detail

ID

handleUnknownCommand

handleCommandFail

handleCommandFail

postCommandFail

postCommandFail

postCommandRejection

postCommandRejection

unforcedInternalCommand

forceInternalCommand

forceStandardCommand

forceStandardCommand

monitorGlobalMessage

addGlobalMonitor

delGlobalMonitor

getScore

getEquipment

getEquipmentLong

getInventory

postChannel

postChannel

postDrop

postGive

postOpen

postGet

postPut

postRemove

postWear

postLook

postRead

postFlee

postSheath

postDraw

postStand

postSleep

postFollow

postSay

postSay

postSay

gmcpSaySend

handleBeingSniffed

handleBeingMobSniffed

handleObserveComesToLife

handleComeToLife

handleSit

handleSleep

handleStand

handleRecall

handleRecall

tickManaConsumption

tickAging

relativeCharStatTest

handleBeingLookedAt

makeContainerTypes

getExamineItemString

dispossessionTimeLeftString

getRiderAddendum

getFollowAddendum