HabitatMod (neohabitat 0.1.0-SNAPSHOT API)

java.lang.Object
- org.elkoserver.server.context.Mod
- - org.made.neohabitat.HabitatMod

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ContextMod, GeneralMod, ItemMod, ObjectCompletionWatcher, UserMod, Constants, HabitatVerbs

Direct Known Subclasses:

Container, Head, Key, Magical, Massive, Short_sign, Sign, Switch, Tree, Walkable, Wall
```
public abstract class HabitatMod
extends Mod
implements HabitatVerbs, ObjectCompletionWatcher
```
This is the master superclass of the Habitat Elko project. All of the game-specific behavior is either in this class or in one of it's descendants. It implements defaults for all the required verbs, the common state that every habitat object has, and lots of generic behavior. The Elko Open Source project provides a replacement for all of the critical services provided by Q-Link/AOL. It also provides all of the connection management, object database, and message dispatching services that were part of Habitat's server core (non-game logic). ALL of the original source that is ported here was written in a 1980's flavor of Stratus PL1. PL1 was all about globals, pass by reference, and no support for classes. 30 years ago, Chip Morningstar wrote the bulk of the Habitat game-logic code, simulating structures, classes, and a form of class inheritance by concatenating include files and careful management of procedure references. The game-logic port of PL1 Habitat to Elko Habitat [Java] focuses on clarity of checking that the translated code is correct and visibly similar to the original code. This means that some of the coding practices evolved over the last three decades have been set aside. For example - naming conventions about mixed-caps and underscores have been "rolled back" to 1988 - at least in terms of the behavior code. Any 100% new Java code may use modern naming conventions are used (For example, the Habitat mod names are all start with a capital letter.) The non-static constant globals present a different problem and have been replaced with public state that is accessed by getter functions. So the PL1 contents array has been replaced with contents(). Likewise bit-flags are now boolean arrays in memory and they are [un]packed for storage/transmission as needed. And simple dereference functions such as avatar(), container(), current_region(), and position() are provided where globals once were.

Author:

randy

Field Summary

Fields
Modifier and Type	Field and Description
`boolean[]`	`gen_flags`
`int`	`gr_state`
`int`	`gr_width`
`int`	`noid` 0-255.
`int`	`orientation` Each graphic resource has multiple views (orientations)
`int`	`style` 0-255 Each Habitat Class has a 0-based table mapping to a global 0-255 space of graphics.
`int`	`x` The horizontal position, if the container is THE_REGION
`int`	`y` 0-127 If in THE_REGION, the vertical position (+128 if foreground), otherwise the offset within the container.

