Package games.stendhal.server.entity.mapstuff.useable

Class PlayerActivityEntity

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.useable.UseableEntity

games.stendhal.server.entity.mapstuff.useable.PlayerActivityEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

CoalSource, FishSource, GoldSource, WaterSpringSource, WellSource

public abstract class PlayerActivityEntity
extends UseableEntity

An entity that performs some activity for a player. The activity takes some time to perform and can succeed or fail. The player must be standing next to the entity when it finished to succeed. The activity must finish before being initiated again.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	PlayerActivityEntity.Activity	An occurrence of activity.

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

RPObject.ID

Field Summary

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
PlayerActivityEntity()	Create a player activity entity.

Method Summary

Modifier and Type	Method	Description
protected void	activityDone(Player player)	Process the results of the activity.
protected abstract int	getDuration()	Get the time it takes to perform this activity.
protected boolean	isPenalized(Player player)	Check for excessive usage
protected abstract boolean	isPrepared(Player player)	Decides if the activity can be done.
protected abstract boolean	isSuccessful(Player player)	Decides if the activity was successful.
protected abstract void	onFinished(Player player, boolean successful)	Called when the activity has finished.
protected abstract void	onStarted(Player player)	Called when the activity has started.
boolean	onUsed(RPEntity entity)	Is called when a player initiates the activity.

Methods inherited from class games.stendhal.server.entity.mapstuff.useable.UseableEntity

generateRPClass, getState, setState

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, onAdded, onMoved, onRemoved, 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

Constructor Details

PlayerActivityEntity

public PlayerActivityEntity()

Create a player activity entity.

Method Details

activityDone

protected void activityDone(Player player)

Process the results of the activity.

Parameters:

player - The player that performed the activity.

getDuration

protected abstract int getDuration()

Get the time it takes to perform this activity.

Returns:

The time to perform the activity (in seconds).

isPrepared

protected abstract boolean isPrepared(Player player)

Decides if the activity can be done.

Parameters:

player - for whom to perform the activity

Returns:

true if can be done

isSuccessful

protected abstract boolean isSuccessful(Player player)

Decides if the activity was successful.

Parameters:

player - for whom to perform the activity

Returns:

true if successful.

onFinished

protected abstract void onFinished(Player player,
 boolean successful)

Called when the activity has finished.

Parameters:

player - The player that did the activity.

successful - If the activity was successful.

onStarted

protected abstract void onStarted(Player player)

Called when the activity has started.

Parameters:

player - The player starting the activity.

isPenalized

protected boolean isPenalized(Player player)

Check for excessive usage

Parameters:

player - The player starting the activity.

Returns:

true if the usage was excessive

onUsed

public boolean onUsed(RPEntity entity)

Is called when a player initiates the activity.

Parameters:

entity - The initiating entity.

Returns:

true if the entity was used.