Package games.stendhal.server.entity.mapstuff.spawner

Class PassiveEntityRespawnPoint

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.mapstuff.spawner.PassiveEntityRespawnPoint

All Implemented Interfaces:

TurnListener, Killer, Cloneable, Iterable<String>, Serializable

Direct Known Subclasses:

GrowingPassiveEntityRespawnPoint, SheepFood

public class PassiveEntityRespawnPoint
extends Entity
implements TurnListener

A PassiveEntityRespawnPoint basically is a 1x1 area where a plant, a fruit or another non-moving thing grows. This growing thing is a pickable Item (e.g. a mushroom, an apple); by extending this class, it can also grow something special (e.g. SheepFood). PassiveEntityRespawnPoint are currently invisible (fully transparent) on the client side. Extend GrowingPassiveEntityRespawnPoint and implement UseListener if grown item should not be dragable without special interaction.

Author:

Daniel Herding

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	meanTurnsForRegrow	Tells how many turns it takes in average for a new fruit to become ripe.

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
PassiveEntityRespawnPoint(String growingItemName, int meanTurnsForRegrow)	Creates an item spawner.
PassiveEntityRespawnPoint(String growingItemName, int meanTurnsForRegrow, boolean initOnAdded)	Creates an item spawner.
PassiveEntityRespawnPoint(RPObject object, String growingItemName, int meanTurnsForRegrow)	Creates an item spawner.

Method Summary

Modifier and Type	Method	Description
static void	generateRPClass()
String	getItemName()	Retrieves name of item that is grown/spawned.
protected int	getRandomTurnsForRegrow()
protected void	growNewFruit()	Creates a new fruit.
void	onAdded(StendhalRPZone zone)	Called when this object is added to a zone.
void	onFruitPicked(Item picked)	Is called when a fruit has been picked from this plant grower.
void	onItemPickedUp(Player player)
void	onRemoved(StendhalRPZone zone)	Called when this object is being removed from a zone.
void	onTurnReached(int currentTurn)	This method is called when the turn number is reached.
void	setStartState()
void	setToFullGrowth()

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

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

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, 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

meanTurnsForRegrow

protected int meanTurnsForRegrow

Tells how many turns it takes in average for a new fruit to become ripe.

Constructor Details

PassiveEntityRespawnPoint

public PassiveEntityRespawnPoint(RPObject object,
 String growingItemName,
 int meanTurnsForRegrow)

Creates an item spawner.

Parameters:

object -

growingItemName - Name of item to be spawned.

meanTurnsForRegrow - Average number of turns for item to spawn.

PassiveEntityRespawnPoint

public PassiveEntityRespawnPoint(String growingItemName,
 int meanTurnsForRegrow)

Creates an item spawner.

Parameters:

growingItemName - Name of item to be spawned.

meanTurnsForRegrow - Average number of turns for item to spawn.

PassiveEntityRespawnPoint

public PassiveEntityRespawnPoint(String growingItemName,
 int meanTurnsForRegrow,
 boolean initOnAdded)

Creates an item spawner.

Parameters:

growingItemName - Name of item to be spawned.

meanTurnsForRegrow - Average number of turns for item to spawn.

initOnAdded - If true, sets to full grown and initializes respawn timer when added to zone.

Method Details

generateRPClass

public static void generateRPClass()

onAdded

public void onAdded(StendhalRPZone zone)

Description copied from class: Entity

Called when this object is added to a zone.

Overrides:

onAdded in class Entity

Parameters:

zone - The zone this was added to.

onRemoved

public void onRemoved(StendhalRPZone zone)

Description copied from class: Entity

Called when this object is being removed from a zone.

Overrides:

onRemoved in class Entity

Parameters:

zone - The zone this will be removed from.

onFruitPicked

public void onFruitPicked(Item picked)

Is called when a fruit has been picked from this plant grower.

Parameters:

picked - The fruit that has been picked. Use null for subclasses of PlantGrower that don't use items as fruits.

getRandomTurnsForRegrow

protected int getRandomTurnsForRegrow()

growNewFruit

protected void growNewFruit()

Creates a new fruit.

setToFullGrowth

public void setToFullGrowth()

onTurnReached

public void onTurnReached(int currentTurn)

Description copied from interface: TurnListener

This method is called when the turn number is reached.

Specified by:

onTurnReached in interface TurnListener

Parameters:

currentTurn - current turn number

setStartState

public void setStartState()

onItemPickedUp

public void onItemPickedUp(Player player)

getItemName

public String getItemName()

Retrieves name of item that is grown/spawned.