Fields inherited from interface org.made.neohabitat.Constants
ADJACENCY_ON, ANNOUNCE_$, APPEARING_$, ARRIVAL_$, ARROW_D, ARROW_L, ARROW_R, ARROW_U, ASK, ATTACK, ATTACK$, AUTO_TELEPORT_$, AUTO_TELEPORT_DIR, AV_ACT_arm_back, AV_ACT_arm_get, AV_ACT_bend_back, AV_ACT_bend_over, AV_ACT_frown, AV_ACT_get_shot, AV_ACT_gimme, AV_ACT_hand_back, AV_ACT_hand_out, AV_ACT_jump, AV_ACT_knife, AV_ACT_nop, AV_ACT_operate, AV_ACT_point, AV_ACT_punch, AV_ACT_shoot1, AV_ACT_shoot2, AV_ACT_sit_chair, AV_ACT_sit_floor, AV_ACT_sit_front, AV_ACT_stand, AV_ACT_stand_back, AV_ACT_stand_front, AV_ACT_throw, AV_ACT_unpocket, AV_ACT_walk, AV_ACT_walk_back, AV_ACT_walk_front, AV_ACT_wave, AVATAR_CAPACITY, BALL, BALL_ALT, BALL_FILLED, BASH, BASH$, BEEP$, BLACK_CHAR, BLAST$, BOING_FAILURE, BOX_C, BOX_CD, BOX_CL, BOX_CR, BOX_CU, BOX_DL, BOX_DR, BOX_UL, BOX_UR, british_pound, BUGOUT, BUGOUT$, BYTE_MASK, C64_CONTAINED_OFFSET, C64_CUSTOMIZE_OFFSET, C64_DESTX_OFFSET, C64_DESTY_OFFSET, C64_GR_STATE_OFFSET, C64_HEAP_SIZE, C64_ORIENT_OFFSET, C64_TEXT_OFFSET, C64_TOKEN_DENOM_OFFSET, C64_XPOS_OFFSET, C64_YPOS_OFFSET, CATALOG, CAUGHT_UP_$, CHANGE, CHANGE_CONTAINERS_$, CHANGE$, CHANGELIGHT_$, CHANGESTATE_$, CHANGESTATE$, CIRC_DL, CIRC_DR, CIRC_UL, CIRC_UR, CLASS_AMULET, CLASS_AQUARIUM, CLASS_ATM, CLASS_AVATAR, CLASS_BAG, CLASS_BALL, CLASS_BED, CLASS_BEEPER, CLASS_BOAT, CLASS_BOOK, CLASS_BOOMERANG, CLASS_BOTTLE, CLASS_BOX, CLASS_BRIDGE, CLASS_BUILDING, CLASS_BUREAUCRAT, CLASS_BUSH, CLASS_CAR, CLASS_CHAIR, CLASS_CHANGOMATIC, CLASS_CHEST, CLASS_CLUB, CLASS_COKE_MACHINE, CLASS_COMPASS, CLASS_COUCH, CLASS_COUNTERTOP, CLASS_CREDIT_CARD, CLASS_CRYSTAL_BALL, CLASS_DIE, CLASS_DISPLAY_CASE, CLASS_DOOR, CLASS_DROPBOX, CLASS_DRUGS, CLASS_ELEVATOR, CLASS_ESCAPE_DEV, CLASS_FAKE_GUN, CLASS_FENCE, CLASS_FISH_FOOD, CLASS_FLAG, CLASS_FLASHLIGHT, CLASS_FLAT, CLASS_FLOOR_LAMP, CLASS_FORTUNE_MACHINE, CLASS_FOUNTAIN, CLASS_FRISBEE, CLASS_GAME_PIECE, CLASS_GARBAGE_CAN, CLASS_GEMSTONE, CLASS_GHOST, CLASS_GLUE, CLASS_GRENADE, CLASS_GROUND, CLASS_GUN, CLASS_HAND_OF_GOD, CLASS_HAT, CLASS_HEAD, CLASS_HOLE, CLASS_HOT_TUB, CLASS_HOUSE_CAT, CLASS_INSTANT_OBJECT, CLASS_JACKET, CLASS_JUKEBOX, CLASS_KEY, CLASS_KNICK_KNACK, CLASS_KNIFE, CLASS_MAGIC_LAMP, CLASS_MAGIC_STAFF, CLASS_MAGIC_WAND, CLASS_MAILBOX, CLASS_MATCHBOOK, CLASS_MICROPHONE, CLASS_MOTORCYCLE, CLASS_MOVIE_CAMERA, CLASS_PAPER, CLASS_PARKING_METER, CLASS_PAWN_MACHINE, CLASS_PENCIL, CLASS_PICTURE, CLASS_PLANT, CLASS_PLAQUE, CLASS_POND, CLASS_RADIO, CLASS_REGION, CLASS_RING, CLASS_RIVER, CLASS_ROAD_PIZZA, CLASS_ROCK, CLASS_ROOF, CLASS_RUBBER_DUCKY, CLASS_SAFE, CLASS_SECURITY_DEV, CLASS_SENSOR, CLASS_SEX_CHANGER, CLASS_SHOES, CLASS_SHORT_SIGN, CLASS_SHOVEL, CLASS_SIDEWALK, CLASS_SIGN, CLASS_SKATEBOARD, CLASS_SKIRT, CLASS_SKY, CLASS_SPRAY_CAN, CLASS_STEREO, CLASS_STREET, CLASS_STREETLAMP, CLASS_STUN_GUN, CLASS_SUPER_TRAPEZOID, CLASS_SWITCH, CLASS_TABLE, CLASS_TAPE, CLASS_TEDDY_BEAR, CLASS_TELEPHONE, CLASS_TELEPORT, CLASS_TEST, CLASS_TICKET, CLASS_TOKENS, CLASS_TOWEL, CLASS_TRAPEZOID, CLASS_TREE, CLASS_TRUCK, CLASS_VENDO_FRONT, CLASS_VENDO_INSIDE, CLASS_WALKIE_TALKIE, CLASS_WALL, CLASS_WATER, CLASS_WINDOW, CLASS_WINDUP_TOY, clear_key, CLIENT_ERRORS, CLOSE, CLOSE$, CLOSECONTAINER, CLOSECONTAINER$, COLLISION_ON, COLOR_BITS, COLOR_FLAG, COLOR_POSTURE, CONNECTION_HABITAT, CONNECTION_JSON, CORPORATE, CURSE_COOTIES, CURSE_FLY, CURSE_MUTANT, CURSE_NONE, CURSE_SMILEY, cursor_down, cursor_left, cursor_right, cursor_up, CUSTOMIZE, DEATH_ENTRY, DEPARTING_$, DEPARTURE_$, DEPOSIT, DESCRIBE, DIAG_DL, DIAG_DR, DIAG_UL, DIAG_UR, DIAL$, DIE$, DIG, DIG$, DIRECT, DISCORPORATE, DOOR_AVATAR_RESTRICTED_BIT, DOOR_GHOST_RESTRICTED_BIT, DRIVE$, ESP, EXPIRE_$, EXPLODE_$, FACE_LEFT, FACE_RIGHT, FACING_BIT, FAKESHOOT, FAKESHOOT$, FALSE, FEED, FIDDLE_$, FIFTH, FILL, FILL$, FINGER_IN_QUE, FIRST, FLUSH, FLUSH$, FNKEY, FOREGROUND_BIT, FOURTH, GET, GET$, GOAWAY_$, GOD_FLAG, GOD_TOOL_PROMPT, GRAB, GRAB$, GRABFROM$, GROUND_FLAT, HAND, HANDS, HANG$, HEAD, HEAD_GROUND_STATE, HELP, HEREIS_$, home_key, HUNGUP$, I_AM_HERE, IMALIVE, insert_key, INVISIBLE, LEAVE, LINE_LR, LINE_UD, LOAD, LOAD$, LOTTO_PROMPT, MAGIC, MAGIC_LAMP_GENIE, MAGIC_LAMP_WAITING, MAGIC_OPEN_PROMPT, MAIL_SLOT, MAILARRIVED$, MAX_CLASS_NUMBER, MAX_CLASS_NUMBER_PLUS_1, MAX_HEALTH, MAX_WORD_BALLON_LEN, MISC_FLAG1, MISC_FLAG2, MISC_FLAG3, MODIFIED, MUNCH, MUNCH$, NEWHEAD$, NEWREGION, NULL, NUMBER_OF_RESOURCES, OBJECTSPEAK_$, ObjectsPerRegion, OFF, OFF$, OFFLIGHT$, OFFPLAYER, ON, ON$, ONLIGHT$, ONPLAYER, OPEN, OPEN_BIT, OPEN$, OPENCONTAINER, OPENCONTAINER$, OPERATE, ORACLESPEAK_$, PAID$, PAPER_LENGTH, PATTERN_BITS, PAY, PAY$, PAYTO, PAYTO$, PLAY_$, PLAYMESSAGE, POSTURE, POSTURE$, POUR, POUR$, PROMPT_REPLY, PROMPT_USER_$, PSENDMAIL, PULLPIN, PUT, PUT$, READ, READLABEL, READMAIL, README, regions_per_process, REINCARNATE$, REMOVE, REMOVE$, RESET, RESET$, RESTRICTED, RETURN$, ROLL, ROLL$, RUB, RUB$, SCAN, SCAN$, SECOND, SELECT, SELL$, SENDMAIL, Separation_Char, SEXCHANGE, SEXCHANGE$, shift_0, shift_asterisk, shift_at, shift_british_pound, shift_equal, shift_minus, shift_plus, sign_char_cursor_down, sign_char_cursor_left, sign_char_cursor_right, sign_char_cursor_up, sign_char_dec_height, sign_char_dec_width, sign_char_double_space, sign_char_half_char_down, sign_char_half_size, sign_char_half_space, sign_char_inc_height, sign_char_inc_width, sign_char_inverse_video, sign_char_return_key, SIT, SIT_CHAIR, SIT_FRONT, SIT_GROUND, SIT$, SPEAK, SPEAK$, SPEAKFORTUNE$, SPRAY, SPRAY$, SQUIGGLE, STAND, STAND_FRONT, STAND_LEFT, STAND_RIGHT, start_text, STEAL_FREE, STUN, TAKE, TAKE$, TAKEMESSAGE$, TALK, TELEPORT_ENTRY, TEXT_LENGTH, THE_REGION, THIRD, THROW, THROW$, THROWAWAY$, TOUCH, TRANSFORM$, TRUE, UNHOOK, UNHOOK$, UNLOAD, UNLOAD$, UNLOCKED_BIT, UNWEARABLE, UPDATE$, UsersPerRegion, VOTED_FLAG, VSELECT, VSELECT$, WAITFOR_$, WALK, WALK_ENTRY, WALK$, WEAPONS_FREE, WEAR, WEAR$, WIND, WIND$, WISH, WISH$, WITHDRAW, WRITE, ZAPIN$, ZAPTO, ZAPTO$

