CMMsg

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.planet_ink.coffee_mud.Common.interfaces
Interface CMMsg

All Superinterfaces:: java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:: DefaultMessage

public interface CMMsg
extends CMCommon
extends CMCommon

The core of event handling in CoffeeMud, a CMMsg represents an event that occurs. All events are caused by MOBs (even natural events). CMMsg objects are usually created by calling the CMClass classloader:

See Also:: Source The source of any message must always be a valid reference to an instance of the MOB interface. In short, all events that occur in the system are a direct result of the activity of a MOB. This is on the theory that the universe is controlled and governed by sentience. In the extremely rare instances where a mob is not readily available to provide a message source, one should be instantiated -- even if it is just a blank, new StdMOB. Target The target of a message may be null, or any valid reference to an instance of the Environmental interface, which includes Items, MOBs, Rooms, Exits, etc. The type and context of message you wish to generate will typically tell you intuitively whether the source is doing something to someone or something else, or is acting independently. This is usually another mob or an item, but you will find examples of all kinds of targets in the code. Tool The tool of a message may be null, or any valid reference to an instance of the Environmental interface, which includes Items, Abilities, MOBs, Rooms, Exits, etc. The tool represents something which the source is utilizing to accomplish the task or generate the event. This is typically either an Ability object (like a Spell or Skill being used), or an Item object (like a weapon in an attack event). Source Code This is an encoded integer which represents what the source MOB is actually doing. Codes are separable into major and minor codes, with the major code being a bitmask and the minor code being a constant integer representing the event type. See below. Source Message This is the string which the source MOB will see should the event occur successfully. Target Code This is an encoded integer which represents what is happening to the target. If there is no target, this number will typically have the value of 0 (CMMsg.NOEFFECT). Codes are separable into major and minor codes, with the major code being a bitmask and the minor code being a constant integer representing the event type. See below. Target Message This is the string which the target MOB (if it is a MOB) will see should the event occur successfully. If there is no target, this string is null. Others Code This is an encoded integer which represents how any other objects (such as MOBs, Items, Rooms, Exits) other than the source and target, in the same room, perceive the event. If the event is completely imperceptible by anything other than the source, it may be 0 (CMMsg.NOEFFECT) Codes are separable into major and minor codes, with the major code being a bitmask and the minor code being a constant integer representing the event type. See below. Others Message This is the string which other MOBs in the same room as the source and target MOBs will see should the event occur successfully. If the event is completely imperceptible by other MOBs, it may be null. ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** * ** You should also familiarize yourself with the interface that handles these events, MsgListener.okMessage(Environmental, CMMsg), MsgListener.executeMsg(Environmental, CMMsg), MsgListener, Room.send(MOB, CMMsg), Room.sendOthers(MOB, CMMsg)

