org.starhope.appius.via
Class RemoteUser

java.lang.Object
  org.starhope.appius.via.RemoteUser

All Implemented Interfaces:

RoomListener, AbstractUser, ViaMunita<AbstractUser>

public class RemoteUser
extends Object
implements AbstractUser, ViaMunita<AbstractUser>

TODO: The documentation for this type (RemoteUser) is incomplete. (brpocock, Nov 5, 2009)

Author:

brpocock

Field Summary

private int	id WRITEME: document this field (brpocock, Jan 13, 2010) id (RemoteUser)
private static long	serialVersionUID TODO: document this field (brpocock, Nov 5, 2009) serialVersionUID (long)
private String	viaHostname WRITEME: document this field (brpocock, Jan 13, 2010) viaHostname (RemoteUser)
private int	viaPort WRITEME: document this field (brpocock, Jan 13, 2010) viaPort (RemoteUser)

Constructor Summary

RemoteUser(String host, int port, int userID)
WRITEME

Method Summary

void	acceptAdminMessage(AbstractRoom room, String string) This is an overriding method.
void	acceptAdminMessage(Integer room, String string) This is an overriding method.
void	acceptAdminMessage(String content, String title, String label) This is an overriding method.
void	acceptErrorReply(String command, String error, org.json.JSONObject result, AbstractRoom userCurrentRoomInZone) This is an overriding method.
void	acceptGameAction(AbstractUser u, org.json.JSONObject action) This is an overriding method.
void	acceptGameStateChange(GameEvent gameCode, GameStateFlag gameState) This is an overriding method.
void	acceptMessage(String string, String string2, String string3) This is an overriding method.
void	acceptObjectJoinRoom(AbstractRoom room, RoomListener object) This is an overriding method.
void	acceptObjectPartRoom(AbstractRoom room, RoomListener thing) This is an overriding method.
void	acceptOutOfBandMessage(AbstractUser sender, AbstractRoom room, org.json.JSONObject body) This is an overriding method.
void	acceptPublicMessage(AbstractUser sender, AbstractRoom room, String message) This is an overriding method.
void	acceptPublicMessage(AbstractUser from, String message) This is an overriding method.
void	acceptSuccessReply(AbstractZone zone, AbstractRoom room, String command, org.json.JSONObject jsonData) Deprecated.
void	acceptSuccessReply(String command, org.json.JSONObject jsonData, AbstractRoom room) This is an overriding method.
void	addBuddy(AbstractUser buddy) This is an overriding method.
void	addGiftSubscription(int i, int days) This is an overriding method.
void	addItem(int parseInt) This is an overriding method.
void	assertStaffLevel(int staffLevelStaffMember) This is an overriding method.
void	attend(AbstractUser byLogin) This is an overriding method.
void	ban(AbstractUser u, String banReason) This is an overriding method.
void	cancelEvent(int eventID) This is an overriding method.
boolean	canTalk() This is an overriding method.
void	doffClothes() This is an overriding method.
void	doTransport() This is an overriding method.
org.json.JSONObject	endEvent(int eventID, String moniker, BigDecimal score, String medal) This is an overriding method.
org.json.JSONObject	endMultiplayerEvent(Integer eventID, String gameMoniker, String string, BigDecimal playerScoreDecimal, LinkedHashMap<Integer,Integer> sortedScores) This is an overriding method.
Collection<org.starhope.appius.game.inventory.HomeDecorItem>	getActiveDecorations(int roomInHouse) This is an overriding method.
int	getAge() This is an overriding method.
String	getApprovedDateString() This is an overriding method.
AvatarClass	getAvatarClass() This is an overriding method.
String	getAvatarLabel() This is an overriding method.
Collection<String>	getBuddyListNames() This is an overriding method.
String	getDialect() This is an overriding method.
String	getDisplayName() This is an overriding method.
String	getFacing() This is an overriding method.
org.starhope.appius.game.inventory.HomeDecorItem	getFurnitureBySlot(int int1) This is an overriding method.
String	getIPAddress() This is an overriding method.
Collection<org.starhope.appius.game.inventory.InventoryItem>	getItemsByType(String typeString) This is an overriding method.
int	getKickedByUserID() This is an overriding method.
String	getKickedMessage() This is an overriding method.
String	getKickedReasonCode() This is an overriding method.
Timestamp	getKickedUntil() This is an overriding method.
String	getLanguage() This is an overriding method.
RoomAndZone	getLocation() This is an overriding method.
String	getMail() This is an overriding method.
Date	getNameApprovedAt() This is an overriding method.
Date	getNameRequestedAt() This is an overriding method.
org.json.JSONObject	getPublicInfo() This is an overriding method.
String	getRegisteredDateString() This is an overriding method.
String	getResponsibleMail() This is an overriding method.
AbstractRoom	getRoom() This is an overriding method.
int	getRoomNumber() This is an overriding method.
AppiusClaudiusCaecus	getServerThread() Always returns null.
int	getStaffLevel() This is an overriding method.
double	getTargetX() This is an overriding method.
double	getTargetY() This is an overriding method.
double	getTravelRate() This is an overriding method.
long	getTravelStart() This is an overriding method.
int	getUserID() This is an overriding method.
Map<String,String>	getUserVariables() This is an overriding method.
String	getVariable(String string) This is an overriding method.
String	getViaAppiaHostname() This is an overriding method.
String	getViaAppiaRemoteEndpointID() This is an overriding method.
int	getViaAppiaServerPort() This is an overriding method.
Class<AbstractUser>	getViaPeerClass()
double	getX() This is an overriding method.
double	getY() This is an overriding method.
AbstractZone	getZone() This is an overriding method.
boolean	hasStaffLevel(int i) This is an overriding method.
boolean	hasVariable(String string) This is an overriding method.
void	ignore(AbstractUser byLogin) This is an overriding method.
boolean	isBanned() This is an overriding method.
boolean	isCanceled() This is an overriding method.
boolean	isKicked() This is an overriding method.
boolean	isNPC() This is an overriding method.
boolean	isOnline() This is an overriding method.
boolean	isPaidMember() This is an overriding method.
void	kick(AbstractUser u, String kickReason, int duration) This is an overriding method.
void	liftBan(AbstractUser u) This is an overriding method.
void	notifyFurnitureInventory(AbstractRoom room) This is an overriding method.
void	removeBuddy(AbstractUser byLogin) This is an overriding method.
void	reportedToModeratorBy(AbstractUser u) This is an overriding method.
void	sendEarnings(AbstractRoom room, String string) This is an overriding method.
void	sendMigrate(AbstractZone refugeeZone) This is an overriding method.
void	sendOops() This is an overriding method.
void	sendResponse(org.json.JSONObject result) This is an overriding method.
void	sendUserLists() This is an overriding method.
void	sendWardrobe() This is an overriding method.
void	setAgeGroupToSystem() This is an overriding method.
void	setBaseColor(Colour colour) This is an overriding method.
void	setCanTalk(boolean b) This is an overriding method.
void	setExtraColor(Colour colour) This is an overriding method.
void	setLastActive() This is an overriding method.
void	setMail(String email) This is an overriding method.
int	setRoom(AbstractRoom room) This is an overriding method.
void	setStartT(long when) This is an overriding method.
void	setStructure(org.starhope.appius.game.inventory.HomeDecorItem item) This is an overriding method.
void	setTravelRate(double rate) This is an overriding method.
void	setVariable(String varName, String varValue) This is an overriding method.
void	setX(double x2) This is an overriding method.
void	setY(double y2) This is an overriding method.
void	speak(AbstractRoom room, String string) This is an overriding method.
org.json.JSONObject	startEvent(String gameMoniker) This is an overriding method.
org.json.JSONObject	toJSON() This is an overriding method.
String	toSFSXML() This is an overriding method.
void	wear(org.starhope.appius.game.inventory.ClothingItem asClothing) This is an overriding method.
void	wear(org.starhope.appius.game.inventory.ClothingItem asClothing, Colour colour) This is an overriding method.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