Constructor Summary

Constructors
Constructor and Description
`HabitatMod(OptInteger style, OptInteger x, OptInteger y, OptInteger orientation, OptInteger gr_state)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`accessable(HabitatMod object)` accessable -- Return true iff a given object can be reached by the avatar.
`boolean`	`adjacent(HabitatMod object)` Are we standing next to the object so we can manipulate it properly?
`void`	`ASK(User from)` Verb (Illegal): This shouldn't get here.
`boolean`	`available(HabitatMod container, int x, int y)` Is the specified position available to be filled?
`Avatar`	`avatar(User user)` Replaces globals avatar/avatarptr
`boolean`	`change_containers(HabitatMod obj, Container new_container, int new_position, boolean cp)` change_containers -- Move an object from one container to another.
`void`	`checkpoint_object(HabitatMod mod)` Write the object to the Elko Habitat Database.
`int`	`clear_bit(int val, int bitpos)` Clear a bit in an integer.
`boolean`	`container_is_opaque(HabitatMod cont)` Visibility check.
`boolean`	`container_is_opaque(HabitatMod cont, int pos)` This is a special-case visibility check.
`Container`	`container()` Replaces global container (altenate interface)
`Container`	`container(HabitatMod obj)` Replaces global container
`Region`	`current_region()` Replaces global current_region
`void`	`DO(User from)` Verb (Illegal): This shouldn't get here.
`boolean`	`elsewhere(HabitatMod object, User user)` elsewhere -- Return true iff the object is not near the Avatar (i.e., not adjacent and not in hand).
`boolean`	`empty_handed(Avatar who)` empty_handed -- Return true iff 'who' is not holding anything.
`JSONLiteral`	`encodeCommon(JSONLiteral result)`
`void`	`generic_GET(User from)` Almost all efforts to GET a Habitat object go through this code.
`void`	`generic_HELP(User from)` Most of the Habitat classes only need simple strings for their HELP messages, so this generic implementation provides that.
`void`	`generic_PUT(User from)` Simple 0-parameter PUT version provided to allow for JSON interface testing.
`void`	`generic_PUT(User from, Container cont, int pos_x, int pos_y, int obj_orient)` Most attempt to PUT an item go through this code.
`void`	`generic_PUT(User from, int containerNoid, int x, int y, int orientation)` Put this into a new container specified by noid.
`void`	`generic_THROW(User from, HabitatMod target, int target_x, int target_y)` Throw this across the room, onto some kind of surface.
`void`	`generic_THROW(User from, int target, int target_x, int target_y)` Throw this across the room, onto some kind of surface, by noid.
`void`	`GET(User from)` Verb (Generic): Pick this item up.
`boolean`	`getable(HabitatMod object)` getable -- Return true iff a given object can be picked up by an avatar.
`boolean`	`grabable(HabitatMod object)` grabable -- Return true iff a given object can be grabbed from an avatar's hand.
`void`	`HELP(User from)` Verb (Generic): Get HELP for this.
`boolean`	`here(HabitatMod object, User user)` here -- Return true iff the given object is exactly where the Avatar is.
`boolean`	`holding(Avatar avatar, HabitatMod object)` holding -- Return true iff the avatar is holding a given object.
`void`	`illegal(User from)` Dump a trace message that an illegal request was received into the log.
`void`	`illegal(User from, String request)` Dump a trace message that an illegal request was received into the log.
`int`	`item_value(HabitatMod item)` Used in pawn machines to set the buy-back value of a Habitat object.
`void`	`message_to_god(HabitatMod obj, HabitatMod avatar, String msg)` Message from a Habitat user that is meant to be logged in a special Oracle/Moderator log file.
`JSONLiteral`	`new_broadcast_msg(int noid, String op)` Create a JSONLiteral initialized with the minimum arguments for broadcast from the Habitat/Elko server.
`JSONLiteral`	`new_broadcast_msg(String op)` Create a JSONLiteral initialized with the minimum arguments needed for the Habitat/Elko server.
`JSONLiteral`	`new_neighbor_msg(int noid, String op)` Create a JSONLiteral initialized with the minimum arguments to send to a user/connections "neighbors/other users" via the Habitat/Elko server.
`JSONLiteral`	`new_neighbor_msg(String op)` Create a JSONLiteral initialized with the minimum arguments to send to a user/connections "neighbors/other users" via the Habitat/Elko server.
`JSONLiteral`	`new_private_msg(int noid, String op)` Create a JSONLiteral initialized with the minimum arguments to send a private message to a single targeted user/connection.
`JSONLiteral`	`new_private_msg(String op)` Create a JSONLiteral initialized with the minimum arguments to send a private message to a single targeted user/connection.
`JSONLiteral`	`new_reply_msg()` Generates a reply message assuming that the noid is inferred by this object.
`JSONLiteral`	`new_reply_msg(int noid)` Creates a SYNCHRONOUS (client is waiting) reply message using the minimum arguments.
`String`	`obj_id()` Replaces original global 'obj_id' NOTE: Changes it's type from originally numeric to string.
`void`	`object_broadcast(int noid, String text)` An object sends a string message to everyone
`void`	`object_broadcast(String text)` An object sends a string message to everyone
`void`	`object_say(User to, int noid, String text)` An object sends a string message to a specific user
`void`	`object_say(User to, String text)` An object sends a string message to a specific user
`void`	`objectIsComplete()` Do what needs to be done now that you are in a finished object environment.
`int`	`packBits(boolean[] bits)` NOTE: PL1 arrays uses 1-based arrays, so historically all the bit offset constants are as well.
`int`	`position()` Replaces original global 'position'
`void`	`PUT(User from, OptInteger containerNoid, OptInteger x, OptInteger y, OptInteger orientation)` Verb (Generic): Put this item into some container or on the ground.
`void`	`RDO(User from)` Verb (Illegal): This shouldn't get here.
`void`	`send_broadcast_msg(int noid, String op)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String text)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String attrib, int value)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String a1, int v1, String a2, int v2)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String a1, int v1, String a2, int v2, String a3, int v3)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String a1, int v1, String a2, int v2, String a3, int v3, String a4, int v4)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_broadcast_msg(int noid, String op, String attrib, String value)` Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
`void`	`send_fiddle_msg(int noid, int[] args)` Send a fiddle message to the entire region.
`void`	`send_neighbor_msg(User from, int noid, String op)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region.
`void`	`send_neighbor_msg(User from, int noid, String op, String attrib, int value)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with an additional parameters.
`void`	`send_neighbor_msg(User from, int noid, String op, String a1, int v1, String a2, int v2)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
`void`	`send_neighbor_msg(User from, int noid, String op, String a1, int v1, String a2, int v2, String a3, int v3)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
`void`	`send_neighbor_msg(User from, int noid, String op, String a1, int v1, String a2, int v2, String a3, int v3, String a4, int v4)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
`void`	`send_neighbor_msg(User from, int noid, String op, String attrib, String value)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with an additional string.
`void`	`send_neighbor_msg(User from, String op)` Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region.
`void`	`send_private_msg(User from, int noid, User to, String op)` Send a private message to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String text)` Send a single-string private message to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String attribute, int value)` Send a single-byte private message to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String a1, int v1, String a2, int v2)` Send a private message with additional parameters to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String a1, int v1, String a2, int v2, String a3, int v3)` Send a private message with additional parameters to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String a1, int v1, String a2, int v2, String a3, int v3, String a4, int v4)` Send a private message with additional parameters to a specified user-connection.
`void`	`send_private_msg(User from, int noid, User to, String op, String attribute, String value)` Send a single-string private message to a specified user-connection.
`void`	`send_reply_err(User from, int noid, int err)` Send simple SYNCHRONOUS reply indicating success or failure.
`void`	`send_reply_error(User from)` Send simple SYNCHRONOUS reply indicating failure.
`void`	`send_reply_error(User from, int noid)` Send simple SYNCHRONOUS reply indicating failure.
`void`	`send_reply_msg(User from, int noid)` Sends a SYNCHRONOUS (client is waiting) reply message using the minimum arguments.
`void`	`send_reply_msg(User from, int noid, String attrib, int value)` Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
`void`	`send_reply_msg(User from, int noid, String a1, int v1, String a2, int v2)` Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
`void`	`send_reply_msg(User from, int noid, String a1, int v1, String a2, int v2, String a3, int v3)` Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
`void`	`send_reply_msg(User from, int noid, String a1, int v1, String a2, int v2, String a3, int v3, String a4, int v4)` Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
`void`	`send_reply_msg(User from, int noid, String attrib, String value)` Sends a SYNCHRONOUS (client is waiting) reply message, with additional String value.
`void`	`send_reply_msg(User from, String text)` Sends a SYNCHRONOUS (client is waiting) string-only reply message inferring this.noid.
`void`	`send_reply_success(User from)` Send simple SYNCHRONOUS reply indicating success.
`void`	`send_reply_success(User from, int noid)` Send simple SYNCHRONOUS reply indicating success.
`int`	`set_bit(int val, int bitpos)` Set a bit in an integer.
`boolean`	`test_bit(int val, int bitpos)` Test to see if a specific bit is set.
`void`	`TEST(User from)` Verb (Debug): Test rigging for Elko Habitat developers to write trace messages into the log without actually doing anything
`void`	`THROW(User from, int target, int x, int y)` Verb (Generic): Throw this across the Region
`void`	`trace_msg(String msg)` Dump a string to the debugging server log.
`boolean[]`	`unpackBits(int packedBits)`
`void`	`unsupported_reply(User from, int noid, String text)` Temporary scaffolding for incremental development of the server.
`boolean`	`wearing(Avatar avatar, HabitatMod object)` wearing -- Return true iff the avatar is wearing (head slot) a given object.

