org.starhope.appius.game.inventory
Interface PetFromInventory

All Superinterfaces:
AbstractUser, AcceptsMetronomeTicks, Comparable<Object>, DataRecordBacked<UserRecord>, HasName, HasVariables, RoomListener, Serializable

public interface PetFromInventory
extends AbstractUser, AcceptsMetronomeTicks

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

Author:
brpocock@star-hope.org

Method Summary
 PetBehaviour getActiveBehaviour()
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 AbstractUser getUserBeingFollowed()
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 boolean isFollowingUser()
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 boolean isInFlock()
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 boolean isInTrain()
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 void joinFlock(AbstractUser member)
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 void joinTrain(AbstractUser member)
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 void setNextBehaviour(PetBehaviour behaviour)
          WRITEME: document this method (brpocock@star-hope.org, Nov 24, 2009)
 
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
 
Methods inherited from interface org.starhope.appius.util.AcceptsMetronomeTicks
tick
 
Methods inherited from interface org.starhope.appius.util.HasName
getName
 

Method Detail

getActiveBehaviour

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

Returns:
WRITEME

getUserBeingFollowed

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

Returns:
WRITEME

isFollowingUser

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

Returns:
WRITEME

isInFlock

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

Returns:
WRITEME

isInTrain

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

Returns:
WRITEME

joinFlock

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

Parameters:
member - WRITEME

joinTrain

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

Parameters:
member - WRITEME

setNextBehaviour

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

Parameters:
behaviour - WRITEME