TODO: document this field (brpocock, Nov 5, 2009) serialVersionUID (long)

See Also:

Constant Field Values

id

private final int id

WRITEME: document this field (brpocock, Jan 13, 2010) id (RemoteUser)

viaHostname

private final String viaHostname

WRITEME: document this field (brpocock, Jan 13, 2010) viaHostname (RemoteUser)

viaPort

private final int viaPort

WRITEME: document this field (brpocock, Jan 13, 2010) viaPort (RemoteUser)

Constructor Detail

RemoteUser

public RemoteUser(String host,
                  int port,
                  int userID)
           throws DoNotCrossTheRubicon

WRITEME

Parameters:

host - remote hostname or address

port - remote server port number

userID - user ID number

Throws:

DoNotCrossTheRubicon - if the remote object can't be fetched

Method Detail

acceptAdminMessage

public void acceptAdminMessage(AbstractRoom room,
                               String string)

This is an overriding method.

Specified by:

acceptAdminMessage in interface AbstractUser

Parameters:

room - The room in which the administrative message is being sent (often ignored)

string - The administrative message.

See Also:

AbstractUser.acceptAdminMessage(org.starhope.appius.game.AbstractRoom, java.lang.String)

acceptAdminMessage

public void acceptAdminMessage(Integer room,
                               String string)

