org.starhope.appius.game.npc
Class AbstractScriptedNPC

java.lang.Object
  org.starhope.appius.user.AbstractNonPlayerCharacter
      org.starhope.appius.game.npc.AbstractScriptedNPC

All Implemented Interfaces:

RoomListener, AbstractUser, AcceptsMetronomeTicks, HasName

Direct Known Subclasses:

LuaNPC, PerlNPC, PythonNPC, RubyNPC

public abstract class AbstractScriptedNPC
extends AbstractNonPlayerCharacter

WRITEME: The documentation for this type (AbstractScriptedNPC) is incomplete. (brpocock, Dec 7, 2009)

Author:

brpocock

Field Summary

private String	facing WRITEME: document this field (brpocock, Jan 13, 2010) facing (AbstractScriptedNPC)
private double	targetX WRITEME: document this field (brpocock, Jan 13, 2010) targetX (AbstractScriptedNPC)
private double	targetY WRITEME: document this field (brpocock, Jan 13, 2010) targetY (AbstractScriptedNPC)
private double	travelRate WRITEME: document this field (brpocock, Jan 13, 2010) travelRate (AbstractScriptedNPC)
private long	travelStart WRITEME: document this field (brpocock, Jan 13, 2010) travelStart (AbstractScriptedNPC)
private ConcurrentHashMap<String,String>	variables WRITEME: document this field (brpocock, Jan 13, 2010) variables (AbstractScriptedNPC)
private double	x WRITEME: document this field (brpocock, Jan 13, 2010) x (AbstractScriptedNPC)
private double	y WRITEME: document this field (brpocock, Jan 13, 2010) y (AbstractScriptedNPC)

Constructor Summary

AbstractScriptedNPC()
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 sender, 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 object) 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 sender, String message) This is an overriding method.
void	acceptSuccessReply(AbstractZone zone, AbstractRoom room, String command, org.json.JSONObject jsonData) This is an overriding method.
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.
boolean	canTalk() This is an overriding method.
private void	computeD() TODO: document this method (brpocock, Jan 13, 2010)
void	doffClothes() This is an overriding method.
void	doTransport() 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.
String	getName() 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() This is an overriding method.
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.
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	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 auth) 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.
protected abstract void	scriptedEvent(String string, Object... params) TODO: document this method (brpocock, Dec 7, 2009)
protected void	scriptSetFacing(String newFacing) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetTargetX(double newDestX) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetTargetY(double newDestY) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetTravelRate(double newTravelRate) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetTravelStart() TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetTravelStart(long newTravelStart) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetX(double newX) TODO: document this method (brpocock, Jan 13, 2010)
protected void	scriptSetY(double newY) TODO: document this method (brpocock, Jan 13, 2010)
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(AbstractUser u) 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.
void	tick(long currentTime, long deltaTime) 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 org.starhope.appius.user.AbstractNonPlayerCharacter

isNPC

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.starhope.appius.user.AbstractUser

cancelEvent, endEvent, sendWardrobe

Field Detail

facing

private String facing

WRITEME: document this field (brpocock, Jan 13, 2010) facing (AbstractScriptedNPC)

targetX

private double targetX

WRITEME: document this field (brpocock, Jan 13, 2010) targetX (AbstractScriptedNPC)

targetY

private double targetY

WRITEME: document this field (brpocock, Jan 13, 2010) targetY (AbstractScriptedNPC)

travelRate

private double travelRate

WRITEME: document this field (brpocock, Jan 13, 2010) travelRate (AbstractScriptedNPC)

travelStart

private long travelStart

WRITEME: document this field (brpocock, Jan 13, 2010) travelStart (AbstractScriptedNPC)

variables

private final ConcurrentHashMap<String,String> variables

WRITEME: document this field (brpocock, Jan 13, 2010) variables (AbstractScriptedNPC)

x

private double x

WRITEME: document this field (brpocock, Jan 13, 2010) x (AbstractScriptedNPC)

y

private double y

WRITEME: document this field (brpocock, Jan 13, 2010) y (AbstractScriptedNPC)

Constructor Detail

AbstractScriptedNPC

public AbstractScriptedNPC()

WRITEME

Method Detail

acceptAdminMessage

public void acceptAdminMessage(AbstractRoom room,
                               String string)

This is an overriding method.

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.

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.

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.

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 sender,
                             org.json.JSONObject action)

This is an overriding method.

Parameters:

sender - sender of the action

action - the action being sent

See Also:

RoomListener.acceptGameAction(AbstractUser, JSONObject)

acceptGameStateChange

public void acceptGameStateChange(GameEvent gameCode,
                                  GameStateFlag gameState)

This is an overriding method.

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.

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.

Parameters:

room - The room

object - The thing (probably user) entering

See Also:

RoomListener.acceptObjectJoinRoom(AbstractRoom, RoomListener)

acceptObjectPartRoom

public void acceptObjectPartRoom(AbstractRoom room,
                                 RoomListener object)

This is an overriding method.

Parameters:

room - The room

object - The thing (probably user) departing

See Also:

RoomListener.acceptObjectPartRoom(AbstractRoom, RoomListener)

acceptOutOfBandMessage

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

This is an overriding method.

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(AbstractUser, AbstractRoom, JSONObject)

acceptPublicMessage

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

This is an overriding method.

Parameters:

sender - The speaker

room - The room in which the words were spoken

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(AbstractUser, AbstractRoom, String)

acceptPublicMessage

public void acceptPublicMessage(AbstractUser sender,
                                String message)

This is an overriding method.

Parameters:

sender - The speaker

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(AbstractUser, java.lang.String)

acceptSuccessReply

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

This is an overriding method.

Parameters:

zone -

room -

command -

jsonData -

See Also:

AbstractUser.acceptSuccessReply(String, JSONObject, AbstractRoom)

acceptSuccessReply

public void acceptSuccessReply(String command,
                               org.json.JSONObject jsonData,
                               AbstractRoom 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.AbstractRoom)

addBuddy

public void addBuddy(AbstractUser buddy)

This is an overriding method.

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.

Parameters:

i - WRITEME

days - WRITEME

See Also:

AbstractUser.addGiftSubscription(int, int)

addItem

public void addItem(int parseInt)

This is an overriding method.

Parameters:

parseInt - WRITEME

See Also:

AbstractUser.addItem(int)

assertStaffLevel

public void assertStaffLevel(int staffLevelStaffMember)
                      throws PrivilegeRequiredException

This is an overriding method.

Parameters:

staffLevelStaffMember - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.assertStaffLevel(int)

attend

public void attend(AbstractUser byLogin)

This is an overriding method.

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.

Parameters:

u - WRITEME

banReason - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

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

canTalk

public boolean canTalk()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.canTalk()

computeD

private void computeD()

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

doffClothes

public void doffClothes()

This is an overriding method.

See Also:

AbstractUser.doffClothes()

doTransport

public void doTransport()

This is an overriding method.

See Also:

AbstractUser.doTransport()

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.

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.

Parameters:

roomInHouse - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

See Also:

AbstractUser.getActiveDecorations(int)

getAge

public int getAge()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getAge()

getApprovedDateString

public String getApprovedDateString()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getApprovedDateString()

getAvatarClass

public AvatarClass getAvatarClass()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getAvatarClass()

getAvatarLabel

public String getAvatarLabel()

This is an overriding method.

Returns:

The avatar label

See Also:

AbstractUser.getAvatarLabel()

getBuddyListNames

public Collection<String> getBuddyListNames()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getBuddyListNames()

getDialect

public String getDialect()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getDialect()

getDisplayName

public String getDisplayName()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getDisplayName()

getFacing

public String getFacing()

This is an overriding method.

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.

Parameters:

int1 - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

See Also:

AbstractUser.getFurnitureBySlot(int)

getIPAddress

public String getIPAddress()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getIPAddress()

getItemsByType

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

This is an overriding method.

Parameters:

typeString - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getItemsByType(java.lang.String)

getKickedByUserID

public int getKickedByUserID()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getKickedByUserID()

getKickedMessage

public String getKickedMessage()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getKickedMessage()

getKickedReasonCode

public String getKickedReasonCode()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getKickedReasonCode()

getKickedUntil

public Timestamp getKickedUntil()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getKickedUntil()

getLanguage

public String getLanguage()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getLanguage()

getLocation

public RoomAndZone getLocation()

This is an overriding method.

Returns:

WRITEME

See Also:

RoomListener.getLocation()

getMail

public String getMail()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getMail()

getName

public String getName()

This is an overriding method.

Returns:

a user-visible string name for this instance

See Also:

HasName.getName()

getNameApprovedAt

public Date getNameApprovedAt()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getNameApprovedAt()

getNameRequestedAt

public Date getNameRequestedAt()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getNameRequestedAt()

getPublicInfo

public org.json.JSONObject getPublicInfo()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getPublicInfo()

getRegisteredDateString

public String getRegisteredDateString()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getRegisteredDateString()

getResponsibleMail

public String getResponsibleMail()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getResponsibleMail()

getRoom

public AbstractRoom getRoom()

This is an overriding method.

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.

Returns:

WRITEME

See Also:

AbstractUser.getRoomNumber()

getServerThread

public AppiusClaudiusCaecus getServerThread()

This is an overriding method.

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()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getTargetX()

getTargetY

public double getTargetY()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getTargetY()

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:

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

See Also:

AbstractUser.getTravelStart()

getUserID

public int getUserID()

This is an overriding method.

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)

This is an overriding method.

Parameters:

string - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.getVariable(java.lang.String)

getX

public double getX()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getX()

getY

public double getY()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.getY()

getZone

public AbstractZone getZone()

This is an overriding method.

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.

Parameters:

i - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.hasStaffLevel(int)

hasVariable

public boolean hasVariable(String string)

This is an overriding method.

Parameters:

string - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.hasVariable(java.lang.String)

ignore

public void ignore(AbstractUser byLogin)

This is an overriding method.

Parameters:

byLogin - WRITEME

See Also:

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

