org.made.neohabitat.mods

Class Avatar

java.lang.Object

org.elkoserver.server.context.Mod

org.made.neohabitat.HabitatMod

org.made.neohabitat.Container

org.made.neohabitat.mods.Avatar

All Implemented Interfaces:

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

public class Avatar
extends Container
implements UserMod

The Avatar Mod (attached to an Elko User.) This holds both the Habitat User state, and the Avatar state and behaviors, which include action on the User's Avatar, and when interacting with other User's Avatars.

Author:

randy

Field Summary

Fields

Modifier and Type	Field and Description
int	action TODO Doc
int	activity The current avatar pose
int	bankBalance The number of tokens this avatar has in the bank (not cash-on-hand.)
protected String	bodyType The body type for the avatar TODO
protected static int	ConnectionType Static constant CONNECTION_TYPE indicates the kind of client connected for this session
int	curse_type Non-zero when the Avatar-User is cursed.
int[]	custom Avatar customization TODO Doc
int	dest_x TODO Doc
int	dest_y
static int	FACE_LEFT
static int	FACE_RIGHT
static int	GENDER_BIT
int	health Hit Points.
boolean[]	nitty_bits A collection of server-side Avatar status flags
int	restrainer TODO Doc
Magical	savedMagical
HabitatMod	savedTarget Target NOID and magic item saved between events, such as for the GOD TOOL (see Magical.java).
static int	SIT_CHAIR
static int	SIT_FRONT
static int	SIT_GROUND
static int	STAND
static int	STAND_FRONT
static int	STAND_LEFT
static int	STAND_RIGHT
int	stun_count Non-zero when the Avatar-User is stunned.
int	true_head_style Cache of avatar.contents(HEAD).style to restore after a curse.

Fields inherited from class org.made.neohabitat.HabitatMod

gen_flags, gr_state, gr_width, noid, orientation, style, x, y

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_$, 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$, SPEAK, SPEAK$, SPEAKFORTUNE$, SPRAY, SPRAY$, SQUIGGLE, 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
Avatar(OptInteger style, OptInteger x, OptInteger y, OptInteger orientation, OptInteger gr_state, OptInteger nitty_bits, OptString bodyType, OptInteger stun_count, OptInteger bankBalance, OptInteger activity, OptInteger action, OptInteger health, OptInteger restrainer, int[] custom)

Method Summary

Methods

Modifier and Type	Method and Description
void	avatar_IDENTIFY(User from) Alternate interface to avatar_IDENTIFY, passing this.noid as the missing second argument.
void	avatar_IDENTIFY(User from, int replyNoid) A different message is returned depending on if this avatar is the "from" user or another, the message returned will vary.
void	avatar_NEWREGION(User from, int direction, int passage_id)
int	capacity()
void	DISCORPORATE(User from) Verb (Specific): TODO Turn to/from being a ghost.
JSONLiteral	encode(EncodeControl control) Produce a JSONLiteral representing the encoded state of this object, suitable for transmission over a messaging medium or for writing to persistent storage.
void	ESP(User from) Verb (Specific): TODO Send a point-to-point message to another user/avatar.
boolean	filler()
void	FNKEY(User from, OptInteger key, OptInteger target) Verb (Specific): TODO Deal with FN Key presses.
static int	getConnectionType() Get the ConnectionType for this user.
void	GRAB(User from) Verb (Specific): TODO Grabbing from another avatar.
int	HabitatClass()
String	HabitatModName()
void	HAND(User from) Verb (Specific): TODO Handing in-hand item to another avatar.
void	HELP(User from) Verb (Avatar): Reply with the HELP for this avatar.
boolean	known()
void	NEWREGION(User from, OptInteger direction, OptInteger passage_id) Verb (Specific): TODO Leave the region for another region.
boolean	opaque_container()
int	pc_state_bytes()
void	POSTURE(User from, OptInteger pose) Verb (Specific): TODO Change this avatar's posture.
static void	setConnectionType(int type) Set the ConnectionType for this user.
void	SIT(User from) Verb (Specific): TODO Sit down.
void	SPEAK(User from, OptInteger esp, OptString text) Verb (Specific): TODO Speak to the region/ESP to another user
void	TOUCH(User from) Verb (Specific): TODO Touch another avatar.
void	WALK(User from, OptInteger x, OptInteger y, OptInteger how) Verb (Specific): TODO Walk across the region.

Methods inherited from class org.made.neohabitat.Container

