org.starhope.appius.game.inventory
Class Pet

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<InventoryItem>
      org.starhope.appius.game.inventory.InventoryItem
          org.starhope.appius.game.inventory.Pet

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<InventoryItem>, AcceptsMetronomeTicks, CTime, DataRecord, GetsConfigReload, HasName, HasSubversionRevision

public class Pet
extends InventoryItem
implements GetsConfigReload, AcceptsMetronomeTicks

WRITEME: The documentation for this type (Pet) is incomplete. (brpocock@star-hope.org, Nov 24, 2009)

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private ConcurrentLinkedQueue<PetBehaviour>	behaviourQueue Queue of future behaviours to execute.
private PetBehaviour	currentBehaviour WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) currentBehaviour (Pet)
private String	facing WRITEME: document this field (brpocock@star-hope.org, Jan 14, 2010) facing (Pet)
private List<Pet>	flock WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) flock (Pet)
private double	hyperactivity WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) hyperactivity (Pet)
private Inventory	inv Inventory
private static int	maxTick WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) maxTick (Pet)
private static int	minTick WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) minTick (Pet)
private Room	myRoom WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) myRoom (Pet)
private TrainCar	nextInTrain WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) nextInTrain (Pet)
private GeneralUser	owner WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) owner (Pet)
private double	ownerExitX WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) ownerExitX (Pet)
private double	ownerExitY WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) ownerExitY (Pet)
private AbstractUser	personToBother WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) personToBother (Pet)
private TrainCar	priorInTrain WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) priorInTrain (Pet)
private static long	serialVersionUID Java serialization version unique ID serialVersionUID (long)
private double	speed WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) speed (Pet)
private double	targetX WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) targetX (Pet)
private double	targetY WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) targetY (Pet)
private long	tBother WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) tBother (Pet)
private TrainCar	trainLeader WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) trainLeader (Pet)
private double	travelRate WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) travelRate (Pet)
private long	travelStart WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) travelStart (Pet)
private double	x WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) x (Pet)
private double	y WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) y (Pet)

Fields inherited from class org.starhope.appius.game.inventory.InventoryItem

active, colours, itemID, ownerID, slotNumber, type

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

Pet(RecordLoader<InventoryItem> loader)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

