rle.core.charm
Class TimedCharm

java.lang.Object
  rle.core.charm.CharmBase
      rle.core.charm.TimedCharm

All Implemented Interfaces:

Charm, TemporaryCharm, GameClockListener

public class TimedCharm
extends CharmBase
implements TemporaryCharm, GameClockListener

A TimedCharm is a TemporaryCharm which is active for a fixed period of time before stopping itself. Examples include speed due to quaffing a potion of speed and being temporarily blinded by a flash of light.

Constructor Summary

TimedCharm(Thing target, java.util.Map<java.lang.String,java.lang.Object> attributes, int ticks, Cause cause)

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	attributes() Any attributes used to direct the course of this TemporaryCharm.
Cause	cause() The cause of this charm, for example quaffing a potion of speed.
void	startCharm() Start this charm.
void	stopCharm(Cause stopCause) End any affects caused by this charm.
void	tick(GameClockEvent event) Respond to time elapsing.

Methods inherited from class rle.core.charm.CharmBase

getAttributes, getCause, getTarget, setAttributes, setCause, setTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface rle.core.charm.Charm

getAttributes, getCause, getTarget, setAttributes, setCause, setTarget

Constructor Detail

TimedCharm

public TimedCharm(Thing target,
                  java.util.Map<java.lang.String,java.lang.Object> attributes,
                  int ticks,
                  Cause cause)

Method Detail

startCharm

public void startCharm()

Start this charm. Generally, this may include affecting the RuntimeData of the target of the charm and possibly adding a listener to end or otherwise affect the course of this charm.

Specified by:

startCharm in interface Charm

stopCharm

public void stopCharm(Cause stopCause)

End any affects caused by this charm. This can be called by a mechanism invoked by startCharm, such as a time-out on a duration charm, or because of some event external to the charm, such as a poison charm being cured by the player quaffing a healing potion. Whatever the case, this method must remove any listeners added by startCharm().

Specified by:

stopCharm in interface TemporaryCharm

cause

public Cause cause()

The cause of this charm, for example quaffing a potion of speed.

Returns:

attributes

public java.util.Map<java.lang.String,java.lang.Object> attributes()

Any attributes used to direct the course of this TemporaryCharm.

tick

public void tick(GameClockEvent event)

Respond to time elapsing.

Specified by:

tick in interface GameClockListener