org.starhope.vergil.net
Class ServerCommands

java.lang.Object
  org.starhope.vergil.net.ServerCommands

public abstract class ServerCommands
extends Object

The Appius Claudius Caecus game server sends “response” or “command” packets to the client (whether Publius Vergilius Maro or another client application) in a fairly simple JSON (see http://www.json.org/) format.

Each packet contains a few basic conditions: There will always be a “from” and “status” property on the top-level object. The boolean “status” indicates “success” or “normal” condition, while the “from” key identifies the command being dispatched, the instruction to the client, &c. If the status is false, there will also always be an “err” property giving a machine-readable description of the error condition. There may also be a “msg” property giving an human-legible explanation of the error.

This class accepts the already-parsed JavaScript Object (as JSONObject) and dispatches it accordingly.

Author:

brpocock@star-hope.org

Constructor Summary

ServerCommands()

Method Summary

static void	acceptServerResponse(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
private static void	dispatchError(String source, String string, String optString, org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
private static void	dispatchSuccess(String source, org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_addToList_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_addToList_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_admin_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_admin_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_avatars_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_avatars_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_ayt_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_ayt_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_badgeUpdate_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_badgeUpdate_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_beam_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_beam_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_bots_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_bots_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_buddyList_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_buddyList_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_buddyRequest_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_buddyRequest_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_deleteMailMessage_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_deleteMailMessage_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_earning_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_earning_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_echo_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_echo_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_endEvent_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_endEvent_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_equip_ok(org.json.JSONObject jso) This message is sent whenever the user's equipment changes.
abstract void	from_finger_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_finger_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_forceMove_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_forceMove_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_gameAction_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_gameAction_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getApple_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getApple_ok(org.json.JSONObject jso) The “apple” is the cookie used to perform password authentication.
abstract void	from_getAvailableHouses_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getAvailableHouses_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getAwardRankings_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getAwardRankings_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getColorPalettes_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getColorPalettes_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getInventoryItems_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getInventoryItems_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getMailInBox_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getMailInBox_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getMailMessage_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getMailMessage_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getShopItems_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getShopItems_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getStoreItems_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getStoreItems_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getUserLists_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getUserLists_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getWallet_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_getWallet_ok(org.json.JSONObject jso) WRITEME
abstract void	from_go_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_go_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_gunList_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_gunList_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_initUserRoom_err(org.json.JSONObject jso)
abstract void	from_initUserRoom_ok(org.json.JSONObject jso)
abstract void	from_inventory_err(org.json.JSONObject jso)
abstract void	from_inventory_ok(org.json.JSONObject jso)
abstract void	from_join_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_join_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_migrate_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_migrate_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_outOfBand_err(org.json.JSONObject jso)
abstract void	from_outOfBand_ok(org.json.JSONObject jso)
abstract void	from_pan_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_pan_ok(org.json.JSONObject jso) Pan the view to a given area.
abstract void	from_part_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_part_ok(org.json.JSONObject jso) Sent when any user (avatar) leaves the room.
abstract void	from_passport_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_passport_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_playSound_ok(org.json.JSONObject jso) Play a sound effect on the client
abstract void	from_postman_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_postman_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_prefs_err(org.json.JSONObject jso)
abstract void	from_prefs_ok(org.json.JSONObject jso)
abstract void	from_purchase_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_purchase_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_reportBug_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_reportBug_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_roomJoin_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_roomJoin_ok(org.json.JSONObject jso)
abstract void	from_rv_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_rv_ok(org.json.JSONObject jso) Accept a room variable update.
abstract void	from_scoreUpdate_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_scoreUpdate_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_sendMailMessage_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_sendMailMessage_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_serverTime_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_serverTime_ok(org.json.JSONObject jso)
abstract void	from_showInterface_ok(org.json.JSONObject jso) Display a particular client-side interface element
abstract void	from_startEvent_err(org.json.JSONObject jso)
abstract void	from_startEvent_ok(org.json.JSONObject jso) WRITEME
abstract void	from_uv_err(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_uv_ok(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
abstract void	from_wardrobe_err(org.json.JSONObject jso)
abstract void	from_wardrobe_ok(org.json.JSONObject jso)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerCommands

public ServerCommands()

Method Detail

acceptServerResponse

public static void acceptServerResponse(org.json.JSONObject jso)
                                 throws org.json.JSONException

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - a JSON packet received from the server

Throws:

org.json.JSONException - if the packet is malformed

dispatchError

private static void dispatchError(String source,
                                  String string,
                                  String optString,
                                  org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

source - WRITEME

string - WRITEME

optString - WRITEME

jso - WRITEME

dispatchSuccess

private static void dispatchSuccess(String source,
                                    org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

source - WRITEME

jso - WRITEME

from_addToList_err

public abstract void from_addToList_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_addToList_ok

public abstract void from_addToList_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_admin_err

public abstract void from_admin_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_admin_ok

public abstract void from_admin_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_avatars_err

public abstract void from_avatars_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_avatars_ok

public abstract void from_avatars_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_ayt_err

public abstract void from_ayt_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_ayt_ok

public abstract void from_ayt_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_badgeUpdate_err

public abstract void from_badgeUpdate_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_badgeUpdate_ok

public abstract void from_badgeUpdate_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_beam_err

public abstract void from_beam_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_beam_ok

public abstract void from_beam_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_bots_err

public abstract void from_bots_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_bots_ok

public abstract void from_bots_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_buddyList_err

public abstract void from_buddyList_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_buddyList_ok

public abstract void from_buddyList_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_buddyRequest_err

public abstract void from_buddyRequest_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_buddyRequest_ok

public abstract void from_buddyRequest_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_deleteMailMessage_err

public abstract void from_deleteMailMessage_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_deleteMailMessage_ok

public abstract void from_deleteMailMessage_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_earning_err

public abstract void from_earning_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_earning_ok

public abstract void from_earning_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_echo_err

public abstract void from_echo_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - WRITEME

from_echo_ok

public abstract void from_echo_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - WRITEME

from_endEvent_err

public abstract void from_endEvent_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_endEvent_ok

public abstract void from_endEvent_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_equip_ok

public abstract void from_equip_ok(org.json.JSONObject jso)

This message is sent whenever the user's equipment changes. Equipment is defined as items which are active (equipped, donned), which have either an ACTIVE or PASSIVE effect. This is sent as an unordered list (using a JSON array-type list) of all items which meet these criteria.

Note that receiving this message could mean either an item has been equipped or de-equipped, or that an item has changed; e.g. a change to its health or colour.

Parameters:

jso - the new equipment list as JSON array-type list object

from_finger_err

public abstract void from_finger_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_finger_ok

public abstract void from_finger_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_forceMove_err

public abstract void from_forceMove_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_forceMove_ok

public abstract void from_forceMove_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_gameAction_err

public abstract void from_gameAction_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_gameAction_ok

public abstract void from_gameAction_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getApple_err

public abstract void from_getApple_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getApple_ok

public abstract void from_getApple_ok(org.json.JSONObject jso)

The “apple” is the cookie used to perform password authentication. After you have requested the apple from the server, you will receive it back, here.

To proceed with your login request, perform the one-way hash of the password and submit the desired login packet to the server. See the server commands PreLoginCommands.do_login(JSONObject, AbstractUser, org.starhope.appius.game.Room) and PreLoginCommands.do_getApple(JSONObject, AbstractUser, org.starhope.appius.game.Room) for details.

This message will only be sent during prelogin mode.

Conforming clients must ignore this message after sending their login request.

Parameters:

jso - JSON object from the server WRITEME

from_getAvailableHouses_err

public abstract void from_getAvailableHouses_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getAvailableHouses_ok

public abstract void from_getAvailableHouses_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getAwardRankings_err

public abstract void from_getAwardRankings_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getAwardRankings_ok

public abstract void from_getAwardRankings_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getColorPalettes_err

public abstract void from_getColorPalettes_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getColorPalettes_ok

public abstract void from_getColorPalettes_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getInventoryItems_err

public abstract void from_getInventoryItems_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getInventoryItems_ok

public abstract void from_getInventoryItems_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getMailInBox_err

public abstract void from_getMailInBox_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getMailInBox_ok

public abstract void from_getMailInBox_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getMailMessage_err

public abstract void from_getMailMessage_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getMailMessage_ok

public abstract void from_getMailMessage_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getShopItems_err

public abstract void from_getShopItems_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getShopItems_ok

public abstract void from_getShopItems_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getStoreItems_err

public abstract void from_getStoreItems_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getStoreItems_ok

public abstract void from_getStoreItems_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getUserLists_err

public abstract void from_getUserLists_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getUserLists_ok

public abstract void from_getUserLists_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_getWallet_err

public abstract void from_getWallet_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - WRITEME

from_getWallet_ok

public abstract void from_getWallet_ok(org.json.JSONObject jso)

WRITEME

Parameters:

jso - from: getWallet, walletOwner: YOURNAME, currency: { "x-TvPn": 500.00 }

from_go_err

public abstract void from_go_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_go_ok

public abstract void from_go_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_gunList_err

public abstract void from_gunList_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_gunList_ok

public abstract void from_gunList_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_initUserRoom_err

public abstract void from_initUserRoom_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_initUserRoom(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_initUserRoom_ok

public abstract void from_initUserRoom_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_initUserRoom(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_inventory_err

public abstract void from_inventory_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_getInventory(JSONObject, AbstractUser, org.starhope.appius.game.Room)

from_inventory_ok

public abstract void from_inventory_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_getInventory(JSONObject, AbstractUser, org.starhope.appius.game.Room)

from_join_err

public abstract void from_join_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_join_ok

public abstract void from_join_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_migrate_err

public abstract void from_migrate_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_migrate_ok

public abstract void from_migrate_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_outOfBand_err

public abstract void from_outOfBand_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_sendOutOfBandMessage(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_outOfBand_ok

public abstract void from_outOfBand_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_sendOutOfBandMessage(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_pan_err

public abstract void from_pan_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_pan_ok

public abstract void from_pan_ok(org.json.JSONObject jso)

Pan the view to a given area. The new viewing region is determined by the coördinates given. Until a pan command is given, the default panning is { top: 0, left: 0, right: 799, bottom: 599 } (800×600). All further coördinates given are relative to this view-space, which the client must scale appropriately to their display.

Parameters:

jso - { top: INT, left: INT, right: INT, bottom: INT }

from_part_err

public abstract void from_part_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_part_ok

public abstract void from_part_ok(org.json.JSONObject jso)

Sent when any user (avatar) leaves the room. You should only receive this message for the room that you are in, however, you must accept (and ignore) part messages for other rooms. (This might typically occur when you are just moving from one room to another, and messages are received out of sequence.)

Remove the user from the room if the room ID number is your current room and the user is known to you.

Change in 1.1: the userName field was previously labeled as “user”

Parameters:

jso -

from

"part"

status

"true"

u

User ID number

userName

Avatar label

r

Room ID number

from_passport_err

public abstract void from_passport_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_passport_ok

public abstract void from_passport_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_playSound_ok

public abstract void from_playSound_ok(org.json.JSONObject jso)

Play a sound effect on the client

Parameters:

jso - { sound: SOUND-IDENTIFIER-STRING } or { url: SOUND-URL }

from_postman_err

public abstract void from_postman_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_postman_ok

public abstract void from_postman_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_prefs_err

public abstract void from_prefs_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_savePrefs(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_prefs_ok

public abstract void from_prefs_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_savePrefs(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_purchase_err

public abstract void from_purchase_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_purchase_ok

public abstract void from_purchase_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_reportBug_err

public abstract void from_reportBug_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_reportBug_ok

public abstract void from_reportBug_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_roomJoin_err

public abstract void from_roomJoin_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - WRITEME

from_roomJoin_ok

public abstract void from_roomJoin_ok(org.json.JSONObject jso)

Parameters:

jso - attributes: from: "roomJoin", status: "true", roomNumber: (room ID #), moniker: (room moniker), limbo: (true/false), users: (user-list, see from_wardrobe_ok(JSONObject)), bots: (see from_bots_ok(JSONObject)), vars: (room-variables), maxUsers: (number)

from_rv_err

public abstract void from_rv_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_rv_ok

public abstract void from_rv_ok(org.json.JSONObject jso)

Accept a room variable update.

Parameters:

jso - JSON object from the server containing the key:value

from_scoreUpdate_err

public abstract void from_scoreUpdate_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_scoreUpdate_ok

public abstract void from_scoreUpdate_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_sendMailMessage_err

public abstract void from_sendMailMessage_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_sendMailMessage_ok

public abstract void from_sendMailMessage_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_serverTime_err

public abstract void from_serverTime_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_serverTime_ok

public abstract void from_serverTime_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_serverTime(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_showInterface_ok

public abstract void from_showInterface_ok(org.json.JSONObject jso)

Display a particular client-side interface element

Parameters:

jso - { interface: INTERFACE-IDENTIFIER-STRING }

from_startEvent_err

public abstract void from_startEvent_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

Commands.do_serverTime(JSONObject, org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room)

from_startEvent_ok

public abstract void from_startEvent_ok(org.json.JSONObject jso)

WRITEME

Parameters:

jso - JSON object from the server WRITEME

from_uv_err

public abstract void from_uv_err(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_uv_ok

public abstract void from_uv_ok(org.json.JSONObject jso)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

jso - JSON object from the server WRITEME

from_wardrobe_err

public abstract void from_wardrobe_err(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

AbstractUser.getPublicInfo()

from_wardrobe_ok

public abstract void from_wardrobe_ok(org.json.JSONObject jso)

Parameters:

jso - JSON object from the server WRITEME

See Also:

AbstractUser.getPublicInfo()