This is an overriding method.

Specified by:

acceptAdminMessage in interface AbstractUser

Parameters:

room - The room in which the administrative message is being sent (often ignored)

string - The administrative message.

See Also:

AbstractUser.acceptAdminMessage(java.lang.Integer, java.lang.String)

acceptAdminMessage

public void acceptAdminMessage(String content,
                               String title,
                               String label)

This is an overriding method.

Specified by:

acceptAdminMessage in interface AbstractUser

Parameters:

content - WRITEME

title - WRITEME

label - WRITEME

See Also:

AbstractUser.acceptAdminMessage(java.lang.String, java.lang.String, java.lang.String)

acceptErrorReply

public void acceptErrorReply(String command,
                             String error,
                             org.json.JSONObject result,
                             AbstractRoom userCurrentRoomInZone)

This is an overriding method.

Specified by:

acceptErrorReply in interface AbstractUser

Parameters:

command - WRITEME

error - WRITEME

result - WRITEME

userCurrentRoomInZone - WRITEME

See Also:

AbstractUser.acceptErrorReply(java.lang.String, java.lang.String, org.json.JSONObject, org.starhope.appius.game.AbstractRoom)

acceptGameAction

public void acceptGameAction(AbstractUser u,
                             org.json.JSONObject action)

This is an overriding method.

Specified by:

acceptGameAction in interface RoomListener

Parameters:

u - the sender

action - The game action. The verb is in action.getString("action").

See Also:

RoomListener.acceptGameAction(org.starhope.appius.user.AbstractUser, org.json.JSONObject)

acceptGameStateChange

public void acceptGameStateChange(GameEvent gameCode,
                                  GameStateFlag gameState)

This is an overriding method.

Specified by:

acceptGameStateChange in interface RoomListener

Parameters:

gameCode - The GameEvent whose state is changing

gameState - The new state

See Also:

RoomListener.acceptGameStateChange(org.starhope.appius.game.GameEvent, org.starhope.appius.game.GameStateFlag)

acceptMessage

public void acceptMessage(String string,
                          String string2,
                          String string3)

This is an overriding method.

Specified by:

acceptMessage in interface AbstractUser

Parameters:

string - WRITEME

string2 - WRITEME

string3 - WRITEME

See Also:

AbstractUser.acceptMessage(java.lang.String, java.lang.String, java.lang.String)

acceptObjectJoinRoom

public void acceptObjectJoinRoom(AbstractRoom room,
                                 RoomListener object)

This is an overriding method.

Specified by:

acceptObjectJoinRoom in interface RoomListener

Parameters:

room - The room

object - The thing (probably user) entering

See Also:

RoomListener.acceptObjectJoinRoom(org.starhope.appius.game.AbstractRoom, org.starhope.appius.game.RoomListener)

acceptObjectPartRoom

public void acceptObjectPartRoom(AbstractRoom room,
                                 RoomListener thing)

This is an overriding method.

Specified by:

acceptObjectPartRoom in interface RoomListener

Parameters:

room - The room

thing - The thing (probably user) departing

See Also:

RoomListener.acceptObjectPartRoom(org.starhope.appius.game.AbstractRoom, org.starhope.appius.game.RoomListener)

acceptOutOfBandMessage

public void acceptOutOfBandMessage(AbstractUser sender,
                                   AbstractRoom room,
                                   org.json.JSONObject body)

This is an overriding method.

Specified by:

acceptOutOfBandMessage in interface RoomListener

Parameters:

sender - The sender of the OOB message

room - The room in which the OOB message is being broadcast

body - A JSON object containing the OOB message. The contents of this message are not constrained.

See Also:

