Package games.stendhal.server.entity.creature

Class Pet

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.ActiveEntity

games.stendhal.server.entity.GuidedEntity

games.stendhal.server.entity.RPEntity

games.stendhal.server.entity.DressedEntity

games.stendhal.server.entity.npc.NPC

games.stendhal.server.entity.creature.Creature

games.stendhal.server.entity.creature.DomesticAnimal

games.stendhal.server.entity.creature.Pet

All Implemented Interfaces:

Killer, Cloneable, Iterable<String>, Serializable

Direct Known Subclasses:

BabyDragon, Cat, PurpleDragon

public abstract class Pet
extends DomesticAnimal

A pet is a domestic animal that can be owned by a player. It eats chicken from the ground. They move faster than sheep. Pets starve if they are not fed. They can die.

Author:

kymara

Nested Class Summary

Nested classes/interfaces inherited from class marauroa.common.game.RPObject

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected int	ATK
protected int	DEF
int	FAT_FACTOR	Approximately how much slower he gets hungry if he's full weight.
protected List<String>	foodName
protected int	HP
protected int	hunger
protected static int	HUNGER_HUNGRY	The amount of hunger that indicates hungry.
protected static int	HUNGER_STARVATION	The amount of hunger that indicates starvation.
int	MAX_WEIGHT	The weight at which the pet will stop eating.
protected List<String>	medicineName
protected int	XP

Fields inherited from class games.stendhal.server.entity.creature.DomesticAnimal

owner, wasOwned, weight

Fields inherited from class games.stendhal.server.entity.creature.Creature

dropItemInstances, dropsItems, noises

Fields inherited from class games.stendhal.server.entity.npc.NPC

pauseDirection, pauseTurns, pauseTurnsRemaining, SOUND_RADIUS

Fields inherited from class games.stendhal.server.entity.RPEntity

atk, ATTR_TITLE, damageReceived, def, level, lv_cap, ratk, statusAttackers, statusList, totalDamageReceived

Fields inherited from class games.stendhal.server.entity.GuidedEntity

baseSpeed, pathnotifier

Fields inherited from class games.stendhal.server.entity.Entity

area

Fields inherited from class marauroa.common.game.RPObject

INVALID_ID

Fields inherited from class marauroa.common.game.SlotOwner

slots

Constructor Summary

Constructors

Constructor	Description
Pet()	Creates a new wild Pet.
Pet(RPObject object, Player owner)	Creates a Pet based on an existing pet RPObject, and assigns it to a player.

Method Summary

Modifier and Type	Method	Description
boolean	canGrow()	does this pet even have another form?
String	describe()	Describes the entity (if a players looks at it).
static void	generateRPClass()
protected abstract List<String>	getFoodNames()
protected List<String>	getMedicineNames()
void	grow()	grow this pet into a new form
void	logic()	Determines what the pet shall do next.
void	onDead(Killer killer, boolean remove)	Is called when the pet dies.

Methods inherited from class games.stendhal.server.entity.creature.DomesticAnimal

dropItemsOn, getOwner, getWeight, handleObjectCollision, handleSimpleCollision, isOwnerCallingMe, moveToOwner, setOwner, setWeight, takesPartInCombat, update, wasOwned

Methods inherited from class games.stendhal.server.entity.creature.Creature

addDropItem, addDropItem, addDropItem, attack, clearDropItemList, equip, getAIProfile, getAIProfiles, getAttackStrategy, getAttackTurn, getCorpseDeserver, getCorpseHeight, getCorpseName, getCorpseWidth, getDamageType, getEnemyList, getHarmlessCorpseName, getItemAtk, getItemRatk, getMaxRangeForArcher, getNearestEnemy, getNewInstance, getRangedDamageType, getRespawnPoint, getRespawnTime, getSusceptibility, hasTargetMoved, init, isAbnormal, isAttackable, isAttackTurn, isBoss, isEnemyNear, isPlayingMovementSound, isRare, isSpawned, makeNoise, makeNoiseChance, notifyRegisteredObjects, registerObjectsForNotification, registerObjectsForNotification, setAIProfiles, setAttackStrategy, setBusy, setCorpse, setDamageTypes, setDeathSound, setHealer, setIdle, setMovementSound, setNoises, setRespawned, setRespawnPoint, setSusceptibilities, stopMovementSound, unregisterObjectsForNotification, unregisterObjectsForNotification