void	acceptErrorReply(String command, String error, org.json.JSONObject result, Room userCurrentRoomInZone)
void	acceptGameAction(AbstractUser u, org.json.JSONObject action)
void	acceptGameAction(GeneralUser sender, org.json.JSONObject action) WRITEME
void	acceptGameStateChange(GameEvent gameCode, GameStateFlag gameState) WRITEME
void	acceptMessage(String string, String string2, String string3)
void	acceptObjectJoinRoom(Room room, RoomListener object) This is an overriding method.
void	acceptObjectPartRoom(Room room, RoomListener object) WRITEME
void	acceptOutOfBandMessage(AbstractUser sender, Room room, org.json.JSONObject body) WRITEME
void	acceptPublicMessage(AbstractUser sender, Room room, String message) This is an overriding method.
void	acceptPublicMessage(AbstractUser from, String message) This is an overriding method.
void	acceptSuccessReply(String command, org.json.JSONObject jsonData, Room room) This is an overriding method.
void	acceptUserVariableUpdate(AbstractUser user, String varName, String varValue) This is an overriding method.
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) This is an overriding method.
boolean	canTalk()
void	configUpdated() This is an overriding method.
void	doffClothes()
void	doTransport()
private void	endBehaviour() WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	equip() This is an overriding method.
PetBehaviour	getActiveBehaviour() WRITEME
int	getAge()
AgeBracket	getAgeGroup() This is an overriding method.
String	getApprovedDateString()
AvatarClass	getAvatarClass()
String	getAvatarLabel() WRITEME
Collection<String>	getBuddyListNames() This is an overriding method.
String	getDebugName() This is an overriding method.
String	getDialect()
String	getDisplayName()
String	getFacing() WRITEME
Inventory	getInventory() This is an overriding method.
String	getIPAddress()
Collection<InventoryItem>	getItemsByType(String typeString)
int	getKickedByUserID()
String	getKickedMessage()
String	getKickedReasonCode()
Timestamp	getKickedUntil()
String	getLanguage()
String	getMail()
BigDecimal	getMoney(Currency currency)
String	getName() This is an overriding method.
Date	getNameApprovedAt()
Date	getNameRequestedAt()
TrainCar	getNextInTrain() This is an overriding method.
private String	getNomen() WRITEME: Document this method brpocock@star-hope.org
TrainCar	getPriorInTrain() This is an overriding method.
org.json.JSONObject	getPublicInfo() WRITEME
String	getRegisteredDateString()
String	getResponsibleMail()
Room	getRoom() WRITEME
int	getRoomNumber() This is an overriding method.
ServerThread	getServerThread()
int	getStaffLevel() This is an overriding method.
double	getTargetX() WRITEME
double	getTargetY() WRITEME
TrainCar	getTrainLeader() This is an overriding method.
double	getTravelRate() This is an overriding method.
long	getTravelStart() This is an overriding method.
AbstractUser	getUserBeingFollowed() WRITEME
int	getUserID() WRITEME
Map<String,String>	getUserVariables() This is an overriding method.
String	getVariable(String string) WRITEME
double	getX() WRITEME
double	getY() WRITEME
AbstractZone	getZone() WRITEME
boolean	hasStaffLevel(int i)
boolean	hasVariable(String string) This is an overriding method.
void	ignore(AbstractUser byLogin)
boolean	isBanned()
boolean	isCanceled()
boolean	isFollowingUser() WRITEME
boolean	isInFlock() WRITEME
boolean	isInTrain() WRITEME
boolean	isInTrain(TrainCar leader) This is an overriding method.
boolean	isKicked()
boolean	isNPC() WRITEME
boolean	isOnline() WRITEME
boolean	isPaidMember()
void	joinFlock(AbstractUser member) WRITEME
void	joinTrain(AbstractUser member) This is an overriding method.
void	joinTrain(TrainCar member) WRITEME
void	kick(AbstractUser u, String kickReason, int duration)
void	liftBan(AbstractUser authority)
boolean	needsParent() This is an overriding method.
void	notifyFurnitureInventory(Room room)
private void	pickSomeoneToBother() WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
private static void	realConfigUpdated() WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	removeBuddy(AbstractUser byLogin)
void	reportedToModeratorBy(AbstractUser u)
void	reportedToModeratorBy(AbstractUser u, String reason) This is an overriding method.
private void	seek(AbstractUser target) WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
private void	seek(double goalX, double goalY) WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	sendEarnings(Room room, String string)
void	sendMigrate(AbstractZone refugeeZone) This is an overriding method.
void	sendOops()
void	sendResponse(org.json.JSONObject result)
void	sendUserLists()
void	sendWardrobe()
void	setAgeGroupToSystem()
void	setBaseColor(Colour newColour)
private void	setBehaviour(PetBehaviour behaviour) WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	setCanTalk(boolean b)
void	setEphemeral(boolean b) WRITEME: Document this method brpocock@star-hope.org
void	setExtraColor(Colour newColour)
void	setLastActive()
void	setMail(String email)
void	setNextBehaviour(PetBehaviour behaviour) Add a behaviour to the bottm of the queue.
void	setNextInTrain(TrainCar car) This is an overriding method.
void	setParent(Parent newParent) This is an overriding method.
void	setPriorInTrain(TrainCar car) This is an overriding method.
void	setStartT(long when) This is an overriding method.
void	setTrainLeader(TrainCar who) WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	setTravelRate(double rate) This is an overriding method.
void	setVariable(String varName, String varValue)
void	setX(double x2) This is an overriding method.
void	setY(double y2) This is an overriding method.
private void	spaz() WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
void	speak(Room room, String string)
void	tick(long currentTime, long deltaTime) This is an overriding method.
String	toSFSXML() WRITEME
void	unequip() un-equip an item (set it to be inactive)
void	wear(InventoryItem asClothing)
void	wear(InventoryItem asClothing, Colour newColour)

