pl.isangeles.senlin.core.effect

Class Effect

java.lang.Object

pl.isangeles.senlin.core.effect.Effect

All Implemented Interfaces:

SaveElement

public class Effect
extends java.lang.Object
implements SaveElement

Class for effects used by items, skills, etc.

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
Effect(java.lang.String id, org.newdawn.slick.Image iconImg, Modifiers bonuses, int dot, int duration, EffectType type, EffectSource source, org.newdawn.slick.GameContainer gc) Effect constructor
Effect(java.lang.String id, org.newdawn.slick.Image iconImg, Modifiers bonuses, int dot, int duration, EffectType type, java.lang.String savedOwnerId, java.lang.String savedSourceId, org.newdawn.slick.GameContainer gc) Effect constructor(with saved source ID)

Method Summary

Modifier and Type	Method and Description
void	affect(Targetable target) Starts affect on specified character
int	getDuration()
java.lang.String	getId() Returns effect Id
java.lang.String	getInfo() Returns effect info
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
EffectSource	getSource() Returns source of this effect(may return NULl)
java.lang.String	getSourceId() Returns string with effect ID and source ID
EffectTile	getTile() Returns effect UI icon
int	getTime() Returns current effect time
EffectType	getType() Returns effect type
boolean	isOn()
void	removeFrom(Targetable target) Removes affect from specified character
void	setTime(int timeInMillis) Sets current effect time
boolean	turnOn(Targetable target) Starts effect timer
void	updateTime(int delta) Updates effect time

Methods inherited from class java.lang.Object

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

Constructor Detail

Effect

public Effect(java.lang.String id,
              org.newdawn.slick.Image iconImg,
              Modifiers bonuses,
              int dot,
              int duration,
              EffectType type,
              EffectSource source,
              org.newdawn.slick.GameContainer gc)
       throws org.newdawn.slick.SlickException,
              java.io.IOException,
              java.awt.FontFormatException

Effect constructor

Parameters:

id - Effect ID

imgName - Effect icon image name

bonuses - Effect bonuses

dot - Damage over time

duration - Effect duration

type - Effect Type

source - Effect source, e.g. skill or item

gc - Slick game container

Throws:

org.newdawn.slick.SlickException

java.io.IOException

java.awt.FontFormatException

Effect

public Effect(java.lang.String id,
              org.newdawn.slick.Image iconImg,
              Modifiers bonuses,
              int dot,
              int duration,
              EffectType type,
              java.lang.String savedOwnerId,
              java.lang.String savedSourceId,
              org.newdawn.slick.GameContainer gc)
       throws org.newdawn.slick.SlickException,
              java.io.IOException,
              java.awt.FontFormatException

Effect constructor(with saved source ID)

Parameters:

id - Effect ID

imgName - Effect icon image name

bonuses - Effect bonuses

dot - Damage over time

duration - Effect duration

type - Effect Type

savedSourceId - Saved serial ID of effect source(source restored later in update)

gc - Slick game container

Throws:

org.newdawn.slick.SlickException

java.io.IOException

java.awt.FontFormatException

Method Detail

affect

public void affect(Targetable target)

Starts affect on specified character

Parameters:

character - Some game character

removeFrom

public void removeFrom(Targetable target)

Removes affect from specified character

Parameters:

target - Some game character

getDuration

public int getDuration()

getType

public EffectType getType()

Returns effect type

Returns:

Effect type enumeration

isOn

public boolean isOn()

updateTime

public void updateTime(int delta)

Updates effect time

Parameters:

delta - Time from last game loop update

turnOn

public boolean turnOn(Targetable target)

Starts effect timer

setTime

public void setTime(int timeInMillis)

Sets current effect time

Parameters:

timeInMillis - Time in milliseconds

getTime

public int getTime()

Returns current effect time

Returns:

Effect time in milliseconds

getTile

public EffectTile getTile()

Returns effect UI icon

Returns:

EffectTile object

getId

public java.lang.String getId()

Returns effect Id

Returns:

String with effect ID

getSourceId

public java.lang.String getSourceId()

Returns string with effect ID and source ID

Returns:

String with effect and source IDs

getSource

public EffectSource getSource()

Returns source of this effect(may return NULl)

Returns:

Effect source

getInfo

public java.lang.String getInfo()

Returns effect info

Returns:

String with effect info

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Description copied from interface: SaveElement

Parses object to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - XML document for save game

Returns:

XML document element