RoomListener.acceptOutOfBandMessage(org.starhope.appius.user.AbstractUser, org.starhope.appius.game.AbstractRoom, org.json.JSONObject)

acceptPublicMessage

public void acceptPublicMessage(AbstractUser sender,
                                AbstractRoom room,
                                String message)

This is an overriding method.

Specified by:

acceptPublicMessage in interface RoomListener

Parameters:

sender - The speaker

room - The room in which the words were spoken

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(org.starhope.appius.user.AbstractUser, org.starhope.appius.game.AbstractRoom, java.lang.String)

acceptPublicMessage

public void acceptPublicMessage(AbstractUser from,
                                String message)

This is an overriding method.

Specified by:

acceptPublicMessage in interface RoomListener

Parameters:

from - The speaker

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(org.starhope.appius.user.AbstractUser, java.lang.String)

acceptSuccessReply

@Deprecated
public void acceptSuccessReply(AbstractZone zone,
                                          AbstractRoom room,
                                          String command,
                                          org.json.JSONObject jsonData)

Deprecated.

This is an overriding method.

Specified by:

acceptSuccessReply in interface AbstractUser

Parameters:

zone - WRITEME

room - WRITEME

command - WRITEME

jsonData - WRITEME

See Also:

AbstractUser.acceptSuccessReply(org.starhope.appius.types.AbstractZone, org.starhope.appius.game.AbstractRoom, java.lang.String, org.json.JSONObject)

acceptSuccessReply

public void acceptSuccessReply(String command,
                               org.json.JSONObject jsonData,
                               AbstractRoom room)

This is an overriding method.

Specified by:

acceptSuccessReply in interface AbstractUser

Parameters:

command - WRITEME

jsonData - WRITEME

room - WRITEME

See Also:

AbstractUser.acceptSuccessReply(java.lang.String, org.json.JSONObject, org.starhope.appius.game.AbstractRoom)

addBuddy

public void addBuddy(AbstractUser buddy)

This is an overriding method.

Specified by:

addBuddy in interface AbstractUser

Parameters:

buddy - WRITEME

See Also:

AbstractUser.addBuddy(org.starhope.appius.user.AbstractUser)

addGiftSubscription

public void addGiftSubscription(int i,
                                int days)

This is an overriding method.

Specified by:

addGiftSubscription in interface AbstractUser

Parameters:

i - WRITEME

days - WRITEME

See Also:

AbstractUser.addGiftSubscription(int, int)

addItem

public void addItem(int parseInt)

This is an overriding method.

Specified by:

addItem in interface AbstractUser

Parameters:

parseInt - WRITEME

See Also:

AbstractUser.addItem(int)

assertStaffLevel

public void assertStaffLevel(int staffLevelStaffMember)
                      throws PrivilegeRequiredException

This is an overriding method.

Specified by:

assertStaffLevel in interface AbstractUser

Parameters:

staffLevelStaffMember - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.assertStaffLevel(int)

attend

public void attend(AbstractUser byLogin)

This is an overriding method.

Specified by:

attend in interface AbstractUser

Parameters:

byLogin - WRITEME

See Also:

AbstractUser.attend(org.starhope.appius.user.AbstractUser)

ban

public void ban(AbstractUser u,
                String banReason)
         throws PrivilegeRequiredException

This is an overriding method.

Specified by:

ban in interface AbstractUser

Parameters:

u - WRITEME

banReason - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.ban(org.starhope.appius.user.AbstractUser, java.lang.String)

cancelEvent

public void cancelEvent(int eventID)

This is an overriding method.

Specified by:

cancelEvent in interface AbstractUser

Parameters:

eventID - the ID returned from startEvent

See Also:

AbstractUser.cancelEvent(int)

canTalk

public boolean canTalk()

This is an overriding method.

Specified by:

canTalk in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.canTalk()

doffClothes

public void doffClothes()

This is an overriding method.

Specified by:

doffClothes in interface AbstractUser

See Also:

AbstractUser.doffClothes()

doTransport

public void doTransport()

This is an overriding method.

Specified by:

doTransport in interface AbstractUser

See Also:

AbstractUser.doTransport()

endEvent

public org.json.JSONObject endEvent(int eventID,
                                    String moniker,
                                    BigDecimal score,
                                    String medal)
                             throws org.json.JSONException

This is an overriding method.

Specified by:

endEvent in interface AbstractUser

Parameters:

eventID - the ID returned from startEvent

moniker - the event's moniker

score - the user's score

medal - any medal earned

Returns:

results of ending the event WRITEME

Throws:

org.json.JSONException - WRITEME

See Also:

AbstractUser.endEvent(int, java.lang.String, java.math.BigDecimal, java.lang.String)

endMultiplayerEvent

public org.json.JSONObject endMultiplayerEvent(Integer eventID,
                                               String gameMoniker,
                                               String string,
                                               BigDecimal playerScoreDecimal,
                                               LinkedHashMap<Integer,Integer> sortedScores)
                                        throws org.json.JSONException

This is an overriding method.

Specified by:

endMultiplayerEvent in interface AbstractUser

Parameters:

eventID - WRITEME

gameMoniker - WRITEME

string - WRITEME

playerScoreDecimal - WRITEME

sortedScores - WRITEME

Returns:

WRITEME

Throws:

org.json.JSONException - WRITEME

See Also:

AbstractUser.endMultiplayerEvent(java.lang.Integer, java.lang.String, java.lang.String, java.math.BigDecimal, java.util.LinkedHashMap)

getActiveDecorations

public Collection<org.starhope.appius.game.inventory.HomeDecorItem> getActiveDecorations(int roomInHouse)
                                                                                  throws NotFoundException

This is an overriding method.

Specified by:

getActiveDecorations in interface AbstractUser

Parameters:

roomInHouse - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

See Also:

AbstractUser.getActiveDecorations(int)

getAge

public int getAge()

This is an overriding method.

Specified by:

getAge in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getAge()

getApprovedDateString

public String getApprovedDateString()

This is an overriding method.

Specified by:

getApprovedDateString in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getApprovedDateString()

getAvatarClass

public AvatarClass getAvatarClass()

This is an overriding method.

Specified by:

getAvatarClass in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getAvatarClass()

getAvatarLabel

public String getAvatarLabel()

This is an overriding method.

Specified by:

getAvatarLabel in interface AbstractUser

Returns:

The avatar label

See Also:

AbstractUser.getAvatarLabel()

getBuddyListNames

public Collection<String> getBuddyListNames()

This is an overriding method.

Specified by:

getBuddyListNames in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getBuddyListNames()

getDialect

public String getDialect()

This is an overriding method.

Specified by:

getDialect in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getDialect()

getDisplayName

public String getDisplayName()

This is an overriding method.

Specified by:

getDisplayName in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getDisplayName()

getFacing

public String getFacing()

This is an overriding method.

Specified by:

getFacing in interface AbstractUser

Returns:

The facing direction of this object

See Also:

AbstractUser.getFacing()

getFurnitureBySlot

public org.starhope.appius.game.inventory.HomeDecorItem getFurnitureBySlot(int int1)
                                                                    throws NotFoundException

This is an overriding method.

Specified by:

getFurnitureBySlot in interface AbstractUser

Parameters:

int1 - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

See Also:

AbstractUser.getFurnitureBySlot(int)

getIPAddress

public String getIPAddress()

This is an overriding method.

Specified by:

getIPAddress in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getIPAddress()

getItemsByType

public Collection<org.starhope.appius.game.inventory.InventoryItem> getItemsByType(String typeString)

This is an overriding method.

Specified by:

getItemsByType in interface AbstractUser

Parameters:

typeString - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getItemsByType(java.lang.String)

getKickedByUserID

public int getKickedByUserID()

This is an overriding method.

Specified by:

getKickedByUserID in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getKickedByUserID()

getKickedMessage

public String getKickedMessage()

This is an overriding method.

Specified by:

getKickedMessage in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getKickedMessage()

getKickedReasonCode

public String getKickedReasonCode()

This is an overriding method.

Specified by:

getKickedReasonCode in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getKickedReasonCode()

getKickedUntil

public Timestamp getKickedUntil()

This is an overriding method.

Specified by:

getKickedUntil in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getKickedUntil()

getLanguage

public String getLanguage()

This is an overriding method.

Specified by:

getLanguage in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getLanguage()

getLocation

public RoomAndZone getLocation()

This is an overriding method.

Specified by:

getLocation in interface RoomListener

Returns:

WRITEME

See Also:

RoomListener.getLocation()

getMail

public String getMail()

This is an overriding method.