Methods inherited from class games.stendhal.server.entity.npc.NPC

checkPause, getIdea, getMovementRange, getPerceptionRange, getSounds, maybeMakeSound, maybeMakeSound, moveRandomly, onFinishedPath, say, setIdea, setMovement, setMovementRange, setPathCompletedPause, setPathCompletedPause, setPerceptionRange, setRandomPathFrom, setSounds, setSounds

Methods inherited from class games.stendhal.server.entity.DressedEntity

getOriginalOutfit, getOutfit, getOutfitColors, isNaked, put, restoreOriginalOutfit, setOutfit, setOutfit, setOutfit, setOutfit, setOutfit, setOutfit, setOutfitColor, setOutfitColor, setOutfitColor, setOutfitColors, setOutfitWithDetail, unsetOutfitColor

Methods inherited from class games.stendhal.server.entity.RPEntity

addAtkXP, addBaseMana, addDefXP, addKarma, addMana, addRatkXP, addStatusAttacker, addXP, applyDefXP, applyDistanceAttackModifiers, canDoRangeAttack, canHit, damage, damageDone, delayedDamage, drop, drop, drop, dropDroppableItem, dropWithInfostring, dropWithInfostring, entityAsOnlinePlayer, entityAsPet, equip, equipOrPutOnGround, equipToInventoryOnly, getAllEquipped, getAllEquippedWithInfostring, getAmmunition, getArmor, getAtk, getAtkXP, getAttackingRPEntities, getAttackRate, getAttackSources, getAttackTarget, getBaseHP, getBaseMana, getBloodClass, getBoots, getCappedAtk, getCappedDef, getCappedRatk, getCloak, getDeathSound, getDef, getDefenseItems, getDefXP, getDescriptionName, getDroppables, getEquippedItemClass, getFirstEquipped, getHelmet, getHP, getItemDef, getKarma, getLanguage, getLegs, getLevel, getLVCap, getMana, getMissileIfNotHoldingOtherWeapon, getName, getNumberOfEquipped, getRangeWeapon, getRatk, getRatkXP, getRing, getsFightXpFrom, getShield, getSlotToEquip, getStatusList, getTitle, getTotalNumberOf, getWeapon, getWeapons, getXP, handleLifesteal, handlePortal, hasArmor, hasBoots, hasCloak, hasHelmet, hasLegs, hasLineOfSight, hasRing, hasShield, hasStatus, heal, heal, heal, incAtkXP, incDefXP, incRatkXP, initHP, isAttacked, isAttacking, isEquipped, isEquipped, isEquippedItemClass, isEquippedItemInSlot, isEquippedWithInfostring, isEquippedWithInfostring, isInvisibleToCreatures, makeCorpse, maybeDropDroppables, onAdded, onDamaged, onDead, onRemoved, rememberAttacker, rewardKillerAnimals, rewardKillers, sendPrivateText, sendPrivateText, setAtk, setAtkInternal, setAtkXP, setBaseHP, setBaseMana, setBlood, setDef, setDefInternal, setDefXP, setHP, setLevel, setLVCap, setMana, setName, setRatk, setRatkInternal, setRatkXP, setRatkXPInternal, setShadowStyle, setTarget, setTitle, setXP, stopAttack, stopAttacking, subXP, updateItemAtkDef, updateLevel, useKarma, useKarma, useKarma

Methods inherited from class games.stendhal.server.entity.GuidedEntity

addSuspend, addSuspend, applyMovement, atMovementRadius, clearPath, followPath, getBaseSpeed, getCollisionAction, getDirectionFromOrigin, getDistanceFromOrigin, getGuide, getPath, getPathPosition, hasPath, isPathLoop, onMoved, onNodeReached, onOutsideMovementRadius, removeSuspend, reroute, retracePath, setBaseSpeed, setCollisionAction, setPath, setPath, setPathAndPosition, setPathPosition, setRandomMovementRadius, setRandomMovementRadius, setRetracePath, setUsesRandomPath, stop, updateModifiedAttributes, usesRandomPath

Methods inherited from class games.stendhal.server.entity.ActiveEntity