Methods inherited from class org.elkoserver.server.context.Mod
attachTo, clone, context, ensureHolding, ensureInContext, ensureReachable, ensureSameContext, ensureSameUser, holder, isEphemeral, markAsChanged, markAsEphemeral, object

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

Methods inherited from interface org.made.neohabitat.HabitatVerbs
capacity, filler, HabitatClass, HabitatModName, known, opaque_container, pc_state_bytes

Methods inherited from interface org.elkoserver.json.Encodable
encode

- Field Detail
  - noid
```
public int noid
```
    0-255. Ephemeral Numeric Object ID: The client's world model of region contents, 0 = THE_REGION.
  - style
```
public int style
```
    0-255 Each Habitat Class has a 0-based table mapping to a global 0-255 space of graphics.
  - x
```
public int x
```
    The horizontal position, if the container is THE_REGION
  - y
```
public int y
```
    0-127 If in THE_REGION, the vertical position (+128 if foreground), otherwise the offset within the container.
  - orientation
```
public int orientation
```
    Each graphic resource has multiple views (orientations)
  - gr_state
```
public int gr_state
```
  - gr_width
```
public int gr_width
```
  - gen_flags
```
public boolean[] gen_flags
```
- Constructor Detail
  - HabitatMod
```
public HabitatMod(OptInteger style,
          OptInteger x,
          OptInteger y,
          OptInteger orientation,
          OptInteger gr_state)
```
    Constructor. This is an abstract class, and the constructor is only ever called by the actual habitat objects
    
    Parameters:
    style - style offset to choose the presentation image default:0
    x - horizontal screen position default: 0
    y - vertical screen position/z-depth default: 0
    orientation - graphic image orientation default: 0
    gr_state - animation/graphic state default:0