Methods inherited from class org.starhope.appius.game.inventory.InventoryItem

destroy, equals, getByID, getByID, getCacheableID, getCacheableIdent, getColor, getColour, getColour, getColours, getGenericItem, getHealth, getID, getItemEffects, getItemID, getOwner, getOwnerID, getRoomIndex, getSlotNumber, getSubversionRevision, getType, getTypeID, getZ, hashCode, isActive, setActive, setColour, setColour, setColour, setColour, setFacing, setHealth, setItemID, setOwner, setOwnerID, setRoom, setRoomNumber, setSlotHarsh, setSlotNumber, setType, setTypeID, setZ, toJSON, toString, unsetRoom

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, checkStale, compareTo, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

maxTick

private static int maxTick

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) maxTick (Pet)

minTick

private static int minTick

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) minTick (Pet)

serialVersionUID

private static final long serialVersionUID

Java serialization version unique ID serialVersionUID (long)

See Also:

Constant Field Values

behaviourQueue

private final ConcurrentLinkedQueue<PetBehaviour> behaviourQueue

Queue of future behaviours to execute.

currentBehaviour

private PetBehaviour currentBehaviour

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) currentBehaviour (Pet)

facing

private String facing

WRITEME: document this field (brpocock@star-hope.org, Jan 14, 2010) facing (Pet)

flock

private List<Pet> flock

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) flock (Pet)

hyperactivity

private final double hyperactivity

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) hyperactivity (Pet)

See Also:

Constant Field Values

inv

private Inventory inv

Inventory

myRoom

private Room myRoom

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) myRoom (Pet)

nextInTrain

private final TrainCar nextInTrain

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) nextInTrain (Pet)

owner

private GeneralUser owner

WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) owner (Pet)

ownerExitX

private double ownerExitX

WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) ownerExitX (Pet)

ownerExitY

private double ownerExitY

WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) ownerExitY (Pet)

personToBother

private final AbstractUser personToBother

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) personToBother (Pet)

priorInTrain

private final TrainCar priorInTrain

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) priorInTrain (Pet)

speed

private double speed

WRITEME: document this field (brpocock@star-hope.org, Dec 1, 2009) speed (Pet)

targetX

private double targetX

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) targetX (Pet)

targetY

private double targetY

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) targetY (Pet)

tBother

private long tBother

WRITEME: document this field (brpocock@star-hope.org, Nov 24, 2009) tBother (Pet)

trainLeader

private TrainCar trainLeader

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) trainLeader (Pet)

travelRate

private double travelRate

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) travelRate (Pet)

travelStart

private long travelStart

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) travelStart (Pet)

x

private double x

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) x (Pet)

y

private double y

WRITEME: document this field (brpocock@star-hope.org, Dec 14, 2009) y (Pet)

Constructor Detail

Pet

public Pet(RecordLoader<InventoryItem> loader)

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

Parameters:

loader - WRITEME

Method Detail

realConfigUpdated

private static void realConfigUpdated()

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

acceptErrorReply

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

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.Room)

acceptGameAction

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

Parameters:

u - WRITEME

action - WRITEME

See Also:

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

acceptGameAction

public void acceptGameAction(GeneralUser sender,
                             org.json.JSONObject action)

WRITEME

Parameters:

sender - WRITEME

action - WRITEME

See Also:

RoomListener.acceptGameAction(AbstractUser, JSONObject)

acceptGameStateChange

public void acceptGameStateChange(GameEvent gameCode,
                                  GameStateFlag gameState)

WRITEME

See Also:

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

acceptMessage

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

See Also:

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

acceptObjectJoinRoom

public void acceptObjectJoinRoom(Room room,
                                 RoomListener object)