close_container, contents, encodeContainer, get_container_contents

Methods inherited from class org.made.neohabitat.HabitatMod

accessable, adjacent, ASK, available, avatar, change_containers, checkpoint_object, clear_bit, container_is_opaque, container_is_opaque, container, container, current_region, DO, elsewhere, empty_handed, encodeCommon, generic_GET, generic_HELP, generic_PUT, generic_PUT, generic_PUT, generic_THROW, generic_THROW, GET, getable, grabable, here, holding, illegal, illegal, item_value, message_to_god, new_broadcast_msg, new_broadcast_msg, new_neighbor_msg, new_neighbor_msg, new_private_msg, new_private_msg, new_reply_msg, new_reply_msg, obj_id, object_broadcast, object_broadcast, object_say, object_say, objectIsComplete, packBits, position, PUT, RDO, send_broadcast_msg, send_broadcast_msg, send_broadcast_msg, send_broadcast_msg, send_broadcast_msg, send_broadcast_msg, send_broadcast_msg, send_fiddle_msg, send_neighbor_msg, send_neighbor_msg, send_neighbor_msg, send_neighbor_msg, send_neighbor_msg, send_neighbor_msg, send_neighbor_msg, send_private_msg, send_private_msg, send_private_msg, send_private_msg, send_private_msg, send_private_msg, send_private_msg, send_reply_err, send_reply_error, send_reply_error, send_reply_msg, send_reply_msg, send_reply_msg, send_reply_msg, send_reply_msg, send_reply_msg, send_reply_msg, send_reply_success, send_reply_success, set_bit, test_bit, TEST, THROW, trace_msg, unpackBits, unsupported_reply, wearing

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

Field Detail

SIT_GROUND

public static final int SIT_GROUND

See Also:

Constant Field Values

SIT_CHAIR

public static final int SIT_CHAIR

See Also:

Constant Field Values

SIT_FRONT

public static final int SIT_FRONT

See Also:

Constant Field Values

STAND_FRONT

public static final int STAND_FRONT

See Also:

Constant Field Values

STAND_LEFT

public static final int STAND_LEFT

See Also:

Constant Field Values

STAND_RIGHT

public static final int STAND_RIGHT

See Also:

Constant Field Values

STAND

public static final int STAND

See Also:

Constant Field Values

FACE_LEFT

public static final int FACE_LEFT

See Also:

Constant Field Values

FACE_RIGHT

public static final int FACE_RIGHT

See Also:

Constant Field Values

GENDER_BIT

public static final int GENDER_BIT

See Also:

Constant Field Values

ConnectionType

protected static int ConnectionType

Static constant CONNECTION_TYPE indicates the kind of client connected for this session

bodyType

protected String bodyType

The body type for the avatar TODO

nitty_bits

public boolean[] nitty_bits

A collection of server-side Avatar status flags

true_head_style

public int true_head_style

Cache of avatar.contents(HEAD).style to restore after a curse.

curse_type

public int curse_type

Non-zero when the Avatar-User is cursed.

stun_count

public int stun_count

Non-zero when the Avatar-User is stunned.

bankBalance

public int bankBalance

The number of tokens this avatar has in the bank (not cash-on-hand.)

activity

public int activity

The current avatar pose

action

public int action

TODO Doc

health

public int health

Hit Points. Reaching 0 == death

restrainer

public int restrainer

TODO Doc

custom

public int[] custom

Avatar customization TODO Doc

dest_x

public int dest_x

TODO Doc

dest_y

public int dest_y

savedTarget

public HabitatMod savedTarget

Target NOID and magic item saved between events, such as for the GOD TOOL (see Magical.java). This is a transient value and not persisted.

savedMagical

public Magical savedMagical

Constructor Detail

Avatar

@JSONMethod(value={"style","x","y","orientation","gr_state","nitty_bits","bodyType","stun_count","bankBalance","activity","action","health","restrainer","custom"})
public Avatar(OptInteger style,
                      OptInteger x,
                      OptInteger y,
                      OptInteger orientation,
                      OptInteger gr_state,
                      OptInteger nitty_bits,
                      OptString bodyType,
                      OptInteger stun_count,
                      OptInteger bankBalance,
                      OptInteger activity,
                      OptInteger action,
                      OptInteger health,
                      OptInteger restrainer,
                      int[] custom)

Method Detail

HabitatClass

public int HabitatClass()

Specified by:

HabitatClass in interface HabitatVerbs

HabitatModName