- Method Detail
  - position
```
public int position()
```
    Replaces original global 'position'
    
    Returns:
    this.y which is a synonym for position within a container.
  - obj_id
```
public String obj_id()
```
    Replaces original global 'obj_id' NOTE: Changes it's type from originally numeric to string.
    
    Returns:
    The unique object database identity for the object
  - avatar
```
public Avatar avatar(User user)
```
    Replaces globals avatar/avatarptr
    
    Parameters:
    user - Who you want to get the Avatar Mod for.
    
    Returns:
    Gets the avatar mod for a user
  - current_region
```
public Region current_region()
```
    Replaces global current_region
    
    Returns:
    The Region mod attached to the current Elko context.
  - container
```
public Container container(HabitatMod obj)
```
    Replaces global container
    
    Parameters:
    obj - The habitat mod that wants to find it's container.
    
    Returns:
    The container mod for the item containing the obj.
  - container
```
public Container container()
```
    Replaces global container (altenate interface)
    
    Returns:
    The container mod for the item containing 'this'.
  - objectIsComplete
```
public void objectIsComplete()
```
    Description copied from interface: ObjectCompletionWatcher
    
    Do what needs to be done now that you are in a finished object environment.
    This method will be called automatically by the server's object creation mechanism upon completion of the creation of an object to which the mod implementing this interface is attached.
    Note: if an object has more than one mod that implements this interface, the order in which the various mods' implementations of this method will be called is undefined.
    
    Specified by:
    
    objectIsComplete in interface ObjectCompletionWatcher
  - encodeCommon
```
public JSONLiteral encodeCommon(JSONLiteral result)
```
  - illegal
```
public void illegal(User from)
```
    Dump a trace message that an illegal request was received into the log.
    
    Parameters:
    from - User representing the connection making the request.
  - illegal
```
public void illegal(User from,
           String request)
```
    Dump a trace message that an illegal request was received into the log.
    
    Parameters:
    from - User representing the connection making the request.
    request - The string describing the rejected request.
  - TEST
```
@JSONMethod
public void TEST(User from)
```
    Verb (Debug): Test rigging for Elko Habitat developers to write trace messages into the log without actually doing anything
    
    Parameters:
    from - User representing the connection making the request.
  - HELP
```
@JSONMethod
public void HELP(User from)
```
    Verb (Generic): Get HELP for this. Unlike most verbs, HELP has a useful default implementation that applies to all classes that don't choose to override it.
    
    Specified by:
    
    HELP in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
  - ASK
```
@JSONMethod
public void ASK(User from)
```
    Verb (Illegal): This shouldn't get here. Log it.
    
    Specified by:
    
    ASK in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
  - DO
```
@JSONMethod
public void DO(User from)
```
    Verb (Illegal): This shouldn't get here. Log it.
    
    Specified by:
    
    DO in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
  - RDO
```
@JSONMethod
public void RDO(User from)
```
    Verb (Illegal): This shouldn't get here. Log it.
    
    Specified by:
    
    RDO in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
  - GET
```
@JSONMethod
public void GET(User from)
```
    Verb (Generic): Pick this item up.
    
    Specified by:
    
    GET in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
  - PUT
```
@JSONMethod(value={"containerNoid","x","y","orientation"})
public void PUT(User from,
                       OptInteger containerNoid,
                       OptInteger x,
                       OptInteger y,
                       OptInteger orientation)
```
    Verb (Generic): Put this item into some container or on the ground.
    
    Specified by:
    
    PUT in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
    containerNoid - The Habitat Noid for the target container THE_REGION is default.
    x - If THE_REGION is the new container, the horizontal position. Otherwise ignored.
    y - If THE_REGION: the vertical position, otherwise the target container slot (e.g. HANDS/HEAD or other.)
    orientation - The new orientation for the object being PUT.
  - THROW
```
@JSONMethod(value={"target","x","y"})
public void THROW(User from,
                         int target,
                         int x,
                         int y)
```
    Verb (Generic): Throw this across the Region
    
    Specified by:
    
    THROW in interface HabitatVerbs
    
    Parameters:
    from - User representing the connection making the request.
    x - Destination horizontal position
    y - Destination vertical position (lower 7 bits)
  - generic_GET
```
public void generic_GET(User from)
```
    Almost all efforts to GET a Habitat object go through this code. It has lots of special cases. Various ways GET can fail: the Avatar is already holding something OR the object is not getable OR the object is not accessable OR the object is an open container OR the object is in glue or some other permanent container OR the object is in another Avatar's pockets OR the object is in another Avatar's hands and can't be grabbed OR the Avatar holding the object is offline OR the object is in a display case and belongs to the case's owner OR there's just not enough room here to hold the object!
    
    Parameters:
    from - User representing the connection making the request.
  - generic_PUT
```
public void generic_PUT(User from)
```
    Simple 0-parameter PUT version provided to allow for JSON interface testing. Drops the item at the avatar's feet.
    
    Parameters:
    from - User representing the connection making the request.
  - generic_PUT
```
public void generic_PUT(User from,
               int containerNoid,
               int x,
               int y,
               int orientation)
```
    Put this into a new container specified by noid.
    
    Parameters:
    from - User representing the connection making the request.
    containerNoid - The noid of the new container for this.
    x - The new horizontal position of the object (if the container is THE_REGION)
    y - The new vertical position in THE_REGION or slot number in the new container.
    orientation - The new orientation for this once transfered.
  - generic_PUT
