pl.isangeles.senlin.core.action

Class EffectAction

java.lang.Object

pl.isangeles.senlin.core.action.Action

pl.isangeles.senlin.core.action.EffectAction

All Implemented Interfaces:

EffectSource

public class EffectAction
extends Action
implements EffectSource

Class for action causing specified effect on user/target

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
EffectAction() Default effect action constructor(action from this constructor do nothing)
EffectAction(java.lang.String effectOnActionId, java.lang.String target) Constructor for action causing specified effect on user/target

Method Summary

Modifier and Type	Method and Description
Effect	getEffect(java.lang.String effectId) Return new instance of effect with specified ID from skill effects list
java.util.Collection<Effect>	getEffects() Returns all effects from this source
java.util.List<java.lang.String>	getEffectsIds() Returns list with all IDs of effects from this skill
java.lang.String	getId() Returns source ID
Targetable	getOwner() Return effect source owner
java.lang.String	getSerialId() Returns source serial ID
boolean	start(Targetable user, Targetable target) Starts action

Methods inherited from class pl.isangeles.senlin.core.action.Action

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectAction

public EffectAction()

Default effect action constructor(action from this constructor do nothing)

EffectAction

public EffectAction(java.lang.String effectOnActionId,
                    java.lang.String target)

Constructor for action causing specified effect on user/target

Parameters:

effectOnAction - Effect of action

target - String with 'user' for effect on user, 'target' for effect on target

Method Detail

start

public boolean start(Targetable user,
                     Targetable target)

Starts action

Specified by:

start in class Action

Parameters:

user - Action user

target - User target

Returns:

getId

public java.lang.String getId()

Description copied from interface: EffectSource

Returns source ID

Specified by:

getId in interface EffectSource

Returns:

String with effect source ID

getSerialId

public java.lang.String getSerialId()

Description copied from interface: EffectSource

Returns source serial ID

Specified by:

getSerialId in interface EffectSource

Returns:

String with effect source ID

getOwner

public Targetable getOwner()

Description copied from interface: EffectSource

Return effect source owner

Specified by:

getOwner in interface EffectSource

Returns:

Targetable object

getEffects

public java.util.Collection<Effect> getEffects()

Description copied from interface: EffectSource

Returns all effects from this source

Specified by:

getEffects in interface EffectSource

Returns:

Collection with effects

getEffect

public Effect getEffect(java.lang.String effectId)

Description copied from interface: EffectSource

Return new instance of effect with specified ID from skill effects list

Specified by:

getEffect in interface EffectSource

Parameters:

effectId - ID of desired effect

Returns:

New instance of effect with specified ID or null if there is no such effect in skill effects list

getEffectsIds

public java.util.List<java.lang.String> getEffectsIds()

Description copied from interface: EffectSource

Returns list with all IDs of effects from this skill

Specified by:

getEffectsIds in interface EffectSource

Returns:

List with effects IDs