public String HabitatModName()

Specified by:

HabitatModName in interface HabitatVerbs

capacity

public int capacity()

Specified by:

capacity in interface HabitatVerbs

pc_state_bytes

public int pc_state_bytes()

Specified by:

pc_state_bytes in interface HabitatVerbs

known

public boolean known()

Specified by:

known in interface HabitatVerbs

opaque_container

public boolean opaque_container()

Specified by:

opaque_container in interface HabitatVerbs

filler

public boolean filler()

Specified by:

filler in interface HabitatVerbs

setConnectionType

public static void setConnectionType(int type)

Set the ConnectionType for this user.

Parameters:

type - CONNECTION_JSON or CONNECTION_HABITAT

getConnectionType

public static int getConnectionType()

Get the ConnectionType for this user.

Returns:

CONNECTION_JSON or CONNECTION_HABITAT

encode

public JSONLiteral encode(EncodeControl control)

Description copied from interface: Encodable

Produce a JSONLiteral representing the encoded state of this object, suitable for transmission over a messaging medium or for writing to persistent storage.

Specified by:

encode in interface Encodable

Parameters:

control - Encode control determining what flavor of encoding should be done.

Returns:

a JSONLiteral representing the encoded state of this object.

GRAB

@JSONMethod
public void GRAB(User from)

Verb (Specific): TODO Grabbing from another avatar.

Parameters:

from - User representing the connection making the request.

HAND

@JSONMethod
public void HAND(User from)

Verb (Specific): TODO Handing in-hand item to another avatar.

Parameters:

from - User representing the connection making the request.

POSTURE

@JSONMethod(value="pose")
public void POSTURE(User from,
                           OptInteger pose)

Verb (Specific): TODO Change this avatar's posture.

Parameters:

from - User representing the connection making the request.

SPEAK

@JSONMethod(value={"esp","text"})
public void SPEAK(User from,
                         OptInteger esp,
                         OptString text)

Verb (Specific): TODO Speak to the region/ESP to another user

Parameters:

from - User representing the connection making the request.

esp - Byte flag indicating that ESP message mode is active on the client.

text - The string to speak...

WALK

@JSONMethod(value={"x","y","how"})
public void WALK(User from,
                        OptInteger x,
                        OptInteger y,
                        OptInteger how)

Verb (Specific): TODO Walk across the region.

Parameters:

from - User representing the connection making the request.

NEWREGION

@JSONMethod(value={"direction","passage_id"})
public void NEWREGION(User from,
                             OptInteger direction,
                             OptInteger passage_id)

Verb (Specific): TODO Leave the region for another region.

Parameters:

from - User representing the connection making the request.

DISCORPORATE

@JSONMethod
public void DISCORPORATE(User from)

Verb (Specific): TODO Turn to/from being a ghost.

Parameters:

from - User representing the connection making the request.

ESP

@JSONMethod
public void ESP(User from)

Verb (Specific): TODO Send a point-to-point message to another user/avatar.

Parameters:

from - User representing the connection making the request.

SIT

@JSONMethod
public void SIT(User from)

Verb (Specific): TODO Sit down. [Stand up?]

Parameters:

from - User representing the connection making the request.

TOUCH

@JSONMethod
public void TOUCH(User from)

Verb (Specific): TODO Touch another avatar.

Parameters:

from - User representing the connection making the request.

FNKEY

@JSONMethod(value={"key","target"})
public void FNKEY(User from,
                         OptInteger key,
                         OptInteger target)

Verb (Specific): TODO Deal with FN Key presses.

Parameters:

from - User representing the connection making the request.

HELP

@JSONMethod
public void HELP(User from)

Verb (Avatar): Reply with the HELP for this avatar.

Specified by:

HELP in interface HabitatVerbs

Overrides:

HELP in class HabitatMod

Parameters:

from - User representing the connection making the request.

avatar_IDENTIFY

public void avatar_IDENTIFY(User from)

Alternate interface to avatar_IDENTIFY, passing this.noid as the missing second argument.

Parameters:

from - User representing the connection making the request.

avatar_IDENTIFY

public void avatar_IDENTIFY(User from,
                   int replyNoid)

A different message is returned depending on if this avatar is the "from" user or another, the message returned will vary.

Parameters:

from - User representing the connection making the request.

replyNoid - which avatar.noid is the one getting the reply.

avatar_NEWREGION

public void avatar_NEWREGION(User from,
                    int direction,
                    int passage_id)