```
public void generic_PUT(User from,
               Container cont,
               int pos_x,
               int pos_y,
               int obj_orient)
```
    Most attempt to PUT an item go through this code. There are lots of special cases. Various ways PUT can fail: the container noid specified by the C64 is invalid OR it's trying to put down a magic lamp in the genie state OR the Avatar is not holding the object OR the target location is not available (already occupied) OR it's putting a restricted object into a non-restricted container OR it's trying to put a flag into a container (not allowed) OR the call to change_containers fails because there is not enough room (this should never happen, since the object is already out, but we check just in case)
    
    Parameters:
    from - User representing the connection making the request.
    cont - The noid of the new container for this.
    pos_x - The new horizontal position of the object (if the container is THE_REGION)
    pos_y - The new vertical position in THE_REGION or slot number in the new container.
    obj_orient - The new orientation for this once transfered.
  - generic_THROW
```
public void generic_THROW(User from,
                 int target,
                 int target_x,
                 int target_y)
```
    Throw this across the room, onto some kind of surface, by noid.
    
    Parameters:
    from - User representing the connection making the request.
    target - The noid of the new container for this.
    target_x - The new horizontal position for this.
    target_y - The new vertical position for this.
  - generic_THROW
```
public void generic_THROW(User from,
                 HabitatMod target,
                 int target_x,
                 int target_y)
```
    Throw this across the room, onto some kind of surface. Various ways THROW can fail: the target noid specified by the C64 is invalid OR it's trying to throw a magic lamp in the genie state OR the Avatar is not holding the object OR the target class specified by the C64 is not allowed OR the call to change_containers fails because there is not enough room (this should never happen, since the object is already out, but we check just in case)
    
    Parameters:
    from - User representing the connection making the request.
    target - The new container
    target_x - The new horizontal position for this.
    target_y - The new vertical position for this.
  - generic_HELP
```
public void generic_HELP(User from)
```
    Most of the Habitat classes only need simple strings for their HELP messages, so this generic implementation provides that. If no override is specified, this is is the HELP message handler.
    
    Parameters:
    from - User representing the connection making the request.
  - unpackBits
```
public boolean[] unpackBits(int packedBits)
```
    Parameters:
    packedBits - The bits unpacked into a boolean array. NOTE: PL1 arrays uses 1-based arrays, so historically all the bit offset constants are as well. We lose the high bit, but we never use it.
    
    Returns:
    boolean array of unpacked bits
  - packBits
```
public int packBits(boolean[] bits)
```
    NOTE: PL1 arrays uses 1-based arrays, so historically all the bit offset constants are as well. We lose the high bit, but we never use it.
    
    Parameters:
    bits - The boolean array to pack into an int.
    
    Returns:
    an int made of the the bits
  - item_value
```
public int item_value(HabitatMod item)
```
    Used in pawn machines to set the buy-back value of a Habitat object.
    
    Parameters:
    item - The thing being priced.
    
    Returns:
    The price in tokens.
  - container_is_opaque
```
public boolean container_is_opaque(HabitatMod cont,
                          int pos)
```
    This is a special-case visibility check. You see, the avatar is both transparent AND opaque.
    
    Parameters:
    cont - The container being tested
    pos - The position being tested
    
    Returns:
    Is this slot, of this container, visible to the region?
  - container_is_opaque
```
public boolean container_is_opaque(HabitatMod cont)
```
    Visibility check.
    
    Parameters:
    cont - The container being tested
    
    Returns:
    Is this slot, of this container, visible to the region?
  - empty_handed
```
public boolean empty_handed(Avatar who)
```
    empty_handed -- Return true iff 'who' is not holding anything.
    
    Parameters:
    who - The avatar being tested.
    
    Returns:
    Is the avatar empty handed?
  - holding
```
public boolean holding(Avatar avatar,
              HabitatMod object)
```
    holding -- Return true iff the avatar is holding a given object.
    
    Parameters:
    avatar - The avatar being tested.
    object - The object being tested.
    
    Returns:
    Is the object in the avatar's hands?
  - wearing
```
public boolean wearing(Avatar avatar,
              HabitatMod object)
```
    wearing -- Return true iff the avatar is wearing (head slot) a given object.
    
    Parameters:
    avatar - The avatar being tested.
    object - The object being tested.
    
    Returns:
    Is the object being worn by the avatar?
  - getable
```
public boolean getable(HabitatMod object)
```
    getable -- Return true iff a given object can be picked up by an avatar.
    
    Parameters:
    object - The object being tested.
    
    Returns:
    Is the object portable?
  - grabable
```
public boolean grabable(HabitatMod object)
```
    grabable -- Return true iff a given object can be grabbed from an avatar's hand. NOTE: Tests the region to see if it is STEAL_FREE.
    
    Parameters:
    object - The object being tested.
    
    Returns:
    Is the object grabable?
  - available
```
public boolean available(HabitatMod container,
                int x,
                int y)
```
    Is the specified position available to be filled?
    
    Parameters:
    container - The target container;
    x - The horizontal position (not considered. Should be deprecated)
    y - The slot/vertical position
    
    Returns:
    Is it OK to put the item at this position?
  - accessable
```
public boolean accessable(HabitatMod object)
```
    accessable -- Return true iff a given object can be reached by the avatar.
    
    Parameters:
    object - The object being tested.
    
    Returns:
    Can we access this object given container nesting??
  - elsewhere
```
public boolean elsewhere(HabitatMod object,
                User user)
```
    elsewhere -- Return true iff the object is not near the Avatar (i.e., not adjacent and not in hand).
    
    Parameters:
    object - The object being tested.
    user - The User-avatar
    
    Returns:
    Is our avatar standing in the right place to manipulate this object?
  - here
```
public boolean here(HabitatMod object,
           User user)
```
    here -- Return true iff the given object is exactly where the Avatar is.
    
    Parameters:
    object - The object being tested.
    user - The User-avatar
    
    Returns:
    Is our avatar standing exactly on the object?
  - adjacent
```
public boolean adjacent(HabitatMod object)
```
    Are we standing next to the object so we can manipulate it properly?
    
    Parameters:
    object - The object being tested.
    
    Returns:
    Is our avatar standing next to the object?
  - change_containers
```
public boolean change_containers(HabitatMod obj,
                        Container new_container,
                        int new_position,
                        boolean cp)
```
    change_containers -- Move an object from one container to another.
    
    Parameters:
    obj - The object being moved
    new_container - The target container
    new_position - The new position (slot)
    cp - Checkpoint flag
    
    Returns:
    success
  - trace_msg