Specified by:

getMail in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getMail()

getNameApprovedAt

public Date getNameApprovedAt()

This is an overriding method.

Specified by:

getNameApprovedAt in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getNameApprovedAt()

getNameRequestedAt

public Date getNameRequestedAt()

This is an overriding method.

Specified by:

getNameRequestedAt in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getNameRequestedAt()

getPublicInfo

public org.json.JSONObject getPublicInfo()

This is an overriding method.

Specified by:

getPublicInfo in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getPublicInfo()

getRegisteredDateString

public String getRegisteredDateString()

This is an overriding method.

Specified by:

getRegisteredDateString in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getRegisteredDateString()

getResponsibleMail

public String getResponsibleMail()

This is an overriding method.

Specified by:

getResponsibleMail in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getResponsibleMail()

getRoom

public AbstractRoom getRoom()

This is an overriding method.

Specified by:

getRoom in interface RoomListener

Returns:

the Room in which this NPC can be found. This can be null.

See Also:

RoomListener.getRoom()

getRoomNumber

public int getRoomNumber()

This is an overriding method.

Specified by:

getRoomNumber in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getRoomNumber()

getServerThread

public AppiusClaudiusCaecus getServerThread()

Always returns null.

Specified by:

getServerThread in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getServerThread()

getStaffLevel

public int getStaffLevel()

This is an overriding method.

Specified by:

getStaffLevel in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getStaffLevel()

getTargetX

public double getTargetX()

This is an overriding method.

Specified by:

getTargetX in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getTargetX()

getTargetY

public double getTargetY()

This is an overriding method.

Specified by:

getTargetY in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getTargetY()

getTravelRate

public double getTravelRate()

This is an overriding method.

Specified by:

getTravelRate in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getTravelRate()

getTravelStart

public long getTravelStart()

This is an overriding method.

Specified by:

getTravelStart in interface AbstractUser

Returns:

the time at which the object started moving (msec since epoch)

See Also:

AbstractUser.getTravelStart()

getUserID

public int getUserID()

This is an overriding method.

Specified by:

getUserID in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getUserID()

getUserVariables

public Map<String,String> getUserVariables()

This is an overriding method.

Specified by:

getUserVariables in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getUserVariables()

getVariable

public String getVariable(String string)

This is an overriding method.

Specified by:

getVariable in interface AbstractUser

Parameters:

string - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getVariable(java.lang.String)

getViaAppiaHostname

public String getViaAppiaHostname()

This is an overriding method.

Specified by:

getViaAppiaHostname in interface ViaMunita<AbstractUser>

Returns:

The hostname of the Via Appia peer (Appius server) on which the remote object is actually located

See Also:

ViaMunita.getViaAppiaHostname()

getViaAppiaRemoteEndpointID

public String getViaAppiaRemoteEndpointID()

This is an overriding method.

Specified by:

getViaAppiaRemoteEndpointID in interface ViaMunita<AbstractUser>

Returns:

The object endpoint code of the Via Appia peer (Appius server) on which the remote object is actually located

See Also:

ViaMunita.getViaAppiaRemoteEndpointID()

getViaAppiaServerPort

public int getViaAppiaServerPort()

This is an overriding method.

Specified by:

getViaAppiaServerPort in interface ViaMunita<AbstractUser>

Returns:

The port number of the Via Appia peer (Appius server) on which the remote object is actually located

See Also:

ViaMunita.getViaAppiaServerPort()

getViaPeerClass

public Class<AbstractUser> getViaPeerClass()

Specified by:

getViaPeerClass in interface ViaMunita<AbstractUser>

Returns:

the class of the ViaAppia peer. This is a hack to obtain the generic type equivalences stuff for the implementers, and can probably be factored out if I get smarter about reflection and generics.

See Also:

ViaMunita.getViaPeerClass()

getX

public double getX()

This is an overriding method.

Specified by:

getX in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getX()

getY

public double getY()

This is an overriding method.

Specified by:

getY in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.getY()

getZone

public AbstractZone getZone()

This is an overriding method.

Specified by:

getZone in interface RoomListener

Returns:

the Zone in which this NPC can be found

See Also:

RoomListener.getZone()

hasStaffLevel

public boolean hasStaffLevel(int i)

This is an overriding method.

Specified by:

hasStaffLevel in interface AbstractUser

Parameters:

i - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.hasStaffLevel(int)

hasVariable

public boolean hasVariable(String string)

This is an overriding method.

Specified by:

hasVariable in interface AbstractUser

Parameters:

string - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.hasVariable(java.lang.String)

ignore

public void ignore(AbstractUser byLogin)

This is an overriding method.

Specified by:

ignore in interface AbstractUser

Parameters:

byLogin - WRITEME

See Also:

AbstractUser.ignore(org.starhope.appius.user.AbstractUser)

isBanned

public boolean isBanned()

This is an overriding method.

Specified by:

isBanned in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isBanned()

isCanceled

public boolean isCanceled()

This is an overriding method.

Specified by:

isCanceled in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isCanceled()

isKicked

public boolean isKicked()

This is an overriding method.

Specified by:

isKicked in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isKicked()

isNPC

public boolean isNPC()

This is an overriding method.

Specified by:

isNPC in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isNPC()

isOnline

public boolean isOnline()

This is an overriding method.

Specified by:

isOnline in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isOnline()

isPaidMember

public boolean isPaidMember()

This is an overriding method.

Specified by:

isPaidMember in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.isPaidMember()

kick

public void kick(AbstractUser u,
                 String kickReason,
                 int duration)
          throws PrivilegeRequiredException

This is an overriding method.

Specified by:

kick in interface AbstractUser

Parameters:

u - WRITEME

kickReason - WRITEME

duration - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.kick(org.starhope.appius.user.AbstractUser, java.lang.String, int)

liftBan

public void liftBan(AbstractUser u)
             throws PrivilegeRequiredException

This is an overriding method.

Specified by:

liftBan in interface AbstractUser

Parameters:

u - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.liftBan(AbstractUser u)

notifyFurnitureInventory

public void notifyFurnitureInventory(AbstractRoom room)

This is an overriding method.

Specified by:

notifyFurnitureInventory in interface AbstractUser

Parameters:

room - WRITEME

See Also:

AbstractUser.notifyFurnitureInventory(org.starhope.appius.game.AbstractRoom)

removeBuddy

public void removeBuddy(AbstractUser byLogin)

This is an overriding method.

Specified by:

removeBuddy in interface AbstractUser

Parameters:

byLogin - WRITEME

See Also:

AbstractUser.removeBuddy(org.starhope.appius.user.AbstractUser)

reportedToModeratorBy

public void reportedToModeratorBy(AbstractUser u)

This is an overriding method.

Specified by:

reportedToModeratorBy in interface AbstractUser

Parameters:

u - WRITEME

See Also:

AbstractUser.reportedToModeratorBy(org.starhope.appius.user.AbstractUser)

sendEarnings

public void sendEarnings(AbstractRoom room,
                         String string)

This is an overriding method.

Specified by:

sendEarnings in interface AbstractUser

Parameters:

room - WRITEME

string - WRITEME

See Also:

AbstractUser.sendEarnings(org.starhope.appius.game.AbstractRoom, java.lang.String)

sendMigrate

public void sendMigrate(AbstractZone refugeeZone)
                 throws UserDeadException

This is an overriding method.

Specified by:

sendMigrate in interface AbstractUser

Parameters:

refugeeZone - WRITEME

Throws:

UserDeadException - WRITEME

See Also:

AbstractUser.sendMigrate(org.starhope.appius.types.AbstractZone)

sendOops

public void sendOops()

This is an overriding method.

Specified by:

sendOops in interface AbstractUser

See Also:

AbstractUser.sendOops()

sendResponse

public void sendResponse(org.json.JSONObject result)

This is an overriding method.

Specified by:

sendResponse in interface AbstractUser

Parameters:

result - WRITEME

See Also:

AbstractUser.sendResponse(org.json.JSONObject)

sendUserLists

public void sendUserLists()

This is an overriding method.

Specified by:

sendUserLists in interface AbstractUser

See Also:

AbstractUser.sendUserLists()

sendWardrobe

public void sendWardrobe()

This is an overriding method.

Specified by:

sendWardrobe in interface AbstractUser

See Also:

AbstractUser.sendWardrobe()

setAgeGroupToSystem

public void setAgeGroupToSystem()

This is an overriding method.

Specified by:

setAgeGroupToSystem in interface AbstractUser

See Also:

AbstractUser.setAgeGroupToSystem()

setBaseColor

