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

Class CoalSource

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

games.stendhal.server.entity.mapstuff.useable.CoalSource

All Implemented Interfaces:

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

public class CoalSource
extends PlayerActivityEntity

A coal source is a spot where a player can pick for coal. He needs a pick, time, and luck. Picking coals takes 7-11 seconds; during this time, the player keep standing next to the coal source. In fact, the player only has to be there when the prospecting action has finished. Therefore, make sure that two sources are always at least 5 sec of walking away from each other, so that the player can't prospect at several sites simultaneously.

Author:

hendrik

Nested Class Summary

Nested classes/interfaces inherited from class games.stendhal.server.entity.mapstuff.useable.PlayerActivityEntity

PlayerActivityEntity.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
CoalSource()	Create a gold source.
CoalSource(String itemName)	Create a coal source.

Method Summary

Modifier and Type	Method	Description
protected int	getDuration()	Get the time it takes to perform this activity.
String	getName()	source name.
protected boolean	isPrepared(Player player)	Decides if the activity can be done.
protected boolean	isSuccessful(Player player)	Decides if the activity was successful.
protected void	onFinished(Player player, boolean successful)	Called when the activity has finished.
protected void	onStarted(Player player)	Called when the activity has started.

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

activityDone, isPenalized, onUsed

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

CoalSource

public CoalSource()

Create a gold source.

CoalSource

public CoalSource(String itemName)

Create a coal source.

Parameters:

itemName - The name of the item to be prospected.

Method Details

getName

public String getName()

source name.

Specified by:

getName in interface Killer

Overrides:

getName in class Entity

Returns:

name

getDuration

protected int getDuration()

Get the time it takes to perform this activity.

Specified by:

getDuration in class PlayerActivityEntity

Returns:

The time to perform the activity (in seconds).

isPrepared

protected boolean isPrepared(Player player)

Decides if the activity can be done.

Specified by:

isPrepared in class PlayerActivityEntity

Parameters:

player - for whom to perform the activity

Returns:

true if successful.

isSuccessful

protected boolean isSuccessful(Player player)

Decides if the activity was successful.

Specified by:

isSuccessful in class PlayerActivityEntity

Parameters:

player - for whom to perform the activity

Returns:

true if successful.

onFinished

protected void onFinished(Player player,
 boolean successful)

Called when the activity has finished.

Specified by:

onFinished in class PlayerActivityEntity

Parameters:

player - The player that did the activity.

successful - If the activity was successful.

onStarted

protected void onStarted(Player player)

Called when the activity has started.

Specified by:

onStarted in class PlayerActivityEntity

Parameters:

player - The player starting the activity.