```
public void trace_msg(String msg)
```
    Dump a string to the debugging server log.
    
    Parameters:
    msg - The message to log.
  - message_to_god
```
public void message_to_god(HabitatMod obj,
                  HabitatMod avatar,
                  String msg)
```
    Message from a Habitat user that is meant to be logged in a special Oracle/Moderator log file. Often a message about a special (hard coded) event or speaking with the Oracle Fountain.
    
    Parameters:
    obj - The object that is logging the message (e.g. Oracle Fountain.)
    avatar - The avatar that took the action to trigger the message.
    msg - The message to be logged.
  - object_say
```
public void object_say(User to,
              int noid,
              String text)
```
    An object sends a string message to a specific user
    
    Parameters:
    to - User the message is going to.
    noid - The object speaking to the user.
    text - What the object wants to say.
  - object_say
```
public void object_say(User to,
              String text)
```
    An object sends a string message to a specific user
    
    Parameters:
    to - User the message is going to.
    text - What the object wants to say.
  - object_broadcast
```
public void object_broadcast(int noid,
                    String text)
```
    An object sends a string message to everyone
    
    Parameters:
    noid - The object speaking to the region.
    text - What the object wants to say.
  - object_broadcast
```
public void object_broadcast(String text)
```
    An object sends a string message to everyone
    
    Parameters:
    text - What the object wants to say.
  - send_fiddle_msg
```
public void send_fiddle_msg(int noid,
                   int[] args)
```
    Send a fiddle message to the entire region. The client does all the work.
    
    Parameters:
    noid -
    args -
  - unsupported_reply
```
public void unsupported_reply(User from,
                     int noid,
                     String text)
```
    Temporary scaffolding for incremental development of the server. Call this to say "not ready yet!" and reply with an error code. Hopefully the client will accept the result and proceed.
    
    Parameters:
    from - The connection for this user.
    noid - The noid that sent the request that is being unceremoniously terminated.
    text - This error message text will be sent to the client of the user that issued the unsupported command.
  - new_broadcast_msg
```
public JSONLiteral new_broadcast_msg(int noid,
                            String op)
```
    Create a JSONLiteral initialized with the minimum arguments for broadcast from the Habitat/Elko server.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - new_broadcast_msg
```
public JSONLiteral new_broadcast_msg(String op)
```
    Create a JSONLiteral initialized with the minimum arguments needed for the Habitat/Elko server. Assumes this.noid is the object of interest.
    
    Parameters:
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String text)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    text - A string to send, will have attribute name "text"
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String attrib,
                      int value)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    attrib - The attribute name to be added to the message
    value - The value of the attribute.
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String attrib,
                      String value)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    attrib - The attribute name to be added to the message
    value - The string value of the attribute.
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String a1,
                      int v1,
                      String a2,
                      int v2)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String a1,
                      int v1,
                      String a2,
                      int v2,
                      String a3,
                      int v3)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
  - send_broadcast_msg
```
public void send_broadcast_msg(int noid,
                      String op,
                      String a1,
                      int v1,
                      String a2,
                      int v2,
                      String a3,
                      int v3,
                      String a4,
                      int v4)
```
    Sends a ASYNCHRONOUS broadcast message to all the connections/users/avatars in a region.
    
    Parameters:
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_broadcast_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
    a4 - Fourth attribute to add
    v4 - Fourth value to add
  - new_reply_msg
```
public JSONLiteral new_reply_msg(int noid)
```
    Creates a SYNCHRONOUS (client is waiting) reply message using the minimum arguments.
    
    Parameters:
    noid - The object waiting for this reply.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - new_reply_msg
```
public JSONLiteral new_reply_msg()
```
    Generates a reply message assuming that the noid is inferred by this object.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid)
```
    Sends a SYNCHRONOUS (client is waiting) reply message using the minimum arguments.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
  - send_reply_msg
```
public void send_reply_msg(User from,
                  String text)
```
    Sends a SYNCHRONOUS (client is waiting) string-only reply message inferring this.noid.
    
    Parameters:
    from - The User/connection that gets the reply.
    text - The string to send, added with the attribute name "text"
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid,
                  String attrib,
                  int value)
```
    Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    attrib - The attribute name to be added to the message
    value - The value of the attribute.
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid,
                  String a1,
                  int v1,
                  String a2,
                  int v2)
```
    Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid,
                  String a1,
                  int v1,
                  String a2,
                  int v2,
                  String a3,
                  int v3)
```
    Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid,
                  String a1,
                  int v1,
                  String a2,
                  int v2,
                  String a3,
                  int v3,
                  String a4,
                  int v4)
```
    Sends a SYNCHRONOUS (client is waiting) reply message, with addition attributes/values.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
    a4 - Fourth attribute to add
    v4 - Fourth value to add
  - send_reply_msg
```
public void send_reply_msg(User from,
                  int noid,
                  String attrib,
                  String value)
```
    Sends a SYNCHRONOUS (client is waiting) reply message, with additional String value.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    attrib - The attribute name to be added to the message
    value - The STRING value of the attribute.
  - send_reply_err
```
public void send_reply_err(User from,
                  int noid,
                  int err)
```
    Send simple SYNCHRONOUS reply indicating success or failure.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
    err - The error state byte (NOT boolean), added to the msg as attribute "err"
  - send_reply_error
```
public void send_reply_error(User from,
                    int noid)
```
    Send simple SYNCHRONOUS reply indicating failure.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
  - send_reply_error
```
public void send_reply_error(User from)
```
    Send simple SYNCHRONOUS reply indicating failure. Uses this.noid.
    
    Parameters:
    from - The User/connection that gets the reply.
  - send_reply_success
```
public void send_reply_success(User from,
                      int noid)
```
    Send simple SYNCHRONOUS reply indicating success.
    
    Parameters:
    from - The User/connection that gets the reply.
    noid - The object waiting for this reply.
  - send_reply_success
```
public void send_reply_success(User from)
```
    Send simple SYNCHRONOUS reply indicating success. Uses this.noid.
    
    Parameters:
    from - The User/connection that gets the reply.
  - new_neighbor_msg
```
public JSONLiteral new_neighbor_msg(int noid,
                           String op)