This is an overriding method.

See Also:

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

acceptObjectPartRoom

public void acceptObjectPartRoom(Room room,
                                 RoomListener object)

WRITEME

Parameters:

room - WRITEME

object - WRITEME

See Also:

RoomListener.acceptObjectPartRoom(Room, RoomListener)

acceptOutOfBandMessage

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

WRITEME

See Also:

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

acceptPublicMessage

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

This is an overriding method.

Parameters:

sender - WRITEME

room - WRITEME

message - WRITEME

See Also:

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

acceptPublicMessage

public void acceptPublicMessage(AbstractUser from,
                                String message)

This is an overriding method.

See Also:

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

acceptSuccessReply

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

This is an overriding method.

Parameters:

command - WRITEME

jsonData - WRITEME

room - WRITEME

See Also:

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

acceptUserVariableUpdate

public void acceptUserVariableUpdate(AbstractUser user,
                                     String varName,
                                     String varValue)

This is an overriding method.

Parameters:

user - WRITEME

varName - WRITEME

varValue - WRITEME

See Also:

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

addBuddy

public void addBuddy(AbstractUser buddy)

See Also:

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

addGiftSubscription

public void addGiftSubscription(int i,
                                int days)

See Also:

AbstractUser.addGiftSubscription(int, int)

addItem

public void addItem(int parseInt)

Parameters:

parseInt - WRITEME

See Also:

AbstractUser.addItem(int)

assertStaffLevel

public void assertStaffLevel(int staffLevelStaffMember)
                      throws PrivilegeRequiredException

Parameters:

staffLevelStaffMember - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.assertStaffLevel(int)

attend

public void attend(AbstractUser byLogin)

Parameters:

byLogin - WRITEME

See Also:

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

ban

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

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.

See Also:

org.starhope.appius.user.AbstractUser#cancelEvent(int)

canTalk

public boolean canTalk()

Returns:

WRITEME

See Also:

AbstractUser.canTalk()

configUpdated

public void configUpdated()

This is an overriding method.

Specified by:

configUpdated in interface GetsConfigReload

See Also:

GetsConfigReload.configUpdated()

doffClothes

public void doffClothes()

See Also:

AbstractUser.doffClothes()

doTransport

public void doTransport()

See Also:

AbstractUser.doTransport()

endBehaviour

private void endBehaviour()

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

equip

public void equip()

This is an overriding method.

Overrides:

equip in class InventoryItem

See Also:

InventoryItem.equip()

getActiveBehaviour

public PetBehaviour getActiveBehaviour()

WRITEME

See Also:

PetFromInventory.getActiveBehaviour()

getAge

public int getAge()

See Also:

AbstractUser.getAge()

getAgeGroup

public AgeBracket getAgeGroup()

This is an overriding method.

See Also:

AbstractUser.getAgeGroup()

getApprovedDateString

public String getApprovedDateString()

See Also:

AbstractUser.getApprovedDateString()

getAvatarClass

public AvatarClass getAvatarClass()

See Also:

AbstractUser.getAvatarClass()

getAvatarLabel

public String getAvatarLabel()

WRITEME

See Also:

AbstractUser.getAvatarLabel()

getBuddyListNames

public Collection<String> getBuddyListNames()

This is an overriding method.

See Also:

AbstractUser.getBuddyListNames()

getDebugName

public String getDebugName()

This is an overriding method.

See Also:

AbstractUser.getDebugName()

getDialect

public String getDialect()

See Also:

AbstractUser.getDialect()

getDisplayName

public String getDisplayName()

See Also:

AbstractUser.getDisplayName()

getFacing

public String getFacing()

WRITEME

Overrides:

getFacing in class InventoryItem

Returns:

WRITEME

See Also:

AbstractUser.getFacing()

getInventory

public Inventory getInventory()

This is an overriding method.

See Also:

AbstractUser.getInventory()

getIPAddress

public String getIPAddress()