Field Summary
`static int`	`MAJOR_MASK` Mask to remove the TYPE CODE from the source, target, or others code, leaving only MASK bits
`static int`	`MASK_ALWAYS` MAJOR_MASK bit denoting a source, target, or others code is always confirmed (involuntary usually)
`static int`	`MASK_CHANNEL` MAJOR_MASK bit denoting a source, target, or others code is a channel message
`static int`	`MASK_DELICATE` MAJOR_MASK bit denoting a source, target, or others code is thiefly, delicate
`static java.lang.String[]`	`MASK_DESCS` Index string descriptions of all the MAJOR_MASK code MAKS_s
`static int`	`MASK_EYES` MAJOR_MASK bit denoting a source, target, or others code does looking and seeing
`static int`	`MASK_HANDS` MAJOR_MASK bit denoting a source, target, or others code does small hand movements
`static int`	`MASK_MAGIC` MAJOR_MASK bit denoting a source, target, or others code is magical
`static int`	`MASK_MALICIOUS` MAJOR_MASK bit denoting a source, target, or others code is malicious, harmful to the target
`static int`	`MASK_MOUTH` MAJOR_MASK bit denoting a source, target, or others code does speaking and eating
`static int`	`MASK_MOVE` MAJOR_MASK bit denoting a source, target, or others code does large body movements (travel)
`static int`	`MASK_OPTIMIZE` MAJOR_MASK bit denoting an event that will be repeated, in order to optimize execution
`static int`	`MASK_SOUND` MAJOR_MASK bit denoting a source, target, or others code does general body noises
`static int`	`MINOR_MASK` Mask to remove the MAJOR_MASK from the source, target, or others code, leaving only TYPE
`static java.lang.Object[][]`	`MISC_DESCS` Addendum to TYPE_DESCS for codes above the last index (channels only at this point)
`static int`	`MSG_ACTIVATE` combined MAJOR and MINOR codes for useful event message type for a activate event
`static int`	`MSG_ADVANCE` combined MAJOR and MINOR codes for useful event message type for a combat advance event
`static int`	`MSG_AREAAFFECT` combined MAJOR and MINOR codes for useful event message type for general area effects
`static int`	`MSG_BID` combined MAJOR and MINOR codes for useful event message type for a auction bid event
`static int`	`MSG_BORROW` combined MAJOR and MINOR codes for useful event message type for a banker borrow event
`static int`	`MSG_BRINGTOLIFE` combined MAJOR and MINOR codes for useful event message type for a bring-to-life event
`static int`	`MSG_BUY` combined MAJOR and MINOR codes for useful event message type for a buy event
`static int`	`MSG_CAST` combined MAJOR and MINOR codes for useful event message type for a spellcasting event
`static int`	`MSG_CAST_ATTACK_SOMANTIC_SPELL` combined MAJOR and MINOR codes for useful event message type for a malicious somantic spellcasting event
`static int`	`MSG_CAST_ATTACK_VERBAL_SPELL` combined MAJOR and MINOR codes for useful event message type for a malicious verbal spellcasting event
`static int`	`MSG_CAST_MALICIOUS` combined MAJOR and MINOR codes for useful event message type for a malicious spellcasting event
`static int`	`MSG_CAST_SOMANTIC_SPELL` combined MAJOR and MINOR codes for useful event message type for a somantic spellcasting event
`static int`	`MSG_CAST_VERBAL_SPELL` combined MAJOR and MINOR codes for useful event message type for a verbal spellcasting event
`static int`	`MSG_CLOSE` combined MAJOR and MINOR codes for useful event message type for a close event
`static int`	`MSG_DAMAGE` combined MAJOR and MINOR codes for useful event message type for a damage event
`static int`	`MSG_DEACTIVATE` combined MAJOR and MINOR codes for useful event message type for a deactivate event
`static int`	`MSG_DEATH` combined MAJOR and MINOR codes for useful event message type for a death event
`static int`	`MSG_DELICATE_HANDS_ACT` combined MAJOR and MINOR codes for useful event message type for a thiefly large quiet event
`static int`	`MSG_DELICATE_SMALL_HANDS_ACT` combined MAJOR and MINOR codes for useful event message type for a thiefly delicate quiet event
`static int`	`MSG_DEPOSIT` combined MAJOR and MINOR codes for useful event message type for a bank deposit event
`static int`	`MSG_DISMOUNT` combined MAJOR and MINOR codes for useful event message type for a dismount event
`static int`	`MSG_DRINK` combined MAJOR and MINOR codes for useful event message type for a drink event
`static int`	`MSG_DROP` combined MAJOR and MINOR codes for useful event message type for a drop event
`static int`	`MSG_EAT` combined MAJOR and MINOR codes for useful event message type for a eat event
`static int`	`MSG_EAT_GROUND` combined MAJOR and MINOR codes for useful event message type for a eat event
`static int`	`MSG_EMOTE` combined MAJOR and MINOR codes for useful event message type for a emoting event
`static int`	`MSG_ENTER` combined MAJOR and MINOR codes for useful event message type for a enter event
`static int`	`MSG_EXAMINE` combined MAJOR and MINOR codes for useful event message type for a examine event
`static int`	`MSG_EXPIRE` combined MAJOR and MINOR codes for useful event message type for a item expire event
`static int`	`MSG_EXTINGUISH` combined MAJOR and MINOR codes for useful event message type for a extinguish event
`static int`	`MSG_FILL` combined MAJOR and MINOR codes for useful event message type for a fill event
`static int`	`MSG_FLEE` combined MAJOR and MINOR codes for useful event message type for a flee event
`static int`	`MSG_FOLLOW` combined MAJOR and MINOR codes for useful event message type for a follow event
`static int`	`MSG_GET` combined MAJOR and MINOR codes for useful event message type for a get event
`static int`	`MSG_GIVE` combined MAJOR and MINOR codes for useful event message type for a give event
`static int`	`MSG_HANDS` combined MAJOR and MINOR codes for useful event message type for a general hands event
`static int`	`MSG_HEALING` combined MAJOR and MINOR codes for useful event message type for a healing event
`static int`	`MSG_HOLD` combined MAJOR and MINOR codes for useful event message type for a hold event
`static int`	`MSG_HUH` combined MAJOR and MINOR codes for useful event message type for an unknown command event
`static int`	`MSG_KNOCK` combined MAJOR and MINOR codes for useful event message type for a knock event
`static int`	`MSG_LEAVE` combined MAJOR and MINOR codes for useful event message type for a leave event
`static int`	`MSG_LEVEL` combined MAJOR and MINOR codes for useful event message type for a level event
`static int`	`MSG_LIST` combined MAJOR and MINOR codes for useful event message type for a shopkeeper list event
`static int`	`MSG_LOCK` combined MAJOR and MINOR codes for useful event message type for a lock event
`static int`	`MSG_LOGIN` combined MAJOR and MINOR codes for useful event message type for a login event
`static int`	`MSG_LOOK` combined MAJOR and MINOR codes for useful event message type for a look event
`static int`	`MSG_MOUNT` combined MAJOR and MINOR codes for useful event message type for a mount event
`static int`	`MSG_NOFOLLOW` combined MAJOR and MINOR codes for useful event message type for a nofollow event
`static int`	`MSG_NOISE` combined MAJOR and MINOR codes for useful event message type for a noisy event
`static int`	`MSG_NOISYMOVEMENT` combined MAJOR and MINOR codes for useful event message type for a large noisy movement event
`static int`	`MSG_OK_ACTION` combined MAJOR and MINOR codes for useful event message type for a always confirmed noisy event
`static int`	`MSG_OK_VISUAL` combined MAJOR and MINOR codes for useful event message type for a always confirmed quiet event
`static int`	`MSG_OPEN` combined MAJOR and MINOR codes for useful event message type for a open event
`static int`	`MSG_ORDER` combined MAJOR and MINOR codes for useful event message type for a target order event
`static int`	`MSG_PANIC` combined MAJOR and MINOR codes for useful event message type for a panic event
`static int`	`MSG_PRACTICE` combined MAJOR and MINOR codes for useful event message type for a practice event
`static int`	`MSG_PULL` combined MAJOR and MINOR codes for useful event message type for a pull event
`static int`	`MSG_PUSH` combined MAJOR and MINOR codes for useful event message type for a push event
`static int`	`MSG_PUT` combined MAJOR and MINOR codes for useful event message type for a put event
`static int`	`MSG_QUIETMOVEMENT` combined MAJOR and MINOR codes for useful event message type for a large quiet movement event
`static int`	`MSG_QUIT` combined MAJOR and MINOR codes for useful event message type for a game quit event
`static int`	`MSG_READ` combined MAJOR and MINOR codes for useful event message type for a read event
`static int`	`MSG_REBUKE` combined MAJOR and MINOR codes for useful event message type for a rebuke event
`static int`	`MSG_RECALL` combined MAJOR and MINOR codes for useful event message type for a recall event
`static int`	`MSG_RELOAD` combined MAJOR and MINOR codes for useful event message type for a missile weapon reload event
`static int`	`MSG_REMOVE` combined MAJOR and MINOR codes for useful event message type for a remove event
`static int`	`MSG_RETIRE` combined MAJOR and MINOR codes for useful event message type for a retire event
`static int`	`MSG_RETREAT` combined MAJOR and MINOR codes for useful event message type for a combat retreat event
`static int`	`MSG_ROOMRESET` combined MAJOR and MINOR codes for useful event message type for a room reset event
`static int`	`MSG_SELL` combined MAJOR and MINOR codes for useful event message type for a sell event
`static int`	`MSG_SERVE` combined MAJOR and MINOR codes for useful event message type for a serve event
`static int`	`MSG_SHUTDOWN` combined MAJOR and MINOR codes for useful event message type for a game shutdown event
`static int`	`MSG_SIT` combined MAJOR and MINOR codes for useful event message type for a sit event
`static int`	`MSG_SITMOVE` combined MAJOR and MINOR codes for useful event message type for a crawl event
`static int`	`MSG_SLEEP` combined MAJOR and MINOR codes for useful event message type for a sleep event
`static int`	`MSG_SNIFF` combined MAJOR and MINOR codes for useful event message type for a sniff event
`static int`	`MSG_SPEAK` combined MAJOR and MINOR codes for useful event message type for a speak event
`static int`	`MSG_STAND` combined MAJOR and MINOR codes for useful event message type for a stand event
`static int`	`MSG_TEACH` combined MAJOR and MINOR codes for useful event message type for a teach event
`static int`	`MSG_TELL` combined MAJOR and MINOR codes for useful event message type for a tell event
`static int`	`MSG_THIEF_ACT` combined MAJOR and MINOR codes for useful event message type for a general thiefly embarrassing event
`static int`	`MSG_THROW` combined MAJOR and MINOR codes for useful event message type for a throw event
`static int`	`MSG_UNLOCK` combined MAJOR and MINOR codes for useful event message type for a unlock event
`static int`	`MSG_VALUE` combined MAJOR and MINOR codes for useful event message type for a shopkeeper value event
`static int`	`MSG_VIEW` combined MAJOR and MINOR codes for useful event message type for a shop view event
`static int`	`MSG_WEAPONATTACK` combined MAJOR and MINOR codes for useful event message type for a physical attack event
`static int`	`MSG_WEAR` combined MAJOR and MINOR codes for useful event message type for a wear event
`static int`	`MSG_WIELD` combined MAJOR and MINOR codes for useful event message type for a wield event
`static int`	`MSG_WITHDRAW` combined MAJOR and MINOR codes for useful event message type for a bank withdraw event
`static int`	`MSG_WRITE` combined MAJOR and MINOR codes for useful event message type for a write event
`static int`	`MSK_CAST` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting both verbal and somantic
`static int`	`MSK_CAST_MALICIOUS` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting both verbal and somantic maliciously
`static int`	`MSK_CAST_MALICIOUS_SOMANTIC` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting somantic malicious magic
`static int`	`MSK_CAST_MALICIOUS_VERBAL` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting verbal malicious magic
`static int`	`MSK_CAST_SOMANTIC` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting somantic magic
`static int`	`MSK_CAST_VERBAL` Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting verbal magic
`static int`	`MSK_HAGGLE` Useful MAJOR_MASK shortcut combining other MASK_ constants related to haggling over price
`static int`	`MSK_MALICIOUS_MOVE` Useful MAJOR_MASK shortcut combining other MASK_ constants related to malicious noisy movements
`static int`	`NO_EFFECT` combined MAJOR and MINOR codes for useful event message type that does absolutely nothing
`static int`	`TYP_ACID` MINOR_MASK minor action code type, denoting a melting action
`static int`	`TYP_ACTIVATE` MINOR_MASK minor action code type, denoting an activate action
`static int`	`TYP_ADVANCE` MINOR_MASK minor action code type, denoting an advance on target action
`static int`	`TYP_AREAAFFECT` MINOR_MASK minor action code type, denoting a general area event
`static int`	`TYP_BID` MINOR_MASK minor action code type, denoting a auctioneer bid action
`static int`	`TYP_BORROW` MINOR_MASK minor action code type, denoting a banker borrow action
`static int`	`TYP_BUY` MINOR_MASK minor action code type, denoting a buy action
`static int`	`TYP_CAST_SPELL` MINOR_MASK minor action code type, denoting a spell casting action
`static int`	`TYP_CHANNEL` MINOR_MASK minor action code type, denoting a channel action -- 2000-2047 are channels
`static int`	`TYP_CLOSE` MINOR_MASK minor action code type, denoting a close action
`static int`	`TYP_COLD` MINOR_MASK minor action code type, denoting a freezing action
`static int`	`TYP_DAMAGE` MINOR_MASK minor action code type, denoting a general damaging action
`static int`	`TYP_DEACTIVATE` MINOR_MASK minor action code type, denoting a deactivate action
`static int`	`TYP_DEATH` MINOR_MASK minor action code type, denoting a dying action
`static int`	`TYP_DELICATE_HANDS_ACT` MINOR_MASK minor action code type, denoting a delicate, thiefly action
`static int`	`TYP_DEPOSIT` MINOR_MASK minor action code type, denoting a shopkeeper deposit action
`static int`	`TYP_DISEASE` MINOR_MASK minor action code type, denoting a disease spreading action
`static int`	`TYP_DISMOUNT` MINOR_MASK minor action code type, denoting a dismount action
`static int`	`TYP_DRINK` MINOR_MASK minor action code type, denoting a drink action
`static int`	`TYP_DROP` MINOR_MASK minor action code type, denoting a drop action
`static int`	`TYP_EAT` MINOR_MASK minor action code type, denoting a eat action
`static int`	`TYP_ELECTRIC` MINOR_MASK minor action code type, denoting a shocking action
`static int`	`TYP_EMOTE` MINOR_MASK minor action code type, denoting an emote action
`static int`	`TYP_ENTER` MINOR_MASK minor action code type, denoting a entering action
`static int`	`TYP_EXAMINE` MINOR_MASK minor action code type, denoting a close look/examine action
`static int`	`TYP_EXPCHANGE` MINOR_MASK minor action code type, denoting a xp gain/loss action
`static int`	`TYP_EXPIRE` MINOR_MASK minor action code type, denoting an item/room expiration action
`static int`	`TYP_EXTINGUISH` MINOR_MASK minor action code type, denoting a extinguishing action
`static int`	`TYP_FACTIONCHANGE` MINOR_MASK minor action code type, denoting a gain or loss of faction
`static int`	`TYP_FILL` MINOR_MASK minor action code type, denoting a fill action
`static int`	`TYP_FIRE` MINOR_MASK minor action code type, denoting a flaming action
`static int`	`TYP_FLEE` MINOR_MASK minor action code type, denoting a fleeing action
`static int`	`TYP_FOLLOW` MINOR_MASK minor action code type, denoting a following action
`static int`	`TYP_GAS` MINOR_MASK minor action code type, denoting a gassing action
`static int`	`TYP_GENERAL` MINOR_MASK minor action code type, denoting a general unknown action
`static int`	`TYP_GET` MINOR_MASK minor action code type, denoting a get action
`static int`	`TYP_GIVE` MINOR_MASK minor action code type, denoting a give action
`static int`	`TYP_HANDS` MINOR_MASK minor action code type, denoting a small hands, non-movement action
`static int`	`TYP_HEALING` MINOR_MASK minor action code type, denoting a healing action
`static int`	`TYP_HOLD` MINOR_MASK minor action code type, denoting a hold action
`static int`	`TYP_HUH` MINOR_MASK minor action code type, denoting an unknown command action
`static int`	`TYP_JUSTICE` MINOR_MASK minor action code type, denoting an embarrasing action
`static int`	`TYP_KNOCK` MINOR_MASK minor action code type, denoting a knock action
`static int`	`TYP_LEAVE` MINOR_MASK minor action code type, denoting a leaving action
`static int`	`TYP_LEVEL` MINOR_MASK minor action code type, denoting a level gain action
`static int`	`TYP_LIFE` MINOR_MASK minor action code type, denoting a bring-to-life action
`static int`	`TYP_LIST` MINOR_MASK minor action code type, denoting a shopkeeper list action
`static int`	`TYP_LOCK` MINOR_MASK minor action code type, denoting a lock action
`static int`	`TYP_LOGIN` MINOR_MASK minor action code type, denoting a login action
`static int`	`TYP_LOOK` MINOR_MASK minor action code type, denoting a look action
`static int`	`TYP_MIND` MINOR_MASK minor action code type, denoting a mind-affecting action
`static int`	`TYP_MOUNT` MINOR_MASK minor action code type, denoting a mount action
`static int`	`TYP_NOFOLLOW` MINOR_MASK minor action code type, denoting a nofollow action
`static int`	`TYP_NOISE` MINOR_MASK minor action code type, denoting a noisy, non-movement action
`static int`	`TYP_NOISYMOVEMENT` MINOR_MASK minor action code type, denoting a noisy, large movement action
`static int`	`TYP_OK_ACTION` MINOR_MASK minor action code type, denoting a general noisy movement action
`static int`	`TYP_OK_VISUAL` MINOR_MASK minor action code type, denoting a general non-noisy movement action
`static int`	`TYP_OPEN` MINOR_MASK minor action code type, denoting a open action
`static int`	`TYP_ORDER` MINOR_MASK minor action code type, denoting a order target action
`static int`	`TYP_PANIC` MINOR_MASK minor action code type, denoting a panic/near death action
`static int`	`TYP_PARALYZE` MINOR_MASK minor action code type, denoting a paralyzing action
`static int`	`TYP_POISON` MINOR_MASK minor action code type, denoting a poisoning action
`static int`	`TYP_PRACTICE` MINOR_MASK minor action code type, denoting a practice action
`static int`	`TYP_PULL` MINOR_MASK minor action code type, denoting a pull action
`static int`	`TYP_PUSH` MINOR_MASK minor action code type, denoting a push action
`static int`	`TYP_PUT` MINOR_MASK minor action code type, denoting a put action
`static int`	`TYP_QUIETMOVEMENT` MINOR_MASK minor action code type, denoting a quiet, large movement action
`static int`	`TYP_QUIT` MINOR_MASK minor action code type, denoting a game quitting action
`static int`	`TYP_READ` MINOR_MASK minor action code type, denoting a read action
`static int`	`TYP_REBUKE` MINOR_MASK minor action code type, denoting a rebuke action
`static int`	`TYP_RECALL` MINOR_MASK minor action code type, denoting a recall action
`static int`	`TYP_RELOAD` MINOR_MASK minor action code type, denoting a missile weapon reload action
`static int`	`TYP_REMOVE` MINOR_MASK minor action code type, denoting a remove action
`static int`	`TYP_RETIRE` MINOR_MASK minor action code type, denoting a player retire action
`static int`	`TYP_RETREAT` MINOR_MASK minor action code type, denoting a target retreat from action
`static int`	`TYP_ROOMRESET` MINOR_MASK minor action code type, denoting a room resetting action
`static int`	`TYP_SELL` MINOR_MASK minor action code type, denoting a sell action
`static int`	`TYP_SERVE` MINOR_MASK minor action code type, denoting a serve action
`static int`	`TYP_SHUTDOWN` MINOR_MASK minor action code type, denoting a game shutdown action
`static int`	`TYP_SIT` MINOR_MASK minor action code type, denoting a sitting action
`static int`	`TYP_SITMOVE` MINOR_MASK minor action code type, denoting a crawling/sit enter action
`static int`	`TYP_SLEEP` MINOR_MASK minor action code type, denoting a sleeping action
`static int`	`TYP_SNIFF` MINOR_MASK minor action code type, denoting a sniff action
`static int`	`TYP_SPEAK` MINOR_MASK minor action code type, denoting a speaking action
`static int`	`TYP_STAND` MINOR_MASK minor action code type, denoting a standing action
`static int`	`TYP_TEACH` MINOR_MASK minor action code type, denoting a teach action
`static int`	`TYP_TELL` MINOR_MASK minor action code type, denoting a tell action
`static int`	`TYP_THROW` MINOR_MASK minor action code type, denoting a throw action
`static int`	`TYP_UNDEAD` MINOR_MASK minor action code type, denoting a cold evil undead action
`static int`	`TYP_UNLOCK` MINOR_MASK minor action code type, denoting a unlock action
`static int`	`TYP_VALUE` MINOR_MASK minor action code type, denoting a shopkeeper value action
`static int`	`TYP_VIEW` MINOR_MASK minor action code type, denoting a shopkeeper view action
`static int`	`TYP_WAND_USE` MINOR_MASK minor action code type, denoting a wand activation action
`static int`	`TYP_WATER` MINOR_MASK minor action code type, denoting a wet action
`static int`	`TYP_WEAPONATTACK` MINOR_MASK minor action code type, denoting a physical attack
`static int`	`TYP_WEAR` MINOR_MASK minor action code type, denoting a wear action
`static int`	`TYP_WIELD` MINOR_MASK minor action code type, denoting a wield action
`static int`	`TYP_WITHDRAW` MINOR_MASK minor action code type, denoting a shopkeeper withdraw action
`static int`	`TYP_WRITE` MINOR_MASK minor action code type, denoting a writing action
`static java.lang.String[]`	`TYPE_DESCS` Index string descriptions of all the MINOR_MASK action code TYP_s