```
    Create a JSONLiteral initialized with the minimum arguments to send to a user/connections "neighbors/other users" via the Habitat/Elko server.
    
    Parameters:
    noid - The object that is acting.
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - new_neighbor_msg
```
public JSONLiteral new_neighbor_msg(String op)
```
    Create a JSONLiteral initialized with the minimum arguments to send to a user/connections "neighbors/other users" via the Habitat/Elko server. this.noid is used for the acting object.
    
    Parameters:
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     String op)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region. this.noid is the acting object.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op,
                     String attrib,
                     int value)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with an additional parameters.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
    attrib - First attribute to add
    value - First value to add
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op,
                     String a1,
                     int v1,
                     String a2,
                     int v2)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op,
                     String a1,
                     int v1,
                     String a2,
                     int v2,
                     String a3,
                     int v3)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op,
                     String a1,
                     int v1,
                     String a2,
                     int v2,
                     String a3,
                     int v3,
                     String a4,
                     int v4)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with additional parameters.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
    a4 - Fourth attribute to add
    v4 - Fourth value to add
  - send_neighbor_msg
```
public void send_neighbor_msg(User from,
                     int noid,
                     String op,
                     String attrib,
                     String value)
```
    Sends a ASYNCHRONOUS message to all the neighbors (other user/connections) in a region with an additional string.
    
    Parameters:
    from - The user/connection that is acting, and the only one that will NOT get the message.
    noid - The object that is broadcasting.
    op - The STRING name of the ASYNCRONOUS request. (See::new_neighbor_msg)
    attrib - Attribute to add
    value - String to add
  - new_private_msg
```
public JSONLiteral new_private_msg(int noid,
                          String op)
```
    Create a JSONLiteral initialized with the minimum arguments to send a private message to a single targeted user/connection.
    
    Parameters:
    noid - The object that is acting.
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - new_private_msg
```
public JSONLiteral new_private_msg(String op)
```
    Create a JSONLiteral initialized with the minimum arguments to send a private message to a single targeted user/connection. this.noid is used as the acting object.
    
    Parameters:
    op - The STRING name of the ASYNCRONOUS request. In the PL/1 source this was a numeric constant, not a string. i.e PL/1: SPEAK$ Elko: "SPEAK$". The lookup now occurs in the Client/Server bridge.
    
    Returns:
    message ready to add more parameters, finish(), and send.
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op)
```
    Send a private message to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String text)
```
    Send a single-string private message to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    text - A string to send. Will be added to the message as the "text" parameter.
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String attribute,
                    String value)
```
    Send a single-string private message to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    attribute - Attribute to add
    value - String to add
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String attribute,
                    int value)
```
    Send a single-byte private message to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    attribute - Attribute to add
    value - Value to add
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String a1,
                    int v1,
                    String a2,
                    int v2,
                    String a3,
                    int v3,
                    String a4,
                    int v4)
```
    Send a private message with additional parameters to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
    a4 - Fourth attribute to add
    v4 - Fourth value to add
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String a1,
                    int v1,
                    String a2,
                    int v2,
                    String a3,
                    int v3)
```
    Send a private message with additional parameters to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
    a3 - Third attribute to add
    v3 - Third value to add
  - send_private_msg
```
public void send_private_msg(User from,
                    int noid,
                    User to,
                    String op,
                    String a1,
                    int v1,
                    String a2,
                    int v2)
```
    Send a private message with additional parameters to a specified user-connection.
    
    Parameters:
    from - The user/connection that instigated this action. Will NOT get a copy of the message.
    noid - The object that is acting.
    to - The user/connection that is the recipient of this private message.
    op - The STRING name of the ASYNCRONOUS request. (See::new_private_msg)
    a1 - First attribute to add
    v1 - First value to add
    a2 - Second attribute to add
    v2 - Second value to add
  - clear_bit
```
public int clear_bit(int val,
            int bitpos)
```
    Clear a bit in an integer.
    
    Parameters:
    val - starting value
    bitpos - 1-based bit position (right to left) to clear
    
    Returns:
    the starting value with the bit cleared.
  - set_bit
```
public int set_bit(int val,
          int bitpos)
```
    Set a bit in an integer.
    
    Parameters:
    val - starting value
    bitpos - 1-based bit position (right to left) to set
    
    Returns:
    the starting value with the bit set.
  - test_bit
```
public boolean test_bit(int val,
               int bitpos)
```
    Test to see if a specific bit is set.
    
    Parameters:
    val - value to search
    bitpos - 1-based bit position (right to left) to test
    
    Returns:
    true if bit is set
  - checkpoint_object
```
public void checkpoint_object(HabitatMod mod)
```
    Write the object to the Elko Habitat Database.
    
    Parameters:
    mod - The Habitat Mod to checkpoint.

Class HabitatMod

Field Summary

Fields inherited from interface org.made.neohabitat.Constants

Constructor Summary

Method Summary

Methods inherited from class org.elkoserver.server.context.Mod

Methods inherited from class java.lang.Object

Methods inherited from interface org.made.neohabitat.HabitatVerbs

Methods inherited from interface org.elkoserver.json.Encodable

Field Detail

noid

style

x

y

orientation

gr_state

gr_width

gen_flags

Constructor Detail

HabitatMod

Method Detail

position

obj_id

avatar

current_region

container

container

objectIsComplete

encodeCommon

illegal

illegal

TEST

HELP

ASK

DO

RDO

GET

PUT

THROW

generic_GET

generic_PUT

generic_PUT

generic_PUT

generic_THROW

generic_THROW

generic_HELP

unpackBits

packBits

item_value

container_is_opaque

container_is_opaque

empty_handed

holding

wearing

getable

grabable

available

accessable

elsewhere

here

adjacent

change_containers

trace_msg

message_to_god

object_say

object_say

object_broadcast

object_broadcast

send_fiddle_msg

unsupported_reply

new_broadcast_msg

new_broadcast_msg

send_broadcast_msg

send_broadcast_msg

send_broadcast_msg

send_broadcast_msg

send_broadcast_msg

send_broadcast_msg

send_broadcast_msg

new_reply_msg