See Also:

AbstractUser.getIPAddress()

getItemsByType

public Collection<InventoryItem> getItemsByType(String typeString)

See Also:

org.starhope.appius.user.AbstractUser#getItemsByType(java.lang.String)

getKickedByUserID

public int getKickedByUserID()

See Also:

AbstractUser.getKickedByUserID()

getKickedMessage

public String getKickedMessage()

See Also:

AbstractUser.getKickedMessage()

getKickedReasonCode

public String getKickedReasonCode()

See Also:

AbstractUser.getKickedReasonCode()

getKickedUntil

public Timestamp getKickedUntil()

See Also:

AbstractUser.getKickedUntil()

getLanguage

public String getLanguage()

See Also:

AbstractUser.getLanguage()

getMail

public String getMail()

Returns:

WRITEME

See Also:

AbstractUser.getMail()

getMoney

public BigDecimal getMoney(Currency currency)

Parameters:

currency - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getMoney(org.starhope.appius.mb.Currency)

getName

public String getName()

This is an overriding method.

Specified by:

getName in interface HasName

Returns:

a user-visible string name for this instance

See Also:

HasName.getName()

getNameApprovedAt

public Date getNameApprovedAt()

See Also:

AbstractUser.getNameApprovedAt()

getNameRequestedAt

public Date getNameRequestedAt()

See Also:

AbstractUser.getNameRequestedAt()

getNextInTrain

public TrainCar getNextInTrain()

This is an overriding method.

See Also:

TrainCar.getNextInTrain()

getNomen

private String getNomen()

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

Returns:

WRITEME

getPriorInTrain

public TrainCar getPriorInTrain()

This is an overriding method.

Returns:

WRITEME

See Also:

TrainCar.getPriorInTrain()

getPublicInfo

public org.json.JSONObject getPublicInfo()

WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getPublicInfo()

getRegisteredDateString

public String getRegisteredDateString()

Returns:

WRITEME

See Also:

AbstractUser.getRegisteredDateString()

getResponsibleMail

public String getResponsibleMail()

Returns:

WRITEME

See Also:

AbstractUser.getResponsibleMail()

getRoom

public Room getRoom()

WRITEME

Returns:

WRITEME

See Also:

RoomListener.getRoom()

getRoomNumber

public int getRoomNumber()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getRoomNumber()

getServerThread

public ServerThread getServerThread()

Returns:

WRITEME

See Also:

AbstractUser.getServerThread()

getStaffLevel

public int getStaffLevel()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getStaffLevel()

getTargetX

public double getTargetX()

WRITEME

Returns:

WRITEME

See Also:

org.starhope.appius.user.AbstractUser#getTargetX()

getTargetY

public double getTargetY()

WRITEME

Returns:

WRITEME

See Also:

org.starhope.appius.user.AbstractUser#getTargetY()

getTrainLeader

public TrainCar getTrainLeader()

This is an overriding method.

Returns:

WRITEME

See Also:

TrainCar.getTrainLeader()

getTravelRate

public double getTravelRate()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getTravelRate()

getTravelStart

public long getTravelStart()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getTravelStart()

getUserBeingFollowed

public AbstractUser getUserBeingFollowed()

WRITEME

Returns:

WRITEME

See Also:

PetFromInventory.getUserBeingFollowed()

getUserID

public int getUserID()

WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getUserID()

getUserVariables

public Map<String,String> getUserVariables()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getUserVariables()

getVariable

public String getVariable(String string)

WRITEME

Parameters:

string - WRITEME

Returns:

See Also:

AbstractUser.getVariable(java.lang.String)

getX

public double getX()

WRITEME

Overrides:

getX in class InventoryItem

Returns:

x ordinate

See Also:

org.starhope.appius.user.AbstractUser#getX()

getY

public double getY()

WRITEME

Overrides:

getY in class InventoryItem

Returns:

y abcessa

See Also:

org.starhope.appius.user.AbstractUser#getY()