Method Summary
`void`	`addTrailerMsg(CMMsg msg)` Appends to the Vector of other CMMsg events which are slated to be confirmed and executed AFTER this current message is handled.
`boolean`	`amISource(MOB thisOne)` Returns whether the given Environmental object is, in fact, the source of this message.
`boolean`	`amITarget(Environmental thisOne)` Returns whether the given Environmental object is, in fact, the target of this message.
`boolean`	`isOthers(Environmental E)` Returns whether the given Environmental object is neither the source nor the target of this message.
`boolean`	`isOthers(int codeOrMask)` Returns whether the given code or mask is either the minor code or a part of the major code of the othersCode
`boolean`	`isOthers(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor code or a part of the major code of the othersCode.
`boolean`	`isSource(Environmental E)` Returns whether the given Environmental object is, in fact, the source of this message.
`boolean`	`isSource(int codeOrMask)` Returns whether the given code or mask is either the minor code or a part of the major code of the sourceCode
`boolean`	`isSource(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor code or a part of the major code of the sourceCode.
`boolean`	`isTarget(Environmental E)` Returns whether the given Environmental object is, in fact, the target of this message.
`boolean`	`isTarget(int codeOrMask)` Returns whether the given code or mask is either the minor code or a part of the major code of the targetCode
`boolean`	`isTarget(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor code or a part of the major code of the targetCode.
`void`	`modify(MOB source, Environmental target, Environmental tool, int newSourceCode, int newTargetCode, int newOthersCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, Environmental target, Environmental tool, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, Environmental target, Environmental tool, int newSourceCode, java.lang.String sourceMessage, int newTargetCode, java.lang.String targetMessage, int newOthersCode, java.lang.String othersMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, Environmental target, Environmental tool, int newAllCode, java.lang.String sourceMessage, java.lang.String targetMessage, java.lang.String othersMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, Environmental target, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`void`	`modify(MOB source, int newAllCode, java.lang.String allMessage, int newValue)` Modifies one of more fields in this event.
`int`	`othersCode()` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the others of the action.
`int`	`othersMajor()` Returns high order bitmask for the others code (Others are everyone not source, not target)
`java.lang.String`	`othersMessage()` Returns the string seen by the others of the event, and only by the others of the event.
`int`	`othersMinor()` Returns low order action type integer for the others code (Others are everyone not source, not target)
`void`	`setOthersCode(int code)` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the others of the action.
`void`	`setOthersMessage(java.lang.String str)` Sets the string seen by the others of the event, and only by the others of the event.
`void`	`setSource(MOB mob)` Sets the source of this event, a MOB object
`void`	`setSourceCode(int code)` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the source of the action.
`void`	`setSourceMessage(java.lang.String str)` Sets the string seen by the source of the event, and only by the source of the event.
`void`	`setTarget(Environmental E)` Sets the target of this event, an Environmental object
`void`	`setTargetCode(int code)` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the target of the action.
`void`	`setTargetMessage(java.lang.String str)` Sets the string seen by the target of the event, and only by the target of the event.
`void`	`setTool(Environmental E)` Sets the means, item, portal, or otherwise tool that helps the source affect the event upon the target.
`void`	`setValue(int amount)` Sets an arbitrary integer value associated with this event.
`MOB`	`source()` Returns the source of this event, a MOB object
`int`	`sourceCode()` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the source of the action.
`int`	`sourceMajor()` Returns high order bitmask for the source code
`java.lang.String`	`sourceMessage()` Returns the string seen by the source of the event, and only by the source of the event.
`int`	`sourceMinor()` Returns low order action type integer for the target code
`Environmental`	`target()` Returns the target of this event, an Environmental object
`int`	`targetCode()` A combination bitmask, action type integer that describes information about how this event affects or is perceived by the target of the action.
`int`	`targetMajor()` Returns high order bitmask for the target code
`java.lang.String`	`targetMessage()` Returns the string seen by the target of the event, and only by the target of the event.
`int`	`targetMinor()` Returns low order action type integer for the target code
`Environmental`	`tool()` Returns the means, item, portal, or otherwise tool that helps the source affect the event upon the target.
`java.util.Vector`	`trailerMsgs()` &n

com.planet_ink.coffee_mud.Common.interfaces Interface CMMsg

com.planet_ink.coffee_mud.Common.interfaces
Interface CMMsg