org.starhope.appius.game.npc.plebeian
Interface ScriptPuppet

All Superinterfaces:

AbstractUser, Comparable<Object>, DataRecordBacked<UserRecord>, HasVariables, RoomListener, Serializable

All Known Implementing Classes:

Plebeian

public interface ScriptPuppet
extends AbstractUser

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Method Summary

ScriptRunner	getScriptRunner() WRITEME: Document this method brpocock@star-hope.org
String	getShortLabel() WRITEME: Document this method brpocock@star-hope.org
boolean	isBuddy(AbstractUser someone) WRITEME: Document this method brpocock@star-hope.org
void	seekRoom(Room r) WRITEME: Document this method brpocock@star-hope.org
void	speakCasually(String key) WRITEME: Document this method brpocock@star-hope.org
long	whenAtTarget(Runnable whatNext) WRITEME: Document this method brpocock@star-hope.org

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

acceptErrorReply, acceptMessage, acceptPrivateMessage, acceptSuccessReply, addBuddy, addGiftSubscription, addItem, assertLocationUnlocked, assertStaffLevel, attend, ban, canTalk, doffClothes, doTransport, getAge, getAgeGroup, getApprovedDateString, getAvatarClass, getAvatarLabel, getBaseColor, getBuddyListNames, getCurrentAction, getDebugName, getDialect, getDisplayName, getExtraColor, getFacing, getHeight, getInventory, getIPAddress, getKickedByUserID, getKickedMessage, getKickedReasonCode, getKickedUntil, getLag, getLanguage, getLocation, getLocationForUpdate, getMail, getMoney, getNameApprovedAt, getNameRequestedAt, getPathFinder, getPublicInfo, getRegisteredDateString, getResponsibleMail, getRoomNumber, getServerThread, getSizeScalar, getStaffLevel, getStartT, getTarget, getTravelRate, getTravelStart, getUserID, getUserListIterator, getUserVariables, getVariable, getWallet, handleWalkFail, hasStaffLevel, hasVariable, ignore, isBanned, isCanceled, isKicked, isNPC, isOnline, isPaidMember, kick, liftBan, needsParent, purchase, removeBuddy, reportedToModeratorBy, reportedToModeratorBy, sendBuddyList, sendEarnings, sendMigrate, sendOops, sendResponse, sendWardrobe, setAgeGroupToSystem, setBaseColor, setCanTalk, setCurrentAction, setExtraColor, setFacing, setLastActive, setLocation, setMail, setParent, setRoom, setStartT, setTarget, setTravelRate, setTravelStart, setVariable, speak, takeAttack, toJSON, toSFSXML, unlockLocation, updateWallet

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

acceptGameAction, acceptGameStateChange, acceptObjectJoinRoom, acceptObjectPartRoom, acceptOutOfBandMessage, acceptPublicMessage, acceptPublicMessage, acceptUserAction, acceptUserVariableUpdate, getRoom, getZone

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.starhope.appius.types.HasVariables

deleteVariable, getVariables, resetVariables, setVariable, setVariables

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

setBackingRecord

Method Detail

getScriptRunner

ScriptRunner getScriptRunner()

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

Returns:

the script runner managing this puppet

getShortLabel

String getShortLabel()

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

Returns:

the avatar label without any NPC instance ID's and such

isBuddy

boolean isBuddy(AbstractUser someone)

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

Parameters:

someone - someone

Returns:

true, if someone is my buddy

seekRoom

void seekRoom(Room r)

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

Parameters:

r -

speakCasually

void speakCasually(String key)

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

Parameters:

key - a key for the speech to speak

whenAtTarget

long whenAtTarget(Runnable whatNext)

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

Parameters:

whatNext - something to do when we get there

Returns:

the time we'll get there