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 (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 (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)

Nested Class Summary
`static class`	`CMMsg.CheckedMsgResponse` An enum to use for an external message check from inside an okMessage method.
`static class`	`CMMsg.Desc` An accessor for safely converting raw message codes into friendlier description codes, and back again.
`static class`	`CMMsg.View` An enum for the three major views of a message, source, target, or others

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_CNTRLMSG` MAJOR_MASK bit denoting an event that is for system processing, and not observable
`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_INTERMSG` MAJOR_MASK bit denoting an event that is for system processing, and not observable
`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_ATTACKMISS` combined MAJOR and MINOR codes for useful event message type for a failed combat attack
`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_CLANEVENT` combined MAJOR and MINOR codes for useful event message type for a clan event
`static int`	`MSG_CLOSE` combined MAJOR and MINOR codes for useful event message type for a close event
`static int`	`MSG_COLLISION` combined MAJOR and MINOR codes for useful event message type for a collision
`static int`	`MSG_COMMAND` combined MAJOR and MINOR codes for useful event message type for a fail to target in a command
`static int`	`MSG_COMMANDFAIL` combined MAJOR and MINOR codes for useful event message type for a fail to target in a command
`static int`	`MSG_COMMANDREJECT` combined MAJOR and MINOR codes for useful event message type for a command msgs rejection
`static int`	`MSG_CONTEMPLATE` combined MAJOR and MINOR codes for useful event message type for power current flow
`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_DIG` combined MAJOR and MINOR codes for useful event message type for a physical digging action
`static int`	`MSG_DISMOUNT` combined MAJOR and MINOR codes for useful event message type for a dismount event
`static int`	`MSG_DISPOSSESS` combined MAJOR and MINOR codes for useful event message type for a un-possession
`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_DUELCHALLENGE` combined MAJOR and MINOR codes for useful event message type for a duel challenge
`static int`	`MSG_DUELLOSS` combined MAJOR and MINOR codes for useful event message type for a loss in a duel
`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_ENHANCE` combined MAJOR and MINOR codes for useful event message type for a tech enhance
`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_GRAVITY` combined MAJOR and MINOR codes for useful event message type for a activate 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_INSTALL` combined MAJOR and MINOR codes for useful event message type for a tech install
`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_LEGALSTATE` combined MAJOR and MINOR codes for useful event message type for a lega state change
`static int`	`MSG_LEGALWARRANT` combined MAJOR and MINOR codes for useful event message type for a duel challenge
`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_LOOK_EXITS` combined MAJOR and MINOR codes for useful event message type for looking around at exits
`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_POSSESS` combined MAJOR and MINOR codes for useful event message type for a possession
`static int`	`MSG_POUR` combined MAJOR and MINOR codes for useful event message type for a pour onto event
`static int`	`MSG_POWERCURRENT` combined MAJOR and MINOR codes for useful event message type for power current flow
`static int`	`MSG_PRACTICE` combined MAJOR and MINOR codes for useful event message type for a practice event
`static int`	`MSG_PREINVOKE` combined MAJOR and MINOR codes for useful event message type for a possibly invoked skill
`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_REPAIR` combined MAJOR and MINOR codes for useful event message type for a tech repair
`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_REWRITE` combined MAJOR and MINOR codes for useful event message type for a re-write 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_STARTUP` combined MAJOR and MINOR codes for useful event message type for a mud startup
`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_THINK` combined MAJOR and MINOR codes for useful event message type for a thinking event
`static int`	`MSG_THROW` combined MAJOR and MINOR codes for useful event message type for a throw event
`static int`	`MSG_TRAVEL` combined MAJOR and MINOR codes for useful event message type for a enter event
`static int`	`MSG_UNLOAD` combined MAJOR and MINOR codes for useful event message type for a missile weapon reload 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_WASREAD` combined MAJOR and MINOR codes for useful event message type for a was read 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_WEATHER` combined MAJOR and MINOR codes for useful event message type for weather effects
`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`	`MSG_WROTE` combined MAJOR and MINOR codes for useful event message type for a fail to target in a command
`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_AROMA` MINOR_MASK minor action code type, denoting a general unknown action
`static int`	`TYP_ATTACKMISS` MINOR_MASK minor action code type, denoting a standard combat miss
`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_CLANEVENT` MINOR_MASK minor action code type, denoting a clan event
`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_COLLISION` MINOR_MASK minor action code type, denoting a collision
`static int`	`TYP_COMMAND` MINOR_MASK minor action code type, denoting a meta-message command
`static int`	`TYP_COMMANDFAIL` MINOR_MASK minor action code type, denoting a command that was mistargeted
`static int`	`TYP_COMMANDREJECT` MINOR_MASK minor action code type, denoting a command's msg was rejected
`static int`	`TYP_CONTEMPLATE` MINOR_MASK minor action code type, denoting power current flowing
`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_DIG` MINOR_MASK minor action code type, denoting the digging a hole 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_DISPOSSESS` MINOR_MASK minor action code type, denoting dispossession of a possessed body
`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_DUELCHALLENGE` MINOR_MASK minor action code type, denoting a challenge to the duel
`static int`	`TYP_DUELLOSS` MINOR_MASK minor action code type, denoting a loss in a duel
`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_ENHANCE` MINOR_MASK minor action code type, denoting a tech enhance
`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_GRAVITY` MINOR_MASK minor action code type, denoting a gravitic move
`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_INSTALL` MINOR_MASK minor action code type, denoting a tech install
`static int`	`TYP_ITEMGENERATED` MINOR_MASK minor action code type, denoting a completed item generation activty
`static int`	`TYP_ITEMSGENERATED` MINOR_MASK minor action code type, denoting a completed item generation activty
`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_LASER` MINOR_MASK minor action code type, denoting a laser action
`static int`	`TYP_LEAVE` MINOR_MASK minor action code type, denoting a leaving action
`static int`	`TYP_LEGALSTATE` MINOR_MASK minor action code type, denoting a legal state change
`static int`	`TYP_LEGALWARRANT` MINOR_MASK minor action code type, denoting a legal matter
`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_LOOK_EXITS` MINOR_MASK minor action code type, denoting a specific glance at the exits
`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_POSSESS` MINOR_MASK minor action code type, denoting possession of one body by another
`static int`	`TYP_POUR` MINOR_MASK minor action code type, denoting power current flowing
`static int`	`TYP_POWERCURRENT` MINOR_MASK minor action code type, denoting power current flowing
`static int`	`TYP_PRACTICE` MINOR_MASK minor action code type, denoting a practice action
`static int`	`TYP_PREINVOKE` MINOR_MASK minor action code type, denoting a skill possibly invoked
`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_RECIPELEARNED` MINOR_MASK minor action code type, denoting a completed item recipe learn activty
`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_REPAIR` MINOR_MASK minor action code type, denoting a tech repair
`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_REWRITE` MINOR_MASK minor action code type, denoting a rewrite activty
`static int`	`TYP_ROOMRESET` MINOR_MASK minor action code type, denoting a room resetting action
`static int`	`TYP_RPXPCHANGE` MINOR_MASK minor action code type, denoting a rp xp gain/loss 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_SONIC` MINOR_MASK minor action code type, denoting a sonic 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_STARTUP` MINOR_MASK minor action code type, denoting a room coming to life
`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_THINK` MINOR_MASK minor action code type, denoting thinking
`static int`	`TYP_THROW` MINOR_MASK minor action code type, denoting a throw action
`static int`	`TYP_TRAVEL` MINOR_MASK minor action code type, denoting an intention to move
`static int`	`TYP_UNDEAD` MINOR_MASK minor action code type, denoting a cold evil undead action
`static int`	`TYP_UNLOAD` MINOR_MASK minor action code type, denoting a missile weapon unload 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_WASREAD` MINOR_MASK minor action code type, denoting a finally read message
`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_WEATHER` MINOR_MASK minor action code type, denoting a standard weather affect
`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 int`	`TYP_WROTE` MINOR_MASK minor action code type, denoting a write activity
`static java.lang.String[]`	`TYPE_DESCS` Index string descriptions of all the MINOR_MASK action code TYP_s

Method Summary
`CMMsg`	`addTrailerMsg(CMMsg msg)` Appends to the list of other CMMsg events which are slated to be confirmed and executed AFTER this current message is handled.
`CMMsg`	`addTrailerRunnable(java.lang.Runnable runner)` Appends to the list of Runnable objects 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`	`isOthersMajor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches a part of the major code of the othersCode.
`boolean`	`isOthersMinor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor sourceCode (Others are everyone not source, not target)
`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`	`isSourceMajor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches a part of the major code of the sourceCode.
`boolean`	`isSourceMinor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor 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.
`boolean`	`isTargetMajor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches a part of the major code of the targetCode.
`boolean`	`isTargetMinor(java.lang.String codeOrMaskDesc)` Returns whether the given code or mask string matches the minor sourceCode
`CMMsg`	`modify(int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`CMMsg`	`modify(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.
`CMMsg`	`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.
`CMMsg`	`modify(MOB source, Environmental target, Environmental tool, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`CMMsg`	`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.
`CMMsg`	`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.
`CMMsg`	`modify(MOB source, Environmental target, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`CMMsg`	`modify(MOB source, int newAllCode, java.lang.String allMessage)` Modifies one of more fields in this event.
`CMMsg`	`modify(MOB source, int newAllCode, java.lang.String allMessage, int newValue)` Modifies one of more fields in this event.
`CMMsg`	`modify(java.lang.String allMessage)` 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)
`boolean`	`othersMajor(int bitMask)` Returns whether high order bitmask for the others code is set (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`	`parseFlatString(java.lang.String flat)` Unserializes this message as well as it reasonably can.
`boolean`	`sameAs(CMMsg E)` Whether this object instance is functionally identical to the object passed in.
`CMMsg`	`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.
`CMMsg`	`setOthersMessage(java.lang.String str)` Sets the string seen by the others of the event, and only by the others of the event.
`CMMsg`	`setSource(MOB mob)` Sets the source of this event, a MOB object
`CMMsg`	`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.
`CMMsg`	`setSourceMessage(java.lang.String str)` Sets the string seen by the source of the event, and only by the source of the event.
`CMMsg`	`setTarget(Environmental E)` Sets the target of this event, an Environmental object
`CMMsg`	`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.
`CMMsg`	`setTargetMessage(java.lang.String str)` Sets the string seen by the target of the event, and only by the target of the event.
`CMMsg`	`setTool(Environmental E)` Sets the means, item, portal, or otherwise tool that helps the source affect the event upon the target.
`CMMsg`	`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
`boolean`	`sourceMajor(int bitMask)` Returns whether high order bitmask for the source code is set
`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
`boolean`	`targetMajor(int bitMask)` Returns whether high order bitmask for the target code is set
`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
`java.lang.String`	`toFlatString()` Serializes this message as well as it reasonably can.
`Environmental`	`tool()` Returns the means, item, portal, or otherwise tool that helps the source affect the event upon the target.
`java.util.List<CMMsg>`	`trailerMsgs()` Returns a List of other CMMsg events which are slated to be confirmed and executed AFTER this current message is handled.
`java.util.List<java.lang.Runnable>`	`trailerRunnables()` Returns a List of other Runnables which are slated to be and executed AFTER this current message is handled.
`int`	`value()` Returns the arbitrary value integer associated with this event.

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`

Field Detail

MINOR_MASK

static final int MINOR_MASK

Mask to remove the MAJOR_MASK from the source, target, or others code, leaving only TYPE

See Also:: Constant Field Values

MAJOR_MASK

static final int MAJOR_MASK

Mask to remove the TYPE CODE from the source, target, or others code, leaving only MASK bits

See Also:: Constant Field Values

MASK_HANDS

static final int MASK_HANDS

MAJOR_MASK bit denoting a source, target, or others code does small hand movements

See Also:: Constant Field Values

MASK_MOVE

static final int MASK_MOVE

MAJOR_MASK bit denoting a source, target, or others code does large body movements (travel)

See Also:: Constant Field Values

MASK_EYES

static final int MASK_EYES

MAJOR_MASK bit denoting a source, target, or others code does looking and seeing

See Also:: Constant Field Values

MASK_MOUTH

static final int MASK_MOUTH

MAJOR_MASK bit denoting a source, target, or others code does speaking and eating

See Also:: Constant Field Values

MASK_SOUND

static final int MASK_SOUND

MAJOR_MASK bit denoting a source, target, or others code does general body noises

See Also:: Constant Field Values

MASK_ALWAYS

static final int MASK_ALWAYS

MAJOR_MASK bit denoting a source, target, or others code is always confirmed (involuntary usually)

See Also:: Constant Field Values

MASK_MAGIC

static final int MASK_MAGIC

MAJOR_MASK bit denoting a source, target, or others code is magical

See Also:: Constant Field Values

MASK_DELICATE

static final int MASK_DELICATE

MAJOR_MASK bit denoting a source, target, or others code is thiefly, delicate

See Also:: Constant Field Values

MASK_MALICIOUS

static final int MASK_MALICIOUS

MAJOR_MASK bit denoting a source, target, or others code is malicious, harmful to the target

See Also:: Constant Field Values

MASK_CHANNEL

static final int MASK_CHANNEL

MAJOR_MASK bit denoting a source, target, or others code is a channel message

See Also:: Constant Field Values

MASK_OPTIMIZE

static final int MASK_OPTIMIZE

MAJOR_MASK bit denoting an event that will be repeated, in order to optimize execution

See Also:: Constant Field Values

MASK_CNTRLMSG

static final int MASK_CNTRLMSG

MAJOR_MASK bit denoting an event that is for system processing, and not observable

See Also:: Constant Field Values

MASK_INTERMSG

static final int MASK_INTERMSG

MAJOR_MASK bit denoting an event that is for system processing, and not observable

See Also:: Constant Field Values

TYP_AREAAFFECT

static final int TYP_AREAAFFECT

MINOR_MASK minor action code type, denoting a general area event

See Also:: Constant Field Values

TYP_PUSH

static final int TYP_PUSH

MINOR_MASK minor action code type, denoting a push action

See Also:: Constant Field Values

TYP_PULL

static final int TYP_PULL

MINOR_MASK minor action code type, denoting a pull action

See Also:: Constant Field Values

TYP_RECALL

static final int TYP_RECALL

MINOR_MASK minor action code type, denoting a recall action

See Also:: Constant Field Values

TYP_OPEN

static final int TYP_OPEN

MINOR_MASK minor action code type, denoting a open action

See Also:: Constant Field Values

TYP_CLOSE

static final int TYP_CLOSE

MINOR_MASK minor action code type, denoting a close action

See Also:: Constant Field Values

TYP_PUT

static final int TYP_PUT

MINOR_MASK minor action code type, denoting a put action

See Also:: Constant Field Values

TYP_GET

static final int TYP_GET

MINOR_MASK minor action code type, denoting a get action

See Also:: Constant Field Values

TYP_UNLOCK

static final int TYP_UNLOCK

MINOR_MASK minor action code type, denoting a unlock action

See Also:: Constant Field Values

TYP_LOCK

static final int TYP_LOCK

MINOR_MASK minor action code type, denoting a lock action

See Also:: Constant Field Values

TYP_WIELD

static final int TYP_WIELD

MINOR_MASK minor action code type, denoting a wield action

See Also:: Constant Field Values

TYP_GIVE

static final int TYP_GIVE

MINOR_MASK minor action code type, denoting a give action

See Also:: Constant Field Values

TYP_BUY

static final int TYP_BUY

MINOR_MASK minor action code type, denoting a buy action

See Also:: Constant Field Values

TYP_SELL

static final int TYP_SELL

MINOR_MASK minor action code type, denoting a sell action

See Also:: Constant Field Values

TYP_DROP

static final int TYP_DROP

MINOR_MASK minor action code type, denoting a drop action

See Also:: Constant Field Values

TYP_WEAR

static final int TYP_WEAR

MINOR_MASK minor action code type, denoting a wear action

See Also:: Constant Field Values

TYP_FILL

static final int TYP_FILL

MINOR_MASK minor action code type, denoting a fill action

See Also:: Constant Field Values

TYP_DELICATE_HANDS_ACT

static final int TYP_DELICATE_HANDS_ACT

MINOR_MASK minor action code type, denoting a delicate, thiefly action

See Also:: Constant Field Values

TYP_VALUE

static final int TYP_VALUE

MINOR_MASK minor action code type, denoting a shopkeeper value action

See Also:: Constant Field Values

TYP_HOLD

static final int TYP_HOLD

MINOR_MASK minor action code type, denoting a hold action

See Also:: Constant Field Values

TYP_NOISYMOVEMENT

static final int TYP_NOISYMOVEMENT

MINOR_MASK minor action code type, denoting a noisy, large movement action

See Also:: Constant Field Values

TYP_QUIETMOVEMENT

static final int TYP_QUIETMOVEMENT

MINOR_MASK minor action code type, denoting a quiet, large movement action

See Also:: Constant Field Values

TYP_WEAPONATTACK

static final int TYP_WEAPONATTACK

MINOR_MASK minor action code type, denoting a physical attack

See Also:: Constant Field Values

TYP_LOOK

static final int TYP_LOOK

MINOR_MASK minor action code type, denoting a look action

See Also:: Constant Field Values

TYP_READ

static final int TYP_READ

MINOR_MASK minor action code type, denoting a read action

See Also:: Constant Field Values

TYP_NOISE

static final int TYP_NOISE

MINOR_MASK minor action code type, denoting a noisy, non-movement action

See Also:: Constant Field Values

TYP_SPEAK

static final int TYP_SPEAK

MINOR_MASK minor action code type, denoting a speaking action

See Also:: Constant Field Values

TYP_CAST_SPELL

static final int TYP_CAST_SPELL

MINOR_MASK minor action code type, denoting a spell casting action

See Also:: Constant Field Values

TYP_LIST

static final int TYP_LIST

MINOR_MASK minor action code type, denoting a shopkeeper list action

See Also:: Constant Field Values

TYP_EAT

static final int TYP_EAT

MINOR_MASK minor action code type, denoting a eat action

See Also:: Constant Field Values

TYP_ENTER

static final int TYP_ENTER

MINOR_MASK minor action code type, denoting a entering action

See Also:: Constant Field Values

TYP_FOLLOW

static final int TYP_FOLLOW

MINOR_MASK minor action code type, denoting a following action

See Also:: Constant Field Values

TYP_LEAVE

static final int TYP_LEAVE

MINOR_MASK minor action code type, denoting a leaving action

See Also:: Constant Field Values

TYP_SLEEP

static final int TYP_SLEEP

MINOR_MASK minor action code type, denoting a sleeping action

See Also:: Constant Field Values

TYP_SIT

static final int TYP_SIT

MINOR_MASK minor action code type, denoting a sitting action

See Also:: Constant Field Values

TYP_STAND

static final int TYP_STAND

MINOR_MASK minor action code type, denoting a standing action

See Also:: Constant Field Values

TYP_FLEE

static final int TYP_FLEE

MINOR_MASK minor action code type, denoting a fleeing action

See Also:: Constant Field Values

TYP_NOFOLLOW

static final int TYP_NOFOLLOW

MINOR_MASK minor action code type, denoting a nofollow action

See Also:: Constant Field Values

TYP_WRITE

static final int TYP_WRITE

MINOR_MASK minor action code type, denoting a writing action

See Also:: Constant Field Values

TYP_FIRE

static final int TYP_FIRE

MINOR_MASK minor action code type, denoting a flaming action

See Also:: Constant Field Values

TYP_COLD

static final int TYP_COLD

MINOR_MASK minor action code type, denoting a freezing action

See Also:: Constant Field Values

TYP_WATER

static final int TYP_WATER

MINOR_MASK minor action code type, denoting a wet action

See Also:: Constant Field Values

TYP_GAS

static final int TYP_GAS

MINOR_MASK minor action code type, denoting a gassing action

See Also:: Constant Field Values

TYP_MIND

static final int TYP_MIND

MINOR_MASK minor action code type, denoting a mind-affecting action

See Also:: Constant Field Values

TYP_GENERAL

static final int TYP_GENERAL

MINOR_MASK minor action code type, denoting a general unknown action

See Also:: Constant Field Values

TYP_JUSTICE

static final int TYP_JUSTICE

MINOR_MASK minor action code type, denoting an embarrasing action

See Also:: Constant Field Values

TYP_ACID

static final int TYP_ACID

MINOR_MASK minor action code type, denoting a melting action

See Also:: Constant Field Values

TYP_ELECTRIC

static final int TYP_ELECTRIC

MINOR_MASK minor action code type, denoting a shocking action

See Also:: Constant Field Values

TYP_POISON

static final int TYP_POISON

MINOR_MASK minor action code type, denoting a poisoning action

See Also:: Constant Field Values

TYP_UNDEAD

static final int TYP_UNDEAD

MINOR_MASK minor action code type, denoting a cold evil undead action

See Also:: Constant Field Values

TYP_MOUNT

static final int TYP_MOUNT

MINOR_MASK minor action code type, denoting a mount action

See Also:: Constant Field Values

TYP_DISMOUNT

static final int TYP_DISMOUNT

MINOR_MASK minor action code type, denoting a dismount action

See Also:: Constant Field Values

TYP_OK_ACTION

static final int TYP_OK_ACTION

MINOR_MASK minor action code type, denoting a general noisy movement action

See Also:: Constant Field Values

TYP_OK_VISUAL

static final int TYP_OK_VISUAL

MINOR_MASK minor action code type, denoting a general non-noisy movement action

See Also:: Constant Field Values

TYP_DRINK

static final int TYP_DRINK

MINOR_MASK minor action code type, denoting a drink action

See Also:: Constant Field Values

TYP_HANDS

static final int TYP_HANDS

MINOR_MASK minor action code type, denoting a small hands, non-movement action

See Also:: Constant Field Values

TYP_PARALYZE

static final int TYP_PARALYZE

MINOR_MASK minor action code type, denoting a paralyzing action

See Also:: Constant Field Values

TYP_WAND_USE

static final int TYP_WAND_USE

MINOR_MASK minor action code type, denoting a wand activation action

See Also:: Constant Field Values

TYP_SERVE

static final int TYP_SERVE

MINOR_MASK minor action code type, denoting a serve action

See Also:: Constant Field Values

TYP_REBUKE

static final int TYP_REBUKE

MINOR_MASK minor action code type, denoting a rebuke action

See Also:: Constant Field Values

TYP_ADVANCE

static final int TYP_ADVANCE

MINOR_MASK minor action code type, denoting an advance on target action

See Also:: Constant Field Values

TYP_DISEASE

static final int TYP_DISEASE

MINOR_MASK minor action code type, denoting a disease spreading action

See Also:: Constant Field Values

TYP_DEATH

static final int TYP_DEATH

MINOR_MASK minor action code type, denoting a dying action

See Also:: Constant Field Values

TYP_DEPOSIT

static final int TYP_DEPOSIT

MINOR_MASK minor action code type, denoting a shopkeeper deposit action

See Also:: Constant Field Values

TYP_WITHDRAW

static final int TYP_WITHDRAW

MINOR_MASK minor action code type, denoting a shopkeeper withdraw action

See Also:: Constant Field Values

TYP_EMOTE

static final int TYP_EMOTE

MINOR_MASK minor action code type, denoting an emote action

See Also:: Constant Field Values

TYP_QUIT

static final int TYP_QUIT

MINOR_MASK minor action code type, denoting a game quitting action

See Also:: Constant Field Values

TYP_SHUTDOWN

static final int TYP_SHUTDOWN

MINOR_MASK minor action code type, denoting a game shutdown action

See Also:: Constant Field Values

TYP_VIEW

static final int TYP_VIEW

MINOR_MASK minor action code type, denoting a shopkeeper view action

See Also:: Constant Field Values

TYP_RETIRE

static final int TYP_RETIRE

MINOR_MASK minor action code type, denoting a player retire action

See Also:: Constant Field Values

TYP_RETREAT

static final int TYP_RETREAT

MINOR_MASK minor action code type, denoting a target retreat from action

See Also:: Constant Field Values

TYP_PANIC

static final int TYP_PANIC

MINOR_MASK minor action code type, denoting a panic/near death action

See Also:: Constant Field Values

TYP_THROW

static final int TYP_THROW

MINOR_MASK minor action code type, denoting a throw action

See Also:: Constant Field Values

TYP_EXTINGUISH

static final int TYP_EXTINGUISH

MINOR_MASK minor action code type, denoting a extinguishing action

See Also:: Constant Field Values

TYP_TELL

static final int TYP_TELL

MINOR_MASK minor action code type, denoting a tell action

See Also:: Constant Field Values

TYP_SITMOVE

static final int TYP_SITMOVE

MINOR_MASK minor action code type, denoting a crawling/sit enter action

See Also:: Constant Field Values

TYP_KNOCK

static final int TYP_KNOCK

MINOR_MASK minor action code type, denoting a knock action

See Also:: Constant Field Values

TYP_PRACTICE

static final int TYP_PRACTICE

MINOR_MASK minor action code type, denoting a practice action

See Also:: Constant Field Values

TYP_TEACH

static final int TYP_TEACH

MINOR_MASK minor action code type, denoting a teach action

See Also:: Constant Field Values

TYP_REMOVE

static final int TYP_REMOVE

MINOR_MASK minor action code type, denoting a remove action

See Also:: Constant Field Values

TYP_EXPCHANGE

static final int TYP_EXPCHANGE

MINOR_MASK minor action code type, denoting a xp gain/loss action

See Also:: Constant Field Values

TYP_DAMAGE

static final int TYP_DAMAGE

MINOR_MASK minor action code type, denoting a general damaging action

See Also:: Constant Field Values

TYP_HEALING

static final int TYP_HEALING

MINOR_MASK minor action code type, denoting a healing action

See Also:: Constant Field Values

TYP_ROOMRESET

static final int TYP_ROOMRESET

MINOR_MASK minor action code type, denoting a room resetting action

See Also:: Constant Field Values

TYP_RELOAD

static final int TYP_RELOAD

MINOR_MASK minor action code type, denoting a missile weapon reload action

See Also:: Constant Field Values

TYP_SNIFF

static final int TYP_SNIFF

MINOR_MASK minor action code type, denoting a sniff action

See Also:: Constant Field Values

TYP_ACTIVATE

static final int TYP_ACTIVATE

MINOR_MASK minor action code type, denoting an activate action

See Also:: Constant Field Values

TYP_DEACTIVATE

static final int TYP_DEACTIVATE

MINOR_MASK minor action code type, denoting a deactivate action

See Also:: Constant Field Values

TYP_FACTIONCHANGE

static final int TYP_FACTIONCHANGE

MINOR_MASK minor action code type, denoting a gain or loss of faction

See Also:: Constant Field Values

TYP_LOGIN

static final int TYP_LOGIN

MINOR_MASK minor action code type, denoting a login action

See Also:: Constant Field Values

TYP_LEVEL

static final int TYP_LEVEL

MINOR_MASK minor action code type, denoting a level gain action

See Also:: Constant Field Values

TYP_EXAMINE

static final int TYP_EXAMINE

MINOR_MASK minor action code type, denoting a close look/examine action

See Also:: Constant Field Values

TYP_ORDER

static final int TYP_ORDER

MINOR_MASK minor action code type, denoting a order target action

See Also:: Constant Field Values

TYP_EXPIRE

static final int TYP_EXPIRE

MINOR_MASK minor action code type, denoting an item/room expiration action

See Also:: Constant Field Values

TYP_BORROW

static final int TYP_BORROW

MINOR_MASK minor action code type, denoting a banker borrow action

See Also:: Constant Field Values

TYP_HUH

static final int TYP_HUH

MINOR_MASK minor action code type, denoting an unknown command action

See Also:: Constant Field Values

TYP_LIFE

static final int TYP_LIFE

MINOR_MASK minor action code type, denoting a bring-to-life action

See Also:: Constant Field Values

TYP_BID

static final int TYP_BID

MINOR_MASK minor action code type, denoting a auctioneer bid action

See Also:: Constant Field Values

TYP_CLANEVENT

static final int TYP_CLANEVENT

MINOR_MASK minor action code type, denoting a clan event

See Also:: Constant Field Values

TYP_UNLOAD

static final int TYP_UNLOAD

MINOR_MASK minor action code type, denoting a missile weapon unload action

See Also:: Constant Field Values

TYP_DUELCHALLENGE

static final int TYP_DUELCHALLENGE

MINOR_MASK minor action code type, denoting a challenge to the duel

See Also:: Constant Field Values

TYP_LEGALWARRANT

static final int TYP_LEGALWARRANT

MINOR_MASK minor action code type, denoting a legal matter

See Also:: Constant Field Values

TYP_DIG

static final int TYP_DIG

MINOR_MASK minor action code type, denoting the digging a hole action

See Also:: Constant Field Values

TYP_PREINVOKE

static final int TYP_PREINVOKE

MINOR_MASK minor action code type, denoting a skill possibly invoked

See Also:: Constant Field Values

TYP_POSSESS

static final int TYP_POSSESS

MINOR_MASK minor action code type, denoting possession of one body by another

See Also:: Constant Field Values

TYP_DISPOSSESS

static final int TYP_DISPOSSESS

MINOR_MASK minor action code type, denoting dispossession of a possessed body

See Also:: Constant Field Values

TYP_POWERCURRENT

static final int TYP_POWERCURRENT

MINOR_MASK minor action code type, denoting power current flowing

See Also:: Constant Field Values

TYP_CONTEMPLATE

static final int TYP_CONTEMPLATE

MINOR_MASK minor action code type, denoting power current flowing

See Also:: Constant Field Values

TYP_POUR

static final int TYP_POUR

MINOR_MASK minor action code type, denoting power current flowing

See Also:: Constant Field Values

TYP_LOOK_EXITS

static final int TYP_LOOK_EXITS

MINOR_MASK minor action code type, denoting a specific glance at the exits

See Also:: Constant Field Values

TYP_LASER

static final int TYP_LASER

MINOR_MASK minor action code type, denoting a laser action

See Also:: Constant Field Values

TYP_SONIC

static final int TYP_SONIC

MINOR_MASK minor action code type, denoting a sonic action

See Also:: Constant Field Values

TYP_REPAIR

static final int TYP_REPAIR

MINOR_MASK minor action code type, denoting a tech repair

See Also:: Constant Field Values

TYP_ENHANCE

static final int TYP_ENHANCE

MINOR_MASK minor action code type, denoting a tech enhance

See Also:: Constant Field Values

TYP_INSTALL

static final int TYP_INSTALL

MINOR_MASK minor action code type, denoting a tech install

See Also:: Constant Field Values

TYP_COLLISION

static final int TYP_COLLISION

MINOR_MASK minor action code type, denoting a collision

See Also:: Constant Field Values

TYP_AROMA

static final int TYP_AROMA

MINOR_MASK minor action code type, denoting a general unknown action

See Also:: Constant Field Values

TYP_DUELLOSS

static final int TYP_DUELLOSS

MINOR_MASK minor action code type, denoting a loss in a duel

See Also:: Constant Field Values

TYP_COMMANDFAIL

static final int TYP_COMMANDFAIL

MINOR_MASK minor action code type, denoting a command that was mistargeted

See Also:: Constant Field Values

TYP_COMMAND

static final int TYP_COMMAND

MINOR_MASK minor action code type, denoting a meta-message command

See Also:: Constant Field Values

TYP_ITEMGENERATED

static final int TYP_ITEMGENERATED

MINOR_MASK minor action code type, denoting a completed item generation activty

See Also:: Constant Field Values

TYP_ATTACKMISS

static final int TYP_ATTACKMISS

MINOR_MASK minor action code type, denoting a standard combat miss

See Also:: Constant Field Values

TYP_WEATHER

static final int TYP_WEATHER

MINOR_MASK minor action code type, denoting a standard weather affect

See Also:: Constant Field Values

TYP_ITEMSGENERATED

static final int TYP_ITEMSGENERATED

MINOR_MASK minor action code type, denoting a completed item generation activty

See Also:: Constant Field Values

TYP_WROTE

static final int TYP_WROTE

MINOR_MASK minor action code type, denoting a write activity

See Also:: Constant Field Values

TYP_REWRITE

static final int TYP_REWRITE

MINOR_MASK minor action code type, denoting a rewrite activty

See Also:: Constant Field Values

TYP_WASREAD

static final int TYP_WASREAD

MINOR_MASK minor action code type, denoting a finally read message

See Also:: Constant Field Values

TYP_TRAVEL

static final int TYP_TRAVEL

MINOR_MASK minor action code type, denoting an intention to move

See Also:: Constant Field Values

TYP_THINK

static final int TYP_THINK

MINOR_MASK minor action code type, denoting thinking

See Also:: Constant Field Values

TYP_STARTUP

static final int TYP_STARTUP

MINOR_MASK minor action code type, denoting a room coming to life

See Also:: Constant Field Values

TYP_RPXPCHANGE

static final int TYP_RPXPCHANGE

MINOR_MASK minor action code type, denoting a rp xp gain/loss action

See Also:: Constant Field Values

TYP_COMMANDREJECT

static final int TYP_COMMANDREJECT

MINOR_MASK minor action code type, denoting a command's msg was rejected

See Also:: Constant Field Values

TYP_RECIPELEARNED

static final int TYP_RECIPELEARNED

MINOR_MASK minor action code type, denoting a completed item recipe learn activty

See Also:: Constant Field Values

TYP_GRAVITY

static final int TYP_GRAVITY

MINOR_MASK minor action code type, denoting a gravitic move

See Also:: Constant Field Values

TYP_LEGALSTATE

static final int TYP_LEGALSTATE

MINOR_MASK minor action code type, denoting a legal state change

See Also:: Constant Field Values

TYP_CHANNEL

static final int TYP_CHANNEL

MINOR_MASK minor action code type, denoting a channel action -- 2000-2047 are channels

See Also:: Constant Field Values

MISC_DESCS

static final java.lang.Object[][] MISC_DESCS

Addendum to TYPE_DESCS for codes above the last index (channels only at this point)

TYPE_DESCS

static final java.lang.String[] TYPE_DESCS

Index string descriptions of all the MINOR_MASK action code TYP_s

MASK_DESCS

static final java.lang.String[] MASK_DESCS

Index string descriptions of all the MAJOR_MASK code MAKS_s

MSK_CAST_VERBAL

static final int MSK_CAST_VERBAL

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting verbal magic

See Also:: Constant Field Values

MSK_CAST_MALICIOUS_VERBAL

static final int MSK_CAST_MALICIOUS_VERBAL

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting verbal malicious magic

See Also:: Constant Field Values

MSK_CAST_SOMANTIC

static final int MSK_CAST_SOMANTIC

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting somantic magic

See Also:: Constant Field Values

MSK_CAST_MALICIOUS_SOMANTIC

static final int MSK_CAST_MALICIOUS_SOMANTIC

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting somantic malicious magic

See Also:: Constant Field Values

MSK_HAGGLE

static final int MSK_HAGGLE

Useful MAJOR_MASK shortcut combining other MASK_ constants related to haggling over price

See Also:: Constant Field Values

MSK_CAST

static final int MSK_CAST

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting both verbal and somantic

See Also:: Constant Field Values

MSK_CAST_MALICIOUS

static final int MSK_CAST_MALICIOUS

Useful MAJOR_MASK shortcut combining other MASK_ constants related to casting both verbal and somantic maliciously

See Also:: Constant Field Values

MSK_MALICIOUS_MOVE

static final int MSK_MALICIOUS_MOVE

Useful MAJOR_MASK shortcut combining other MASK_ constants related to malicious noisy movements

See Also:: Constant Field Values

NO_EFFECT

static final int NO_EFFECT

combined MAJOR and MINOR codes for useful event message type that does absolutely nothing

See Also:: Constant Field Values

MSG_AREAAFFECT

static final int MSG_AREAAFFECT

combined MAJOR and MINOR codes for useful event message type for general area effects

See Also:: Constant Field Values

MSG_PUSH

static final int MSG_PUSH

combined MAJOR and MINOR codes for useful event message type for a push event

See Also:: Constant Field Values

MSG_PULL

static final int MSG_PULL

combined MAJOR and MINOR codes for useful event message type for a pull event

See Also:: Constant Field Values

MSG_RECALL

static final int MSG_RECALL

combined MAJOR and MINOR codes for useful event message type for a recall event

See Also:: Constant Field Values

MSG_OPEN

static final int MSG_OPEN

combined MAJOR and MINOR codes for useful event message type for a open event

See Also:: Constant Field Values

MSG_CLOSE

static final int MSG_CLOSE

combined MAJOR and MINOR codes for useful event message type for a close event

See Also:: Constant Field Values

MSG_PUT

static final int MSG_PUT

combined MAJOR and MINOR codes for useful event message type for a put event

See Also:: Constant Field Values

MSG_GET

static final int MSG_GET

combined MAJOR and MINOR codes for useful event message type for a get event

See Also:: Constant Field Values

MSG_UNLOCK

static final int MSG_UNLOCK

combined MAJOR and MINOR codes for useful event message type for a unlock event

See Also:: Constant Field Values

MSG_LOCK

static final int MSG_LOCK

combined MAJOR and MINOR codes for useful event message type for a lock event

See Also:: Constant Field Values

MSG_WIELD

static final int MSG_WIELD

combined MAJOR and MINOR codes for useful event message type for a wield event

See Also:: Constant Field Values

MSG_GIVE

static final int MSG_GIVE

combined MAJOR and MINOR codes for useful event message type for a give event

See Also:: Constant Field Values

MSG_BUY

static final int MSG_BUY

combined MAJOR and MINOR codes for useful event message type for a buy event

See Also:: Constant Field Values

MSG_SELL

static final int MSG_SELL

combined MAJOR and MINOR codes for useful event message type for a sell event

See Also:: Constant Field Values

MSG_DROP

static final int MSG_DROP

combined MAJOR and MINOR codes for useful event message type for a drop event

See Also:: Constant Field Values

MSG_WEAR

static final int MSG_WEAR

combined MAJOR and MINOR codes for useful event message type for a wear event

See Also:: Constant Field Values

MSG_FILL

static final int MSG_FILL

combined MAJOR and MINOR codes for useful event message type for a fill event

See Also:: Constant Field Values

MSG_DELICATE_SMALL_HANDS_ACT

static final int MSG_DELICATE_SMALL_HANDS_ACT

combined MAJOR and MINOR codes for useful event message type for a thiefly delicate quiet event

See Also:: Constant Field Values

MSG_DELICATE_HANDS_ACT

static final int MSG_DELICATE_HANDS_ACT

combined MAJOR and MINOR codes for useful event message type for a thiefly large quiet event

See Also:: Constant Field Values

MSG_THIEF_ACT

static final int MSG_THIEF_ACT

combined MAJOR and MINOR codes for useful event message type for a general thiefly embarrassing event

See Also:: Constant Field Values

MSG_VALUE

static final int MSG_VALUE

combined MAJOR and MINOR codes for useful event message type for a shopkeeper value event

See Also:: Constant Field Values

MSG_HOLD

static final int MSG_HOLD

combined MAJOR and MINOR codes for useful event message type for a hold event

See Also:: Constant Field Values

MSG_NOISYMOVEMENT

static final int MSG_NOISYMOVEMENT

combined MAJOR and MINOR codes for useful event message type for a large noisy movement event

See Also:: Constant Field Values

MSG_QUIETMOVEMENT

static final int MSG_QUIETMOVEMENT

combined MAJOR and MINOR codes for useful event message type for a large quiet movement event

See Also:: Constant Field Values

MSG_RELOAD

static final int MSG_RELOAD

combined MAJOR and MINOR codes for useful event message type for a missile weapon reload event

See Also:: Constant Field Values

MSG_WEAPONATTACK

static final int MSG_WEAPONATTACK

combined MAJOR and MINOR codes for useful event message type for a physical attack event

See Also:: Constant Field Values

MSG_LOOK

static final int MSG_LOOK

combined MAJOR and MINOR codes for useful event message type for a look event

See Also:: Constant Field Values

MSG_READ

static final int MSG_READ

combined MAJOR and MINOR codes for useful event message type for a read event

See Also:: Constant Field Values

MSG_NOISE

static final int MSG_NOISE

combined MAJOR and MINOR codes for useful event message type for a noisy event

See Also:: Constant Field Values

MSG_SPEAK

static final int MSG_SPEAK

combined MAJOR and MINOR codes for useful event message type for a speak event

See Also:: Constant Field Values

MSG_CAST_VERBAL_SPELL

static final int MSG_CAST_VERBAL_SPELL

combined MAJOR and MINOR codes for useful event message type for a verbal spellcasting event

See Also:: Constant Field Values

MSG_LIST

static final int MSG_LIST

combined MAJOR and MINOR codes for useful event message type for a shopkeeper list event

See Also:: Constant Field Values

MSG_EAT

static final int MSG_EAT

combined MAJOR and MINOR codes for useful event message type for a eat event

See Also:: Constant Field Values

MSG_ENTER

static final int MSG_ENTER

combined MAJOR and MINOR codes for useful event message type for a enter event

See Also:: Constant Field Values

MSG_CAST_ATTACK_VERBAL_SPELL

static final int MSG_CAST_ATTACK_VERBAL_SPELL

combined MAJOR and MINOR codes for useful event message type for a malicious verbal spellcasting event

See Also:: Constant Field Values

MSG_LEAVE

static final int MSG_LEAVE

combined MAJOR and MINOR codes for useful event message type for a leave event

See Also:: Constant Field Values

MSG_SLEEP

static final int MSG_SLEEP

combined MAJOR and MINOR codes for useful event message type for a sleep event

See Also:: Constant Field Values

MSG_SIT

static final int MSG_SIT

combined MAJOR and MINOR codes for useful event message type for a sit event

See Also:: Constant Field Values

MSG_STAND

static final int MSG_STAND

combined MAJOR and MINOR codes for useful event message type for a stand event

See Also:: Constant Field Values

MSG_FLEE

static final int MSG_FLEE

combined MAJOR and MINOR codes for useful event message type for a flee event

See Also:: Constant Field Values

MSG_CAST_SOMANTIC_SPELL

static final int MSG_CAST_SOMANTIC_SPELL

combined MAJOR and MINOR codes for useful event message type for a somantic spellcasting event

See Also:: Constant Field Values

MSG_CAST_ATTACK_SOMANTIC_SPELL

static final int MSG_CAST_ATTACK_SOMANTIC_SPELL

combined MAJOR and MINOR codes for useful event message type for a malicious somantic spellcasting event

See Also:: Constant Field Values

MSG_CAST

static final int MSG_CAST

combined MAJOR and MINOR codes for useful event message type for a spellcasting event

See Also:: Constant Field Values

MSG_CAST_MALICIOUS

static final int MSG_CAST_MALICIOUS

combined MAJOR and MINOR codes for useful event message type for a malicious spellcasting event

See Also:: Constant Field Values

MSG_OK_ACTION

static final int MSG_OK_ACTION

combined MAJOR and MINOR codes for useful event message type for a always confirmed noisy event

See Also:: Constant Field Values

MSG_OK_VISUAL

static final int MSG_OK_VISUAL

combined MAJOR and MINOR codes for useful event message type for a always confirmed quiet event

See Also:: Constant Field Values

MSG_DRINK

static final int MSG_DRINK

combined MAJOR and MINOR codes for useful event message type for a drink event

See Also:: Constant Field Values

MSG_HANDS

static final int MSG_HANDS

combined MAJOR and MINOR codes for useful event message type for a general hands event

See Also:: Constant Field Values

MSG_EMOTE

static final int MSG_EMOTE

combined MAJOR and MINOR codes for useful event message type for a emoting event

See Also:: Constant Field Values

MSG_FOLLOW

static final int MSG_FOLLOW

combined MAJOR and MINOR codes for useful event message type for a follow event

See Also:: Constant Field Values

MSG_NOFOLLOW

static final int MSG_NOFOLLOW

combined MAJOR and MINOR codes for useful event message type for a nofollow event

See Also:: Constant Field Values

MSG_WRITE

static final int MSG_WRITE

combined MAJOR and MINOR codes for useful event message type for a write event

See Also:: Constant Field Values

MSG_MOUNT

static final int MSG_MOUNT

combined MAJOR and MINOR codes for useful event message type for a mount event

See Also:: Constant Field Values

MSG_DISMOUNT

static final int MSG_DISMOUNT

combined MAJOR and MINOR codes for useful event message type for a dismount event

See Also:: Constant Field Values

MSG_SERVE

static final int MSG_SERVE

combined MAJOR and MINOR codes for useful event message type for a serve event

See Also:: Constant Field Values

MSG_REBUKE

static final int MSG_REBUKE

combined MAJOR and MINOR codes for useful event message type for a rebuke event

See Also:: Constant Field Values

MSG_ADVANCE

static final int MSG_ADVANCE

combined MAJOR and MINOR codes for useful event message type for a combat advance event

See Also:: Constant Field Values

MSG_DEATH

static final int MSG_DEATH

combined MAJOR and MINOR codes for useful event message type for a death event

See Also:: Constant Field Values

MSG_WITHDRAW

static final int MSG_WITHDRAW

combined MAJOR and MINOR codes for useful event message type for a bank withdraw event

See Also:: Constant Field Values

MSG_DEPOSIT

static final int MSG_DEPOSIT

combined MAJOR and MINOR codes for useful event message type for a bank deposit event

See Also:: Constant Field Values

MSG_QUIT

static final int MSG_QUIT

combined MAJOR and MINOR codes for useful event message type for a game quit event

See Also:: Constant Field Values

MSG_SHUTDOWN

static final int MSG_SHUTDOWN

combined MAJOR and MINOR codes for useful event message type for a game shutdown event

See Also:: Constant Field Values

MSG_VIEW

static final int MSG_VIEW

combined MAJOR and MINOR codes for useful event message type for a shop view event

See Also:: Constant Field Values

MSG_RETIRE

static final int MSG_RETIRE

combined MAJOR and MINOR codes for useful event message type for a retire event

See Also:: Constant Field Values

MSG_RETREAT

static final int MSG_RETREAT

combined MAJOR and MINOR codes for useful event message type for a combat retreat event

See Also:: Constant Field Values

MSG_PANIC

static final int MSG_PANIC

combined MAJOR and MINOR codes for useful event message type for a panic event

See Also:: Constant Field Values

MSG_THROW

static final int MSG_THROW

combined MAJOR and MINOR codes for useful event message type for a throw event

See Also:: Constant Field Values

MSG_EXTINGUISH

static final int MSG_EXTINGUISH

combined MAJOR and MINOR codes for useful event message type for a extinguish event

See Also:: Constant Field Values

MSG_TELL

static final int MSG_TELL

combined MAJOR and MINOR codes for useful event message type for a tell event

See Also:: Constant Field Values

MSG_SITMOVE

static final int MSG_SITMOVE

combined MAJOR and MINOR codes for useful event message type for a crawl event

See Also:: Constant Field Values

MSG_KNOCK

static final int MSG_KNOCK

combined MAJOR and MINOR codes for useful event message type for a knock event

See Also:: Constant Field Values

MSG_PRACTICE

static final int MSG_PRACTICE

combined MAJOR and MINOR codes for useful event message type for a practice event

See Also:: Constant Field Values

MSG_TEACH

static final int MSG_TEACH

combined MAJOR and MINOR codes for useful event message type for a teach event

See Also:: Constant Field Values

MSG_REMOVE

static final int MSG_REMOVE

combined MAJOR and MINOR codes for useful event message type for a remove event

See Also:: Constant Field Values

MSG_DAMAGE

static final int MSG_DAMAGE

combined MAJOR and MINOR codes for useful event message type for a damage event

See Also:: Constant Field Values

MSG_HEALING

static final int MSG_HEALING

combined MAJOR and MINOR codes for useful event message type for a healing event

See Also:: Constant Field Values

MSG_ROOMRESET

static final int MSG_ROOMRESET

combined MAJOR and MINOR codes for useful event message type for a room reset event

See Also:: Constant Field Values

MSG_SNIFF

static final int MSG_SNIFF

combined MAJOR and MINOR codes for useful event message type for a sniff event

See Also:: Constant Field Values

MSG_ACTIVATE

static final int MSG_ACTIVATE

combined MAJOR and MINOR codes for useful event message type for a activate event

See Also:: Constant Field Values

MSG_DEACTIVATE

static final int MSG_DEACTIVATE

combined MAJOR and MINOR codes for useful event message type for a deactivate event

See Also:: Constant Field Values

MSG_LOGIN

static final int MSG_LOGIN

combined MAJOR and MINOR codes for useful event message type for a login event

See Also:: Constant Field Values

MSG_LEVEL

static final int MSG_LEVEL

combined MAJOR and MINOR codes for useful event message type for a level event

See Also:: Constant Field Values

MSG_EXAMINE

static final int MSG_EXAMINE

combined MAJOR and MINOR codes for useful event message type for a examine event

See Also:: Constant Field Values

MSG_ORDER

static final int MSG_ORDER

combined MAJOR and MINOR codes for useful event message type for a target order event

See Also:: Constant Field Values

MSG_EXPIRE

static final int MSG_EXPIRE

combined MAJOR and MINOR codes for useful event message type for a item expire event

See Also:: Constant Field Values

MSG_BORROW

static final int MSG_BORROW

combined MAJOR and MINOR codes for useful event message type for a banker borrow event

See Also:: Constant Field Values

MSG_EAT_GROUND

static final int MSG_EAT_GROUND

combined MAJOR and MINOR codes for useful event message type for a eat event

See Also:: Constant Field Values

MSG_HUH

static final int MSG_HUH

combined MAJOR and MINOR codes for useful event message type for an unknown command event

See Also:: Constant Field Values

MSG_BRINGTOLIFE

static final int MSG_BRINGTOLIFE

combined MAJOR and MINOR codes for useful event message type for a bring-to-life event

See Also:: Constant Field Values

MSG_BID

static final int MSG_BID

combined MAJOR and MINOR codes for useful event message type for a auction bid event

See Also:: Constant Field Values

MSG_CLANEVENT

static final int MSG_CLANEVENT

combined MAJOR and MINOR codes for useful event message type for a clan event

See Also:: Constant Field Values

MSG_UNLOAD

static final int MSG_UNLOAD

combined MAJOR and MINOR codes for useful event message type for a missile weapon reload event

See Also:: Constant Field Values

MSG_DUELCHALLENGE

static final int MSG_DUELCHALLENGE

combined MAJOR and MINOR codes for useful event message type for a duel challenge

See Also:: Constant Field Values

MSG_LEGALWARRANT

static final int MSG_LEGALWARRANT

combined MAJOR and MINOR codes for useful event message type for a duel challenge

See Also:: Constant Field Values

MSG_DIG

static final int MSG_DIG

combined MAJOR and MINOR codes for useful event message type for a physical digging action

See Also:: Constant Field Values

MSG_PREINVOKE

static final int MSG_PREINVOKE

combined MAJOR and MINOR codes for useful event message type for a possibly invoked skill

See Also:: Constant Field Values

MSG_POSSESS

static final int MSG_POSSESS

combined MAJOR and MINOR codes for useful event message type for a possession

See Also:: Constant Field Values

MSG_DISPOSSESS

static final int MSG_DISPOSSESS

combined MAJOR and MINOR codes for useful event message type for a un-possession

See Also:: Constant Field Values

MSG_POWERCURRENT

static final int MSG_POWERCURRENT

combined MAJOR and MINOR codes for useful event message type for power current flow

See Also:: Constant Field Values

MSG_CONTEMPLATE

static final int MSG_CONTEMPLATE

combined MAJOR and MINOR codes for useful event message type for power current flow

See Also:: Constant Field Values

MSG_POUR

static final int MSG_POUR

combined MAJOR and MINOR codes for useful event message type for a pour onto event

See Also:: Constant Field Values

MSG_LOOK_EXITS

static final int MSG_LOOK_EXITS

combined MAJOR and MINOR codes for useful event message type for looking around at exits

See Also:: Constant Field Values

MSG_REPAIR

static final int MSG_REPAIR

combined MAJOR and MINOR codes for useful event message type for a tech repair

See Also:: Constant Field Values

MSG_ENHANCE

static final int MSG_ENHANCE

combined MAJOR and MINOR codes for useful event message type for a tech enhance

See Also:: Constant Field Values

MSG_INSTALL

static final int MSG_INSTALL

combined MAJOR and MINOR codes for useful event message type for a tech install

See Also:: Constant Field Values

MSG_COLLISION

static final int MSG_COLLISION

combined MAJOR and MINOR codes for useful event message type for a collision

See Also:: Constant Field Values

MSG_DUELLOSS

static final int MSG_DUELLOSS

combined MAJOR and MINOR codes for useful event message type for a loss in a duel

See Also:: Constant Field Values

MSG_COMMANDFAIL

static final int MSG_COMMANDFAIL

combined MAJOR and MINOR codes for useful event message type for a fail to target in a command

See Also:: Constant Field Values

MSG_COMMAND

static final int MSG_COMMAND

combined MAJOR and MINOR codes for useful event message type for a fail to target in a command

See Also:: Constant Field Values

MSG_ATTACKMISS

static final int MSG_ATTACKMISS

combined MAJOR and MINOR codes for useful event message type for a failed combat attack

See Also:: Constant Field Values

MSG_WEATHER

static final int MSG_WEATHER

combined MAJOR and MINOR codes for useful event message type for weather effects

See Also:: Constant Field Values

MSG_WROTE

static final int MSG_WROTE

combined MAJOR and MINOR codes for useful event message type for a fail to target in a command

See Also:: Constant Field Values

MSG_REWRITE

static final int MSG_REWRITE

combined MAJOR and MINOR codes for useful event message type for a re-write event

See Also:: Constant Field Values

MSG_WASREAD

static final int MSG_WASREAD

combined MAJOR and MINOR codes for useful event message type for a was read event

See Also:: Constant Field Values

MSG_TRAVEL

static final int MSG_TRAVEL

combined MAJOR and MINOR codes for useful event message type for a enter event

See Also:: Constant Field Values

MSG_THINK

static final int MSG_THINK

combined MAJOR and MINOR codes for useful event message type for a thinking event

See Also:: Constant Field Values

MSG_STARTUP

static final int MSG_STARTUP

combined MAJOR and MINOR codes for useful event message type for a mud startup

See Also:: Constant Field Values

MSG_COMMANDREJECT

static final int MSG_COMMANDREJECT

combined MAJOR and MINOR codes for useful event message type for a command msgs rejection

See Also:: Constant Field Values

MSG_GRAVITY

static final int MSG_GRAVITY

combined MAJOR and MINOR codes for useful event message type for a activate event

See Also:: Constant Field Values

MSG_LEGALSTATE

static final int MSG_LEGALSTATE

combined MAJOR and MINOR codes for useful event message type for a lega state change

See Also:: Constant Field Values

Method Detail

targetMajor

int targetMajor()

Returns high order bitmask for the target code

Returns:: high order bitmask for the target code
See Also:: targetCode(), targetMinor(), MASK_MAGIC

targetMajor

boolean targetMajor(int bitMask)

Returns whether high order bitmask for the target code is set

Parameters:: bitMask - the bitmask to check for
Returns:: true if high order bitmask for the target code is set
See Also:: targetCode(), targetMinor(), MASK_MAGIC

targetMinor

int targetMinor()

Returns low order action type integer for the target code

Returns:: low order action type integer for the target code
See Also:: targetCode(), targetMajor(int), TYP_CAST_SPELL

targetCode

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.

Returns:: the combination bitmask/action type integer for target of event
See Also:: target(), targetMessage(), targetMajor(int), targetMinor(), MASK_MAGIC, TYP_CAST_SPELL, setTargetCode(int)

setTargetCode

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

Parameters:: code - the new full bitmask/action type target event code
Returns:: this
See Also:: target(), targetMessage(), targetCode(), targetMajor(int), targetMinor(), MASK_MAGIC, TYP_CAST_SPELL

targetMessage

java.lang.String targetMessage()

Returns the string seen by the target of the event, and only by the target of the event.

Returns:: a string to show to the target
See Also:: target(), setTargetMessage(String), targetCode()

setTargetMessage

CMMsg setTargetMessage(java.lang.String str)

Sets the string seen by the target of the event, and only by the target of the event.

Parameters:: str - the string to show to the target, or NULL
Returns:: this
See Also:: target(), targetMessage(), targetCode()

isTarget

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

Parameters:: codeOrMask - the target action code or target major mask to check
Returns:: whether there is a match
See Also:: targetCode()

isTarget

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.

Parameters:: codeOrMaskDesc - the target action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, targetCode()

isTargetMajor

boolean isTargetMajor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches a part of the major code of the targetCode.

Parameters:: codeOrMaskDesc - the target action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, targetCode()

isTargetMinor

boolean isTargetMinor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches the minor sourceCode

Parameters:: codeOrMaskDesc - the target action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, targetCode()

isTarget

boolean isTarget(Environmental E)

Returns whether the given Environmental object is, in fact, the target of this message.

Parameters:: E - the Environmental to inspect, may not be null
Returns:: whether the given E is the target of this message
See Also:: target(), Environmental

amITarget

boolean amITarget(Environmental thisOne)

Returns whether the given Environmental object is, in fact, the target of this message.

Parameters:: thisOne - the Environmental to inspect, may not be null
Returns:: whether the given thisOne is the target of this message
See Also:: target(), Environmental

sourceMajor

int sourceMajor()

Returns high order bitmask for the source code

Returns:: high order bitmask for the source code
See Also:: sourceCode(), sourceMinor(), MASK_MAGIC

sourceMajor

boolean sourceMajor(int bitMask)

Returns whether high order bitmask for the source code is set

Parameters:: bitMask - the bitmask to check for
Returns:: true if high order bitmask for the source code is set
See Also:: sourceCode(), sourceMinor(), MASK_MAGIC

sourceMinor

int sourceMinor()

Returns low order action type integer for the target code

Returns:: low order action type integer for the target code
See Also:: targetCode(), targetMajor(int), TYP_CAST_SPELL

sourceCode

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.

Returns:: the combination bitmask/action type integer for source of event
See Also:: source(), sourceMessage(), sourceMajor(int), sourceMinor(), MASK_MAGIC, TYP_CAST_SPELL, setSourceCode(int)

isSource

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

Parameters:: codeOrMask - the source action code or source major mask to check
Returns:: whether there is a match
See Also:: sourceCode()

isSource

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.

Parameters:: codeOrMaskDesc - the source action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, sourceCode()

isSourceMajor

boolean isSourceMajor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches a part of the major code of the sourceCode.

Parameters:: codeOrMaskDesc - the source action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, sourceCode()

isSourceMinor

boolean isSourceMinor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches the minor sourceCode

Parameters:: codeOrMaskDesc - the source action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, sourceCode()

isSource

boolean isSource(Environmental E)

Returns whether the given Environmental object is, in fact, the source of this message.

Parameters:: E - the Environmental to inspect, may not be null
Returns:: whether the given E is the source of this message
See Also:: source(), Environmental

amISource

boolean amISource(MOB thisOne)

Returns whether the given Environmental object is, in fact, the source of this message.

Parameters:: thisOne - the Environmental to inspect, may not be null
Returns:: whether the given thisOne is the source of this message
See Also:: source(), Environmental

setSourceCode

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

Parameters:: code - the new full bitmask/action type source event code
Returns:: this
See Also:: source(), sourceMessage(), sourceCode(), sourceMajor(int), sourceMinor(), MASK_MAGIC, TYP_CAST_SPELL

sourceMessage

java.lang.String sourceMessage()

Returns the string seen by the source of the event, and only by the source of the event.

Returns:: a string to show to the source
See Also:: source(), setSourceMessage(String), sourceCode()

setSourceMessage

CMMsg setSourceMessage(java.lang.String str)

Sets the string seen by the source of the event, and only by the source of the event.

Parameters:: str - the string to show to the source, or NULL
Returns:: this
See Also:: source(), sourceMessage(), sourceCode()

othersMajor

int othersMajor()

Returns high order bitmask for the others code (Others are everyone not source, not target)

Returns:: high order bitmask for the others code
See Also:: othersCode(), othersMinor(), MASK_MAGIC

othersMajor

boolean othersMajor(int bitMask)

Returns whether high order bitmask for the others code is set (Others are everyone not source, not target)

Parameters:: bitMask - the bitmask to check for
Returns:: true if high order bitmask for the others code is set
See Also:: othersCode(), othersMinor(), MASK_MAGIC

othersMinor

int othersMinor()

Returns low order action type integer for the others code (Others are everyone not source, not target)

Returns:: low order action type integer for the others code
See Also:: othersCode(), othersMajor(int), TYP_CAST_SPELL

othersCode

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. (Others are everyone not source, not target)

Returns:: the combination bitmask/action type integer for others of event
See Also:: othersMessage(), othersMajor(int), othersMinor(), MASK_MAGIC, TYP_CAST_SPELL, setOthersCode(int)

isOthers

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

Parameters:: codeOrMask - the others action code or others major mask to check
Returns:: whether there is a match
See Also:: othersCode()

isOthers

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. (Others are everyone not source, not target)

Parameters:: codeOrMaskDesc - the others action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, othersCode()

isOthersMajor

boolean isOthersMajor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches a part of the major code of the othersCode. (Others are everyone not source, not target)

Parameters:: codeOrMaskDesc - the others action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, othersCode()

isOthersMinor

boolean isOthersMinor(java.lang.String codeOrMaskDesc)

Returns whether the given code or mask string matches the minor sourceCode (Others are everyone not source, not target)

Parameters:: codeOrMaskDesc - the others action code string, or mask string
Returns:: whether there is a match
See Also:: TYPE_DESCS, MASK_DESCS, othersCode()

setOthersCode

CMMsg 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. (Others are everyone not source, not target)

Parameters:: code - the new full bitmask/action type others event code
Returns:: this
See Also:: othersMessage(), othersCode(), othersMajor(int), othersMinor(), MASK_MAGIC, TYP_CAST_SPELL

othersMessage

java.lang.String othersMessage()

Returns the string seen by the others of the event, and only by the others of the event. (Others are everyone not source, not target)

Returns:: a string to show to the others
See Also:: setOthersMessage(String), othersCode()

setOthersMessage

CMMsg setOthersMessage(java.lang.String str)

Sets the string seen by the others of the event, and only by the others of the event. (Others are everyone not source, not target)

Parameters:: str - the string to show to the others, or NULL
Returns:: this
See Also:: othersMessage(), othersCode()

isOthers

boolean isOthers(Environmental E)

Returns whether the given Environmental object is neither the source nor the target of this message.

Parameters:: E - the Environmental to inspect, may not be null
Returns:: whether the given E is neither the source nor target of this message
See Also:: Environmental, source(), target()

target

Environmental target()

Returns the target of this event, an Environmental object

Returns:: the target of this event
See Also:: setTarget(Environmental), Environmental

setTarget

CMMsg setTarget(Environmental E)

Sets the target of this event, an Environmental object

Parameters:: E - the new target of this event
Returns:: this
See Also:: target(), Environmental

tool

Environmental tool()

Returns the means, item, portal, or otherwise tool that helps the source affect the event upon the target.

Returns:: the tool of this event
See Also:: Environmental, setTool(Environmental)

setTool

CMMsg setTool(Environmental E)

Sets the means, item, portal, or otherwise tool that helps the source affect the event upon the target.

Parameters:: E - the new tool of this event
Returns:: this
See Also:: Environmental, tool()

source

MOB source()

Returns the source of this event, a MOB object

Returns:: the source of this event
See Also:: setSource(MOB), MOB

setSource

CMMsg setSource(MOB mob)

Sets the source of this event, a MOB object

Parameters:: mob - the new source of this event
Returns:: this
See Also:: source(), MOB

value

int value()

Returns the arbitrary value integer associated with this event. Values tend to be defined in a event-action code specific way, so that it will mean nothing most of the time, and something different for each type of message. For custom messages therefore, it can be used for whatever one pleases, whereas for established codebase message types, you should understand its meaning before doing anything with it.

Returns:: the integer value of this event

setValue

CMMsg setValue(int amount)

Sets an arbitrary integer value associated with this event. Values tend to be defined in a event-action code specific way, so that it will mean nothing most of the time, and something different for each type of message. For custom messages therefore, it can be used for whatever one pleases, whereas for established codebase message types, you should understand its meaning before doing anything with it.

Parameters:: amount - the integer value of this event
Returns:: this

modify

CMMsg modify(MOB source,
             Environmental target,
             int newAllCode,
             java.lang.String allMessage)

Modifies one of more fields in this event.

Parameters:: source - the source of the event; target - the target of the event; newAllCode - the source, target, and others code; allMessage - the source, target, and others message
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

CMMsg modify(MOB source,
             int newAllCode,
             java.lang.String allMessage)

Modifies one of more fields in this event. Sets target and tool to NULL.

Parameters:: source - the new source of this event; newAllCode - the new source, target, and others code of this event; allMessage - the new source, target, and others message of this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

CMMsg modify(int newAllCode,
             java.lang.String allMessage)

Modifies one of more fields in this event. Sets target and tool to NULL.

Parameters:: newAllCode - the new source, target, and others code of this event; allMessage - the new source, target, and others message of this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

CMMsg modify(java.lang.String allMessage)

Modifies one of more fields in this event. Sets target and tool to NULL.

Parameters:: allMessage - the new source, target, and others message of this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

CMMsg modify(MOB source,
             int newAllCode,
             java.lang.String allMessage,
             int newValue)

Modifies one of more fields in this event. Sets target and tool to NULL.

Parameters:: source - the new source of this event; newAllCode - the new source, target, and others code of this event; allMessage - the new source, target, and others message of this event; newValue - the new value for this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage(), value()

modify

CMMsg modify(MOB source,
             Environmental target,
             Environmental tool,
             int newAllCode,
             java.lang.String allMessage)

Modifies one of more fields in this event.

Parameters:: source - the new source of this event; target - the new target of this event; tool - the new tool for this event; newAllCode - the new source, target, and others code of this event; allMessage - the new source, target, and others message of this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

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

Parameters:: source - the new source of this event; target - the new target of this event; tool - the new tool for this event; newAllCode - the new source, target, and others code of this event; sourceMessage - the new source message for this event; targetMessage - the new target message for this event; othersMessage - the new others message for this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

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

Parameters:: source - the new source of this event; target - the new target of this event; tool - the new tool for this event; newSourceCode - the new source code for this event; sourceMessage - the new source message for this event; newTargetCode - the new target code for this event; targetMessage - the new target message for this event; newOthersCode - the new others code for this event; othersMessage - the new others message for this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

CMMsg modify(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.

Parameters:: newSourceCode - the new source code for this event; sourceMessage - the new source message for this event; newTargetCode - the new target code for this event; targetMessage - the new target message for this event; newOthersCode - the new others code for this event; othersMessage - the new others message for this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

modify

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

Parameters:: source - the new source of this event; target - the new target of this event; tool - the new tool for this event; newSourceCode - the new source code for this event; newTargetCode - the new target code for this event; newOthersCode - the new others code for this event; allMessage - the new source, target, and others message of this event
Returns:: this
See Also:: source(), target(), sourceCode(), targetCode(), othersCode(), sourceMessage(), targetMessage(), othersMessage()

trailerMsgs

java.util.List<CMMsg> trailerMsgs()

Returns a List of other CMMsg events which are slated to be confirmed and executed AFTER this current message is handled. This is implemented by the Room object

Returns:: a List of CMMsg objects
See Also:: Room.send(MOB, CMMsg)

addTrailerMsg

CMMsg addTrailerMsg(CMMsg msg)

Appends to the list of other CMMsg events which are slated to be confirmed and executed AFTER this current message is handled. This is implemented by the Room object

Parameters:: msg - the CMMsg to append to this message.
Returns:: this
See Also:: Room.send(MOB, CMMsg)

trailerRunnables

java.util.List<java.lang.Runnable> trailerRunnables()

Returns a List of other Runnables which are slated to be and executed AFTER this current message is handled. This is implemented by the Room object

Returns:: a List of Runnable objects
See Also:: Room.send(MOB, CMMsg)

addTrailerRunnable

CMMsg addTrailerRunnable(java.lang.Runnable runner)

Appends to the list of Runnable objects which are slated to be confirmed and executed AFTER this current message is handled. This is implemented by the Room object

Parameters:: runner - the Runnable to append to this message.
Returns:: this
See Also:: Room.send(MOB, CMMsg)

parseFlatString

void parseFlatString(java.lang.String flat)

Unserializes this message as well as it reasonably can. It skips any trailer messages and runnables.

Parameters:: flat - the serialized message
See Also:: toFlatString()

toFlatString

java.lang.String toFlatString()

Serializes this message as well as it reasonably can. It skips any trailer messages and runnables.

Returns:: the serialized message
See Also:: parseFlatString(String)

sameAs

boolean sameAs(CMMsg E)

Whether this object instance is functionally identical to the object passed in.

Parameters:: E - the object to compare this one to
Returns:: whether this object is the same as the one passed in

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

MINOR_MASK

MAJOR_MASK

MASK_HANDS

MASK_MOVE

MASK_EYES

MASK_MOUTH

MASK_SOUND

MASK_ALWAYS

MASK_MAGIC

MASK_DELICATE

MASK_MALICIOUS

MASK_CHANNEL

MASK_OPTIMIZE

MASK_CNTRLMSG

MASK_INTERMSG

TYP_AREAAFFECT

TYP_PUSH

TYP_PULL

TYP_RECALL

TYP_OPEN

TYP_CLOSE

TYP_PUT

TYP_GET

TYP_UNLOCK

TYP_LOCK

TYP_WIELD

TYP_GIVE

TYP_BUY

TYP_SELL

TYP_DROP

TYP_WEAR

TYP_FILL

TYP_DELICATE_HANDS_ACT

TYP_VALUE

TYP_HOLD

TYP_NOISYMOVEMENT

TYP_QUIETMOVEMENT

TYP_WEAPONATTACK

TYP_LOOK

TYP_READ

TYP_NOISE

TYP_SPEAK

TYP_CAST_SPELL

TYP_LIST

TYP_EAT

TYP_ENTER

TYP_FOLLOW

TYP_LEAVE

TYP_SLEEP

TYP_SIT

TYP_STAND

TYP_FLEE

TYP_NOFOLLOW

TYP_WRITE

TYP_FIRE

TYP_COLD

TYP_WATER

TYP_GAS

TYP_MIND

TYP_GENERAL

TYP_JUSTICE

TYP_ACID

TYP_ELECTRIC

TYP_POISON

TYP_UNDEAD

TYP_MOUNT

TYP_DISMOUNT

TYP_OK_ACTION

TYP_OK_VISUAL

TYP_DRINK

TYP_HANDS

TYP_PARALYZE

TYP_WAND_USE

TYP_SERVE

TYP_REBUKE

TYP_ADVANCE

TYP_DISEASE

TYP_DEATH

TYP_DEPOSIT

com.planet_ink.coffee_mud.Common.interfaces
Interface CMMsg