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.

Method Summary

void	addGlobalMonitor(MsgMonitor M)
void	delGlobalMonitor(MsgMonitor M)
java.lang.Object	forceInternalCommand(MOB mob, java.lang.String command, java.lang.Object... parms)
boolean	forceStandardCommand(MOB mob, java.lang.String command, java.util.List<java.lang.String> parms)
java.lang.StringBuilder	getEquipment(MOB viewer, MOB mob)
java.lang.String	getExamineItemString(MOB mob, Item item)
java.lang.StringBuilder	getInventory(MOB viewer, MOB mob)
java.lang.StringBuilder	getScore(MOB mob)
void	handleBeingDropped(CMMsg msg)
void	handleBeingGetted(CMMsg msg)
void	handleBeingGivenTo(CMMsg msg)
void	handleBeingHeld(CMMsg msg)
void	handleBeingLookedAt(CMMsg msg)
void	handleBeingRead(CMMsg msg)
void	handleBeingRemoved(CMMsg msg)
void	handleBeingSniffed(CMMsg msg)
void	handleBeingSpokenTo(MOB speaker, MOB me, java.lang.String msg)
void	handleBeingWielded(CMMsg msg)
void	handleBeingWorn(CMMsg msg)
void	handleComeToLife(MOB mob, CMMsg msg)
void	handleHygienicMessage(CMMsg msg, int minHygiene, long adjHygiene)
void	handleIntroductions(MOB speaker, MOB me, java.lang.String said)
void	handleObserveComesToLife(MOB observer, MOB lifer, CMMsg msg)
void	handleRecall(CMMsg msg)
void	handleSit(CMMsg msg)
void	handleSleep(CMMsg msg)
void	handleStand(CMMsg msg)
boolean	handleUnknownCommand(MOB mob, java.util.List<java.lang.String> command)
boolean	isHygienicMessage(CMMsg msg, int minHygiene, long adjHygiene)
void	lookAtExits(Room room, MOB mob)
void	lookAtExitsShort(Room room, MOB mob)
void	monitorGlobalMessage(Room room, CMMsg msg)
void	postChannel(MOB mob, java.lang.String channelName, java.lang.String message, boolean systemMsg)
void	postChannel(java.lang.String channelName, java.lang.Iterable<Pair<Clan,java.lang.Integer>> clanList, java.lang.String message, boolean systemMsg)
boolean	postCommandFail(MOB mob, Environmental target, Environmental tools, java.util.List<java.lang.String> command, java.lang.String msgStr)
boolean	postCommandFail(MOB mob, java.util.List<java.lang.String> commands, java.lang.String msgStr)
boolean	postCommandRejection(MOB mob, Environmental target, Environmental tools, java.util.List<java.lang.String> command)
boolean	postCommandRejection(MOB mob, java.util.List<java.lang.String> commands)
void	postDraw(MOB mob, boolean doHold, boolean ifNecessary)
boolean	postDrop(MOB mob, Environmental dropThis, boolean quiet, boolean optimized, boolean intermediate)
void	postFlee(MOB mob, java.lang.String whereTo)
void	postFollow(MOB follower, MOB leader, boolean quiet)
boolean	postGet(MOB mob, Item container, Item getThis, boolean quiet)
boolean	postGive(MOB mob, MOB targetM, Item giveThis, boolean quiet)
void	postLook(MOB mob, boolean quiet)
boolean	postOpen(MOB mob, Environmental openThis, boolean quiet)
boolean	postPut(MOB mob, Item container, Item getThis, boolean quiet)
void	postRead(MOB mob, Physical target, java.lang.String readOff, boolean quiet)
boolean	postRemove(MOB mob, Item item, boolean quiet)
void	postSay(MOB mob, MOB target, java.lang.String text)
void	postSay(MOB mob, MOB target, java.lang.String text, boolean isPrivate, boolean tellFlag)
void	postSay(MOB mob, java.lang.String text)
void	postSheath(MOB mob, boolean ifPossible)
void	postSleep(MOB mob)
void	postStand(MOB mob, boolean ifNecessary, boolean quietly)
boolean	postWear(MOB mob, Item item, boolean quiet)
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)

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

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

delGlobalMonitor

void delGlobalMonitor(MsgMonitor M)

monitorGlobalMessage

void monitorGlobalMessage(Room room,
                          CMMsg msg)

addGlobalMonitor

void addGlobalMonitor(MsgMonitor M)

forceStandardCommand

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

forceInternalCommand

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

unforcedInternalCommand

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

getScore

java.lang.StringBuilder getScore(MOB mob)

getEquipment

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

getInventory

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

getExamineItemString

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

isHygienicMessage

boolean isHygienicMessage(CMMsg msg,
                          int minHygiene,
                          long adjHygiene)

postCommandFail

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

postCommandFail

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

postCommandRejection

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

postCommandRejection

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

postChannel

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

postChannel

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

postDrop

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

postGive

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

postOpen

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

postGet

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

postPut

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

postRemove

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

postWear

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

postLook

void postLook(MOB mob,
              boolean quiet)

postRead

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

postFlee

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

postSheath

void postSheath(MOB mob,
                boolean ifPossible)

postDraw

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

postStand

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

postSleep

void postSleep(MOB mob)

postFollow

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

postSay

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

postSay

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

postSay

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

lookAtExits

void lookAtExits(Room room,
                 MOB mob)

lookAtExitsShort

void lookAtExitsShort(Room room,
                      MOB mob)

handleBeingLookedAt

void handleBeingLookedAt(CMMsg msg)

handleBeingRead

void handleBeingRead(CMMsg msg)

handleRecall

void handleRecall(CMMsg msg)

handleSit

void handleSit(CMMsg msg)

handleStand

void handleStand(CMMsg msg)

handleSleep

void handleSleep(CMMsg msg)

handleBeingSniffed

void handleBeingSniffed(CMMsg msg)

handleBeingGivenTo

void handleBeingGivenTo(CMMsg msg)

handleBeingGetted

void handleBeingGetted(CMMsg msg)

handleBeingDropped

void handleBeingDropped(CMMsg msg)

handleBeingRemoved

void handleBeingRemoved(CMMsg msg)

handleBeingWorn

void handleBeingWorn(CMMsg msg)

handleBeingWielded

void handleBeingWielded(CMMsg msg)

handleBeingHeld

void handleBeingHeld(CMMsg msg)

handleHygienicMessage

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

handleIntroductions

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

handleBeingSpokenTo

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

handleComeToLife

void handleComeToLife(MOB mob,
                      CMMsg msg)

handleObserveComesToLife

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

handleUnknownCommand

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