org.starhope.appius.game
Interface PetFromInventory

All Superinterfaces:

AcceptsMetronomeTicks, ExistsInWorld, HasName, RoomListener

All Known Implementing Classes:

Pet

public interface PetFromInventory
extends ExistsInWorld, AcceptsMetronomeTicks

TODO: The documentation for this type (PetFromInventory) is incomplete. (brpocock, Nov 24, 2009)

Author:

brpocock

Method Summary

PetBehaviour	getActiveBehaviour() TODO: document this method (brpocock, Nov 24, 2009)
ExistsInWorld	getUserBeingFollowed() TODO: document this method (brpocock, Nov 24, 2009)
boolean	isFollowingUser() TODO: document this method (brpocock, Nov 24, 2009)
boolean	isInFlock() TODO: document this method (brpocock, Nov 24, 2009)
boolean	isInTrain() TODO: document this method (brpocock, Nov 24, 2009)
void	joinFlock(ExistsInWorld member) TODO: document this method (brpocock, Nov 24, 2009)
void	joinTrain(ExistsInWorld member) TODO: document this method (brpocock, Nov 24, 2009)
void	setNextBehaviour(PetBehaviour behaviour) TODO: document this method (brpocock, Nov 24, 2009)

Methods inherited from interface org.starhope.appius.util.ExistsInWorld

acceptAdminMessage, acceptAdminMessage, getAvatarLabel, getFacing, getPublicInfo, getTargetX, getTargetY, getTravelRate, getTravelStart, getUserID, getVariable, getX, getY, hasVariable, isNPC, isOnline, setStartT, setTravelRate, setX, setY, toSFSXML

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

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

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

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

Returns:

WRITEME

getUserBeingFollowed

ExistsInWorld getUserBeingFollowed()

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

Returns:

WRITEME

isFollowingUser

boolean isFollowingUser()

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

Returns:

WRITEME

isInFlock

boolean isInFlock()

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

Returns:

WRITEME

isInTrain

boolean isInTrain()

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

Returns:

WRITEME

joinFlock

void joinFlock(ExistsInWorld member)

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

Parameters:

member - WRITEME

joinTrain

void joinTrain(ExistsInWorld member)

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

Parameters:

member - WRITEME

setNextBehaviour

void setNextBehaviour(PetBehaviour behaviour)

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

Parameters:

behaviour - WRITEME