getZone

public AbstractZone getZone()

WRITEME

See Also:

RoomListener.getZone()

hasStaffLevel

public boolean hasStaffLevel(int i)

See Also:

AbstractUser.hasStaffLevel(int)

hasVariable

public boolean hasVariable(String string)

This is an overriding method.

See Also:

AbstractUser.hasVariable(java.lang.String)

ignore

public void ignore(AbstractUser byLogin)

See Also:

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

isBanned

public boolean isBanned()

See Also:

AbstractUser.isBanned()

isCanceled

public boolean isCanceled()

See Also:

AbstractUser.isCanceled()

isFollowingUser

public boolean isFollowingUser()

WRITEME

See Also:

PetFromInventory.isFollowingUser()

isInFlock

public boolean isInFlock()

WRITEME

See Also:

PetFromInventory.isInFlock()

isInTrain

public boolean isInTrain()

WRITEME

See Also:

PetFromInventory.isInTrain()

isInTrain

public boolean isInTrain(TrainCar leader)

This is an overriding method.

See Also:

TrainCar.isInTrain(org.starhope.appius.game.npc.TrainCar)

isKicked

public boolean isKicked()

See Also:

AbstractUser.isKicked()

isNPC

public boolean isNPC()

WRITEME

See Also:

AbstractUser.isNPC()

isOnline

public boolean isOnline()

WRITEME

See Also:

AbstractUser.isOnline()

isPaidMember

public boolean isPaidMember()

See Also:

AbstractUser.isPaidMember()

joinFlock

public void joinFlock(AbstractUser member)

WRITEME

See Also:

PetFromInventory.joinFlock(org.starhope.appius.user.AbstractUser)

joinTrain

public void joinTrain(AbstractUser member)

This is an overriding method.

See Also:

PetFromInventory.joinTrain(org.starhope.appius.user.AbstractUser)

joinTrain

public void joinTrain(TrainCar member)

WRITEME

Parameters:

member - WRITEME

See Also:

PetFromInventory.joinTrain(org.starhope.appius.user.AbstractUser)

kick

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

See Also:

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

liftBan

public void liftBan(AbstractUser authority)
             throws PrivilegeRequiredException

Throws:

PrivilegeRequiredException

See Also:

AbstractUser.liftBan(AbstractUser)

needsParent

public boolean needsParent()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.needsParent()

notifyFurnitureInventory

public void notifyFurnitureInventory(Room room)

Parameters:

room - WRITEME

See Also:

org.starhope.appius.user.AbstractUser#notifyFurnitureInventory(org.starhope.appius.game.Room)

pickSomeoneToBother

private void pickSomeoneToBother()

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

removeBuddy

public void removeBuddy(AbstractUser byLogin)

See Also:

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

reportedToModeratorBy

public void reportedToModeratorBy(AbstractUser u)

See Also:

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

reportedToModeratorBy

public void reportedToModeratorBy(AbstractUser u,
                                  String reason)

This is an overriding method.

See Also:

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

seek

private void seek(AbstractUser target)

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

Parameters:

target - WRITEME

seek

private void seek(double goalX,
                  double goalY)

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

Parameters:

goalX - WRITEME

goalY - WRITEME

sendEarnings

public void sendEarnings(Room room,
                         String string)

See Also:

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

sendMigrate

public void sendMigrate(AbstractZone refugeeZone)

This is an overriding method.

See Also:

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

sendOops

public void sendOops()

See Also:

AbstractUser.sendOops()

sendResponse

public void sendResponse(org.json.JSONObject result)

See Also:

AbstractUser.sendResponse(org.json.JSONObject)

sendUserLists

public void sendUserLists()

See Also:

org.starhope.appius.user.AbstractUser#sendUserLists()

sendWardrobe

public void sendWardrobe()

See Also:

AbstractUser.sendWardrobe()

setAgeGroupToSystem

public void setAgeGroupToSystem()

See Also:

AbstractUser.setAgeGroupToSystem()

setBaseColor

public void setBaseColor(Colour newColour)

See Also:

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

setBehaviour

private void setBehaviour(PetBehaviour behaviour)

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

Parameters:

behaviour - the new behaviour to pre-empt all others

setCanTalk

public void setCanTalk(boolean b)

See Also:

AbstractUser.setCanTalk(boolean)

setEphemeral

public void setEphemeral(boolean b)

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

Parameters:

b -

setExtraColor

public void setExtraColor(Colour newColour)

See Also:

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

setLastActive

public void setLastActive()

See Also:

AbstractUser.setLastActive()

setMail

public void setMail(String email)

See Also:

AbstractUser.setMail(java.lang.String)

setNextBehaviour

public void setNextBehaviour(PetBehaviour behaviour)

Add a behaviour to the bottm of the queue.

See Also:

PetFromInventory.setNextBehaviour(org.starhope.appius.game.npc.PetBehaviour)

setNextInTrain

public void setNextInTrain(TrainCar car)

This is an overriding method.

See Also:

TrainCar.setNextInTrain(org.starhope.appius.game.npc.TrainCar)

setParent

public void setParent(Parent newParent)
               throws GameLogicException,
                      ForbiddenUserException

This is an overriding method.

Parameters:

newParent - WRITEME

Throws:

GameLogicException - WRITEME

ForbiddenUserException - WRITEME

See Also:

AbstractUser.setParent(org.starhope.appius.user.Parent)

setPriorInTrain

public void setPriorInTrain(TrainCar car)

This is an overriding method.

Parameters:

car - WRITEME

See Also:

TrainCar.setPriorInTrain(org.starhope.appius.game.npc.TrainCar)

setStartT

public void setStartT(long when)

This is an overriding method.

Parameters:

when - WRITEME

See Also:

AbstractUser.setStartT(long)

setTrainLeader

public void setTrainLeader(TrainCar who)

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

Parameters:

who - The thing to be following

See Also:

TrainCar.setTrainLeader(org.starhope.appius.game.npc.TrainCar)

setTravelRate

public void setTravelRate(double rate)

This is an overriding method.

Parameters:

rate - WRITEME

See Also:

AbstractUser.setTravelRate(double)

setVariable

public void setVariable(String varName,
                        String varValue)

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.

Overrides:

setX in class InventoryItem

Parameters:

x2 - new X

See Also:

org.starhope.appius.user.AbstractUser#setX(double)

setY

public void setY(double y2)

This is an overriding method.

Overrides:

setY in class InventoryItem

Parameters:

y2 - new Y

See Also:

org.starhope.appius.user.AbstractUser#setY(double)

spaz

private void spaz()

WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)

speak

public void speak(Room room,
                  String string)

Parameters:

room - WRITEME

string - WRITEME

See Also:

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

tick

public void tick(long currentTime,
                 long deltaTime)
          throws UserDeadException

This is an overriding method.

Specified by:

tick in interface AcceptsMetronomeTicks

Parameters:

currentTime - Time since epoch at the start of the global metronome propagation, as per System.currentTimeMillis()

deltaTime - Delta-time in milliseconds since the prior global metronome tick

Throws:

UserDeadException - if a user has died during this tick

See Also:

AcceptsMetronomeTicks.tick(long, long)

toSFSXML

public String toSFSXML()

WRITEME

Returns:

WRITEME

See Also:

AbstractUser.toSFSXML()

unequip

public void unequip()

Description copied from class: InventoryItem

un-equip an item (set it to be inactive)

Overrides:

unequip in class InventoryItem

See Also:

InventoryItem.unequip()

wear

public void wear(InventoryItem asClothing)

Parameters:

asClothing - WRITEME

See Also:

AbstractUser#wear(ClothingItem)

wear

public void wear(InventoryItem asClothing,
                 Colour newColour)

Parameters:

asClothing - WRITEME

newColour - WRITEME

See Also:

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