isBanned

public boolean isBanned()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.isBanned()

isCanceled

public boolean isCanceled()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.isCanceled()

isKicked

public boolean isKicked()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.isKicked()

isOnline

public boolean isOnline()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.isOnline()

isPaidMember

public boolean isPaidMember()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.isPaidMember()

kick

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

This is an overriding method.

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 auth)
             throws PrivilegeRequiredException

This is an overriding method.

Parameters:

auth - WRITEME

Throws:

PrivilegeRequiredException - WRITEME

See Also:

AbstractUser.liftBan(AbstractUser)

notifyFurnitureInventory

public void notifyFurnitureInventory(AbstractRoom room)

This is an overriding method.

Parameters:

room - WRITEME

See Also:

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

removeBuddy

public void removeBuddy(AbstractUser byLogin)

This is an overriding method.

Parameters:

byLogin - WRITEME

See Also:

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

reportedToModeratorBy

public void reportedToModeratorBy(AbstractUser u)

This is an overriding method.

Parameters:

u - WRITEME

See Also:

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

scriptedEvent

protected abstract void scriptedEvent(String string,
                                      Object... params)

TODO: document this method (brpocock, Dec 7, 2009)

Parameters:

string - The event being fired off

params - Parameters for that event

scriptSetFacing

protected void scriptSetFacing(String newFacing)

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

Parameters:

newFacing - new facing

scriptSetTargetX

protected void scriptSetTargetX(double newDestX)

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

Parameters:

newDestX - new target x

scriptSetTargetY

protected void scriptSetTargetY(double newDestY)

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

Parameters:

newDestY - new target y

scriptSetTravelRate

protected void scriptSetTravelRate(double newTravelRate)

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

Parameters:

newTravelRate - WRITEME

scriptSetTravelStart

protected void scriptSetTravelStart()

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

scriptSetTravelStart

protected void scriptSetTravelStart(long newTravelStart)

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

Parameters:

newTravelStart - WRITEME

scriptSetX

protected void scriptSetX(double newX)

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

Parameters:

newX - WRITEME

scriptSetY

protected void scriptSetY(double newY)

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

Parameters:

newY - WRITEME

sendEarnings

public void sendEarnings(AbstractRoom room,
                         String string)

This is an overriding method.

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.

Parameters:

refugeeZone - WRITEME

Throws:

UserDeadException - WRITEME

See Also:

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

sendOops

public void sendOops()

This is an overriding method.

See Also:

AbstractUser.sendOops()

sendResponse

public void sendResponse(org.json.JSONObject result)

This is an overriding method.

Parameters:

result - WRITEME

See Also:

AbstractUser.sendResponse(org.json.JSONObject)

sendUserLists

public void sendUserLists()

This is an overriding method.

See Also:

AbstractUser.sendUserLists()

sendWardrobe

public void sendWardrobe(AbstractUser u)

This is an overriding method.

See Also:

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

setAgeGroupToSystem

public void setAgeGroupToSystem()

This is an overriding method.

See Also:

AbstractUser.setAgeGroupToSystem()

setBaseColor

public void setBaseColor(Colour colour)

This is an overriding method.

Parameters:

colour - WRITEME

See Also:

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

setCanTalk

public void setCanTalk(boolean b)

This is an overriding method.

Parameters:

b - WRITEME

See Also:

AbstractUser.setCanTalk(boolean)

setExtraColor

public void setExtraColor(Colour colour)

This is an overriding method.

Parameters:

colour - WRITEME

See Also:

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

setLastActive

public void setLastActive()

This is an overriding method.

See Also:

AbstractUser.setLastActive()

setMail

public void setMail(String email)
             throws GameLogicException

This is an overriding method.

Parameters:

email - WRITEME

Throws:

GameLogicException - WRITEME

See Also:

AbstractUser.setMail(java.lang.String)

setRoom

public int setRoom(AbstractRoom room)

This is an overriding method.

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.

Parameters:

when - WRITEME

See Also:

AbstractUser.setStartT(long)

setStructure

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

This is an overriding method.

Parameters:

item - WRITEME

See Also:

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

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)

This is an overriding method.

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.

Parameters:

x2 - WRITEME

See Also:

AbstractUser.setX(double)

setY

public void setY(double y2)

This is an overriding method.

Parameters:

y2 - WRITEME

See Also:

AbstractUser.setY(double)

speak

public void speak(AbstractRoom room,
                  String string)

This is an overriding method.

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.

Parameters:

gameMoniker - WRITEME

Returns:

WRITEME

See Also:

AbstractUser.startEvent(java.lang.String)

tick

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

This is an overriding method.

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)

toJSON

public org.json.JSONObject toJSON()

This is an overriding method.

Returns:

WRITEME WRITEME

See Also:

AbstractUser.toJSON()

toSFSXML

public String toSFSXML()

This is an overriding method.

Returns:

WRITEME

See Also:

AbstractUser.toSFSXML()

wear

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

This is an overriding method.

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.

Parameters:

asClothing - WRITEME

colour - WRITEME

See Also:

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