net.sf.mud4j.effect
Interface Effect

All Known Subinterfaces:

CharacterEffect, ItemEffect, LocationEffect

All Known Implementing Classes:

AbstractCharacterEffect, AbstractEffect, AbstractItemEffect, AbstractLocationEffect

public interface Effect

Effect to provide addon effects for specific objects.

Author:

Matthew Purland

Method Summary

void	apply() Apply effect on the target.
java.lang.String	getName() Get name of the effect
boolean	hasExpired() Determine if the effect has expired duration.
boolean	isPermanent() Determine if the effect is permanent.
void	undo() Undo the effect from the target.

Method Detail

apply

void apply()
           throws EffectException

Apply effect on the target.

Parameters:

target - Target object to apply effect on.

Throws:

EffectException

undo

void undo()
          throws EffectException

Undo the effect from the target.

Parameters:

target - Target object to remove effect from.

Throws:

EffectException

hasExpired

boolean hasExpired()

Determine if the effect has expired duration.

Returns:

Returns whether the effect has expired yet.

isPermanent

boolean isPermanent()

Determine if the effect is permanent. Permanent status means that the effect cannot be removed.

getName

java.lang.String getName()

Get name of the effect