public void setBaseColor(Colour colour)

This is an overriding method.

Specified by:

setBaseColor in interface AbstractUser

Parameters:

colour - WRITEME

See Also:

AbstractUser.setBaseColor(org.starhope.appius.types.Colour)

setCanTalk

public void setCanTalk(boolean b)

This is an overriding method.

Specified by:

setCanTalk in interface AbstractUser

Parameters:

b - WRITEME

See Also:

AbstractUser.setCanTalk(boolean)

setExtraColor

public void setExtraColor(Colour colour)

This is an overriding method.

Specified by:

setExtraColor in interface AbstractUser

Parameters:

colour - WRITEME

See Also:

AbstractUser.setExtraColor(org.starhope.appius.types.Colour)

setLastActive

public void setLastActive()

This is an overriding method.

Specified by:

setLastActive in interface AbstractUser

See Also:

AbstractUser.setLastActive()

setMail

public void setMail(String email)
             throws GameLogicException

This is an overriding method.

Specified by:

setMail in interface AbstractUser

Parameters:

email - WRITEME

Throws:

GameLogicException - WRITEME

See Also:

AbstractUser.setMail(java.lang.String)

setRoom

public int setRoom(AbstractRoom room)

This is an overriding method.

Specified by:

setRoom in interface AbstractUser

Parameters:

room - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.setRoom(org.starhope.appius.game.AbstractRoom)

setStartT

public void setStartT(long when)

This is an overriding method.

Specified by:

setStartT in interface AbstractUser

Parameters:

when - WRITEME

See Also:

AbstractUser.setStartT(long)

setStructure

public void setStructure(org.starhope.appius.game.inventory.HomeDecorItem item)

This is an overriding method.

Specified by:

setStructure in interface AbstractUser

Parameters:

item - WRITEME

See Also:

AbstractUser.setStructure(org.starhope.appius.game.inventory.HomeDecorItem)

setTravelRate

public void setTravelRate(double rate)

This is an overriding method.

Specified by:

setTravelRate in interface AbstractUser

Parameters:

rate - WRITEME

See Also:

AbstractUser.setTravelRate(double)

setVariable

public void setVariable(String varName,
                        String varValue)

This is an overriding method.

Specified by:

setVariable in interface AbstractUser

Parameters:

varName - WRITEME

varValue - WRITEME

See Also:

AbstractUser.setVariable(java.lang.String, java.lang.String)

setX

public void setX(double x2)

This is an overriding method.

Specified by:

setX in interface AbstractUser

Parameters:

x2 - WRITEME

See Also:

AbstractUser.setX(double)

setY

public void setY(double y2)

This is an overriding method.

Specified by:

setY in interface AbstractUser

Parameters:

y2 - WRITEME

See Also:

AbstractUser.setY(double)

speak

public void speak(AbstractRoom room,
                  String string)

This is an overriding method.

Specified by:

speak in interface AbstractUser

Parameters:

room - WRITEME

string - WRITEME

See Also:

AbstractUser.speak(org.starhope.appius.game.AbstractRoom, java.lang.String)

startEvent

public org.json.JSONObject startEvent(String gameMoniker)

This is an overriding method.

Specified by:

startEvent in interface AbstractUser

Parameters:

gameMoniker - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.startEvent(java.lang.String)

toJSON

public org.json.JSONObject toJSON()

This is an overriding method.

Specified by:

toJSON in interface AbstractUser

Returns:

WRITEME WRITEME

See Also:

AbstractUser.toJSON()

toSFSXML

public String toSFSXML()

This is an overriding method.

Specified by:

toSFSXML in interface AbstractUser

Returns:

WRITEME

See Also:

AbstractUser.toSFSXML()

wear

public void wear(org.starhope.appius.game.inventory.ClothingItem asClothing)

This is an overriding method.

Specified by:

wear in interface AbstractUser

Parameters:

asClothing - WRITEME

See Also:

AbstractUser.wear(org.starhope.appius.game.inventory.ClothingItem)

wear

public void wear(org.starhope.appius.game.inventory.ClothingItem asClothing,
                 Colour colour)

This is an overriding method.

Specified by:

wear in interface AbstractUser

Parameters:

asClothing - WRITEME

colour - WRITEME

See Also:

AbstractUser.wear(org.starhope.appius.game.inventory.ClothingItem, org.starhope.appius.types.Colour)