org.starhope.appius.user
Interface AbstractUser

All Superinterfaces:

RoomListener

All Known Subinterfaces:

TrainCar

All Known Implementing Classes:

AbstractNonPlayerCharacter, AbstractScriptedNPC, LuaNPC, PerlNPC, PythonNPC, RemoteUser, RubyNPC, User

public interface AbstractUser
extends RoomListener

Any “thing” that exists in the game world and participates therein should implement the AbstractUser interface. This interface provides the “physicality” (no, that's not a word) necessary for something to participate in the game rooms.

Author:

brpocock

Method Summary

void	acceptAdminMessage(AbstractRoom room, String string)
void	acceptAdminMessage(Integer room, String string) Accept a message from an administrator or the system.
void	acceptAdminMessage(String content, String title, String label) TODO: document this method (brpocock, Jan 11, 2010)
void	acceptErrorReply(String command, String error, org.json.JSONObject result, AbstractRoom userCurrentRoomInZone)
void	acceptMessage(String string, String string2, String string3)
void	acceptSuccessReply(AbstractZone zone, AbstractRoom room, String command, org.json.JSONObject jsonData) Deprecated. use acceptSuccessReply( String, JSONObject,AbstractRoom); zone is unnecessary
void	acceptSuccessReply(String command, org.json.JSONObject jsonData, AbstractRoom room)
void	addBuddy(AbstractUser buddy)
void	addGiftSubscription(int i, int days)
void	addItem(int parseInt)
void	assertStaffLevel(int staffLevelStaffMember)
void	attend(AbstractUser byLogin)
void	ban(AbstractUser u, String banReason)
void	cancelEvent(int eventID) TODO: document this method (brpocock, Jan 15, 2010)
boolean	canTalk()
void	doffClothes() WRITEME
void	doTransport() WRITEME
org.json.JSONObject	endEvent(int eventID, String moniker, BigDecimal score, String medal) WRITEME: document this method (brpocock, Jan 15, 2010)
org.json.JSONObject	endMultiplayerEvent(Integer eventID, String gameMoniker, String string, BigDecimal playerScoreDecimal, LinkedHashMap<Integer,Integer> sortedScores)
Collection<org.starhope.appius.game.inventory.HomeDecorItem>	getActiveDecorations(int roomInHouse)
int	getAge()
String	getApprovedDateString()
AvatarClass	getAvatarClass()
String	getAvatarLabel() The avatar label is the text block that is displayed with the avatar for this object.
Collection<String>	getBuddyListNames() TODO: document this method (brpocock, Jan 11, 2010)
String	getDialect()
String	getDisplayName()
String	getFacing() Get the string identifying the direction which this object is facing.
org.starhope.appius.game.inventory.HomeDecorItem	getFurnitureBySlot(int int1)
String	getIPAddress()
Collection<org.starhope.appius.game.inventory.InventoryItem>	getItemsByType(String typeString)
int	getKickedByUserID()
String	getKickedMessage()
String	getKickedReasonCode()
Timestamp	getKickedUntil() String?? TODO? FIXME?
String	getLanguage()
String	getMail()
Date	getNameApprovedAt()
Date	getNameRequestedAt()
org.json.JSONObject	getPublicInfo() TODO: document this method (brpocock, Oct 31, 2009) avatar, userName, clothes, colors
String	getRegisteredDateString()
String	getResponsibleMail()
int	getRoomNumber() TODO: document this method (brpocock, Jan 11, 2010)
AppiusClaudiusCaecus	getServerThread()
int	getStaffLevel() TODO: document this method (brpocock, Jan 11, 2010)
double	getTargetX() TODO: document this method (brpocock, Oct 31, 2009)
double	getTargetY() TODO: document this method (brpocock, Oct 31, 2009)
double	getTravelRate() TODO: document this method (brpocock, Nov 24, 2009)
long	getTravelStart() TODO: document this method (brpocock, Nov 24, 2009)
int	getUserID() TODO: document this method (brpocock, Oct 31, 2009)
Map<String,String>	getUserVariables() TODO: document this method (brpocock, Jan 11, 2010)
String	getVariable(String string) TODO: document this method (brpocock, Oct 31, 2009)
double	getX() TODO: document this method (brpocock, Oct 31, 2009)
double	getY() TODO: document this method (brpocock, Oct 31, 2009)
boolean	hasStaffLevel(int i)
boolean	hasVariable(String string) TODO: document this method (brpocock, Nov 30, 2009)
void	ignore(AbstractUser byLogin)
boolean	isBanned()
boolean	isCanceled()
boolean	isKicked()
boolean	isNPC() TODO: document this method (brpocock, Oct 31, 2009)
boolean	isOnline() TODO: document this method (brpocock, Oct 31, 2009)
boolean	isPaidMember()
void	kick(AbstractUser u, String kickReason, int duration)
void	liftBan(AbstractUser authority) WRITEME
void	notifyFurnitureInventory(AbstractRoom room)
void	removeBuddy(AbstractUser byLogin)
void	reportedToModeratorBy(AbstractUser u)
void	sendEarnings(AbstractRoom room, String string)
void	sendMigrate(AbstractZone refugeeZone) TODO: document this method (brpocock, Jan 11, 2010)
void	sendOops() WRITEME
void	sendResponse(org.json.JSONObject result)
void	sendUserLists() Sends the user an asynchronous notification of their user lists' status.
void	sendWardrobe()
void	setAgeGroupToSystem() WRITEME
void	setBaseColor(Colour colour)
void	setCanTalk(boolean b)
void	setExtraColor(Colour colour)
void	setLastActive() WRITEME
void	setMail(String email)
int	setRoom(AbstractRoom room)
void	setStartT(long when) TODO: document this method (brpocock, Nov 24, 2009)
void	setStructure(org.starhope.appius.game.inventory.HomeDecorItem item)
void	setTravelRate(double rate) TODO: document this method (brpocock, Nov 24, 2009)
void	setVariable(String varName, String varValue)
void	setX(double x2) TODO: document this method (brpocock, Nov 24, 2009)
void	setY(double y2) TODO: document this method (brpocock, Nov 24, 2009)
void	speak(AbstractRoom room, String string)
org.json.JSONObject	startEvent(String gameMoniker)
org.json.JSONObject	toJSON() TODO: document this method (brpocock, Jan 11, 2010)
String	toSFSXML() TODO: document this method (brpocock, Oct 31, 2009)
void	wear(org.starhope.appius.game.inventory.ClothingItem asClothing)
void	wear(org.starhope.appius.game.inventory.ClothingItem asClothing, Colour colour)

Methods inherited from interface org.starhope.appius.game.RoomListener

acceptGameAction, acceptGameStateChange, acceptObjectJoinRoom, acceptObjectPartRoom, acceptOutOfBandMessage, acceptPublicMessage, acceptPublicMessage, getLocation, getRoom, getZone

Method Detail

acceptAdminMessage

void acceptAdminMessage(AbstractRoom room,
                        String string)

Parameters:

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

string - The administrative message.

See Also:

acceptAdminMessage(Integer, String)

acceptAdminMessage

void acceptAdminMessage(Integer room,
                        String string)

Accept a message from an administrator or the system. If the user is connected, propagate that message to their client.

Parameters:

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

string - The administrative message.

acceptAdminMessage

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

TODO: document this method (brpocock, Jan 11, 2010)

Parameters:

content - WRITEME

title - WRITEME

label - WRITEME

acceptErrorReply

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

Parameters:

command - WRITEME

error - WRITEME

result - WRITEME

userCurrentRoomInZone - WRITEME

acceptMessage

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

Parameters:

string - WRITEME

string2 - WRITEME

string3 - WRITEME

acceptSuccessReply

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

Deprecated. use acceptSuccessReply( String, JSONObject,AbstractRoom); zone is unnecessary

Parameters:

zone - WRITEME

room - WRITEME

command - WRITEME

jsonData - WRITEME

acceptSuccessReply

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

Parameters:

room - WRITEME

command - WRITEME

jsonData - WRITEME

addBuddy

void addBuddy(AbstractUser buddy)

Parameters:

buddy - WRITEME

addGiftSubscription

void addGiftSubscription(int i,
                         int days)

Parameters:

i - WRITEME

days - WRITEME

addItem

void addItem(int parseInt)

Parameters:

parseInt - WRITEME

assertStaffLevel

void assertStaffLevel(int staffLevelStaffMember)
                      throws PrivilegeRequiredException

Parameters:

staffLevelStaffMember - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

attend

void attend(AbstractUser byLogin)

Parameters:

byLogin - WRITEME

ban

void ban(AbstractUser u,
         String banReason)
         throws PrivilegeRequiredException

Parameters:

u - WRITEME

banReason - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

cancelEvent

void cancelEvent(int eventID)

TODO: document this method (brpocock, Jan 15, 2010)

Parameters:

eventID - the ID returned from startEvent

canTalk

boolean canTalk()

Returns:

WRITEME

doffClothes

void doffClothes()

WRITEME

doTransport

void doTransport()

WRITEME

endEvent

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

WRITEME: document this method (brpocock, Jan 15, 2010)

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

endMultiplayerEvent

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

Parameters:

eventID - WRITEME

gameMoniker - WRITEME

string - WRITEME

playerScoreDecimal - WRITEME

sortedScores - WRITEME

Returns:

WRITEME

Throws:

org.json.JSONException - WRITEME

getActiveDecorations

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

Parameters:

roomInHouse - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

getAge

int getAge()

Returns:

WRITEME

getApprovedDateString

String getApprovedDateString()

Returns:

WRITEME

getAvatarClass

AvatarClass getAvatarClass()

Returns:

WRITEME

getAvatarLabel

String getAvatarLabel()

The avatar label is the text block that is displayed with the avatar for this object. It should be unique but isn't guaranteed to be distinct as user names are. (At any given moment, there can be only one object with a given avatar label in the room, but there can be only one user with a given name in the multiverse.) For users, this is the user name.

Returns:

The avatar label

getBuddyListNames

Collection<String> getBuddyListNames()

TODO: document this method (brpocock, Jan 11, 2010)

Returns:

WRITEME

getDialect

String getDialect()

Returns:

WRITEME

getDisplayName

String getDisplayName()

Returns:

WRITEME

getFacing

String getFacing()

Get the string identifying the direction which this object is facing. One of: N,S,E,W,NE,NW,SW,SE.

Returns:

The facing direction of this object

getFurnitureBySlot

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

Parameters:

int1 - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

getIPAddress

String getIPAddress()

Returns:

WRITEME

getItemsByType

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

Parameters:

typeString - WRITEME

Returns:

WRITEME

getKickedByUserID

int getKickedByUserID()

Returns:

WRITEME

getKickedMessage

String getKickedMessage()

Returns:

WRITEME

getKickedReasonCode

String getKickedReasonCode()

Returns:

WRITEME

getKickedUntil

Timestamp getKickedUntil()

String?? TODO? FIXME?

Returns:

WRITEME

getLanguage

String getLanguage()

Returns:

WRITEME

getMail

String getMail()

Returns:

WRITEME

getNameApprovedAt

Date getNameApprovedAt()

Returns:

WRITEME

getNameRequestedAt

Date getNameRequestedAt()

Returns:

WRITEME

getPublicInfo

org.json.JSONObject getPublicInfo()

TODO: document this method (brpocock, Oct 31, 2009) avatar, userName, clothes, colors

Returns:

WRITEME

getRegisteredDateString

String getRegisteredDateString()

Returns:

WRITEME

getResponsibleMail

String getResponsibleMail()

Returns:

WRITEME

getRoomNumber

int getRoomNumber()

TODO: document this method (brpocock, Jan 11, 2010)

Returns:

WRITEME

getServerThread

AppiusClaudiusCaecus getServerThread()

Returns:

WRITEME

getStaffLevel

int getStaffLevel()

TODO: document this method (brpocock, Jan 11, 2010)

Returns:

WRITEME

getTargetX

double getTargetX()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

getTargetY

double getTargetY()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

getTravelRate

double getTravelRate()

TODO: document this method (brpocock, Nov 24, 2009)

Returns:

WRITEME

getTravelStart

long getTravelStart()

TODO: document this method (brpocock, Nov 24, 2009)

Returns:

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

getUserID

int getUserID()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

getUserVariables

Map<String,String> getUserVariables()

TODO: document this method (brpocock, Jan 11, 2010)

Returns:

WRITEME

getVariable

String getVariable(String string)

TODO: document this method (brpocock, Oct 31, 2009)

Parameters:

string - WRITEME

Returns:

WRITEME

getX

double getX()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

getY

double getY()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

hasStaffLevel

boolean hasStaffLevel(int i)

Parameters:

i - WRITEME

Returns:

WRITEME

hasVariable

boolean hasVariable(String string)

TODO: document this method (brpocock, Nov 30, 2009)

Parameters:

string - WRITEME

Returns:

WRITEME

ignore

void ignore(AbstractUser byLogin)

Parameters:

byLogin - WRITEME

isBanned

boolean isBanned()

Returns:

WRITEME

isCanceled

boolean isCanceled()

Returns:

WRITEME

isKicked

boolean isKicked()

Returns:

WRITEME

isNPC

boolean isNPC()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

isOnline

boolean isOnline()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

isPaidMember

boolean isPaidMember()

Returns:

WRITEME

kick

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

Parameters:

u - WRITEME

kickReason - WRITEME

duration - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

liftBan

void liftBan(AbstractUser authority)
             throws PrivilegeRequiredException

WRITEME

Parameters:

authority - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

notifyFurnitureInventory

void notifyFurnitureInventory(AbstractRoom room)

Parameters:

room - WRITEME

removeBuddy

void removeBuddy(AbstractUser byLogin)

Parameters:

byLogin - WRITEME

reportedToModeratorBy

void reportedToModeratorBy(AbstractUser u)

Parameters:

u - WRITEME

sendEarnings

void sendEarnings(AbstractRoom room,
                  String string)

Parameters:

room - WRITEME

string - WRITEME

sendMigrate

void sendMigrate(AbstractZone refugeeZone)
                 throws UserDeadException

TODO: document this method (brpocock, Jan 11, 2010)

Parameters:

refugeeZone - WRITEME

Throws:

UserDeadException - WRITEME

sendOops

void sendOops()

WRITEME

sendResponse

void sendResponse(org.json.JSONObject result)

Parameters:

result - WRITEME

sendUserLists

void sendUserLists()

Sends the user an asynchronous notification of their user lists' status. This is normally triggered by a change in the status of one of the users on these lists. (Note, User Lists are the buddy list and ignore list.)

sendWardrobe

void sendWardrobe()

setAgeGroupToSystem

void setAgeGroupToSystem()

WRITEME

setBaseColor

void setBaseColor(Colour colour)

Parameters:

colour - WRITEME

setCanTalk

void setCanTalk(boolean b)

Parameters:

b - WRITEME

setExtraColor

void setExtraColor(Colour colour)

Parameters:

colour - WRITEME

setLastActive

void setLastActive()

WRITEME

setMail

void setMail(String email)
             throws GameLogicException

Parameters:

email - WRITEME

Throws:

GameLogicException - WRITEME

setRoom

int setRoom(AbstractRoom room)

Parameters:

room - WRITEME

Returns:

WRITEME

setStartT

void setStartT(long when)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

when - WRITEME

setStructure

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

Parameters:

item - WRITEME

setTravelRate

void setTravelRate(double rate)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

rate - WRITEME

setVariable

void setVariable(String varName,
                 String varValue)

Parameters:

varName - WRITEME

varValue - WRITEME

setX

void setX(double x2)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

x2 - WRITEME

setY

void setY(double y2)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

y2 - WRITEME

speak

void speak(AbstractRoom room,
           String string)

Parameters:

room - WRITEME

string - WRITEME

startEvent

org.json.JSONObject startEvent(String gameMoniker)

Parameters:

gameMoniker - WRITEME

Returns:

WRITEME

toJSON

org.json.JSONObject toJSON()

TODO: document this method (brpocock, Jan 11, 2010)

Returns:

WRITEME WRITEME

toSFSXML

String toSFSXML()

TODO: document this method (brpocock, Oct 31, 2009)

Returns:

WRITEME

wear

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

Parameters:

asClothing - WRITEME

wear

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

Parameters:

asClothing - WRITEME

colour - WRITEME