canMoveTo, canMoveTo, faceto, faceToward, getDirection, getDirectionToward, getDirectionToward, getResistance, getSpeed, getStepsTaken, handleLeaveZone, ignoresCollision, isFacingToward, isGhost, isMoveCompleted, isZoneChangeAllowed, move, setDirection, setIgnoresCollision, setSpeed, stopped

Methods inherited from class games.stendhal.server.entity.Entity

getAdjacentNodes, getArea, getArea, getCursor, getDescription, getEntitySlot, getHeight, getOrigin, getResistance, getWidth, getX, getY, getZone, hasDescription, isInSight, isObstacle, nextTo, nextTo, notifyWorldAboutChanges, setCursor, setDescription, setEntityClass, setEntitySubclass, setMenu, setPosition, setResistance, setSize, setVisibility, slotIterator, slots, squaredDistance, squaredDistance

Methods inherited from class marauroa.common.game.RPObject

addEvent, addLink, addLink, addMap, addSlot, addSlot, applyDifferences, clearEvents, clearVisible, clone, containsKey, equals, events, eventsIterator, fill, get, getBaseContainer, getBoolean, getContainer, getContainerBaseOwner, getContainerOwner, getContainerSlot, getDifferences, getDouble, getFromSlots, getID, getInt, getLink, getLinkedObject, getMap, getSlot, has, hashCode, hasLink, hasMap, hasSlot, hide, isContained, isEmpty, isHidden, isStorable, maps, put, put, put, put, readObject, remove, removeLink, removeMap, removeSlot, resetAddedAndDeleted, resetAddedAndDeletedMaps, resetAddedAndDeletedRPLink, resetAddedAndDeletedRPSlot, setAddedMaps, setAddedRPSlot, setContainer, setDeletedMaps, setDeletedRPSlot, setID, size, slots, slotsIterator, store, toString, unhide, unstore, writeObject, writeObject, writeToJson

Methods inherited from class marauroa.common.game.SlotOwner

deserializeRPSlots, fill, serializeRPSlots

Methods inherited from class marauroa.common.game.Attributes

add, applyDifferences, get, getBool, getDouble, getInt, getList, getLong, getRPClass, has, instanceOf, iterator, put, put, put, put, readFromMap, remove, resetAddedAndDeletedAttributes, setAddedAttributes, setDeletedAttributes, setRPClass, setRPClass, toAttributeString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface games.stendhal.server.entity.Killer

clone

Field Details

HUNGER_HUNGRY

protected static final int HUNGER_HUNGRY

The amount of hunger that indicates hungry.

See Also:

Constant Field Values

HUNGER_STARVATION

protected static final int HUNGER_STARVATION

The amount of hunger that indicates starvation.

See Also:

Constant Field Values

MAX_WEIGHT

public final int MAX_WEIGHT

The weight at which the pet will stop eating.

See Also:

Constant Field Values

FAT_FACTOR

public final int FAT_FACTOR

Approximately how much slower he gets hungry if he's full weight.

See Also:

Constant Field Values

foodName

protected List<String> foodName

medicineName

protected List<String> medicineName

HP

protected int HP

ATK

protected int ATK

DEF

protected int DEF

XP

protected int XP

hunger

protected int hunger

Constructor Details

Pet

public Pet()

Creates a new wild Pet.

Pet

public Pet(RPObject object,
 Player owner)

Creates a Pet based on an existing pet RPObject, and assigns it to a player.

Parameters:

object - object containing the data for the Pet

owner - The player who should own the pet

Method Details

getFoodNames

protected abstract List<String> getFoodNames()

getMedicineNames

protected List<String> getMedicineNames()

generateRPClass

public static void generateRPClass()

onDead

public void onDead(Killer killer,
 boolean remove)

Is called when the pet dies. Removes the dead pet from the owner.

Overrides:

onDead in class Creature

Parameters:

killer - The entity who caused the death, i.e. who did the last hit.

remove - true iff this entity should be removed from the world. For almost everything remove is true, but not for the players, who are instead moved to afterlife ("reborn").

logic

public void logic()

Determines what the pet shall do next.

Overrides:

logic in class Creature

describe

public String describe()

Description copied from class: Entity

Describes the entity (if a players looks at it).

Overrides:

describe in class RPEntity

Returns:

description from the players point of view

canGrow

public boolean canGrow()

does this pet even have another form?

grow

public void grow()

grow this pet into a new form