pl.isangeles.senlin.core.effect

Class Effects

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Effect>

pl.isangeles.senlin.core.effect.Effects

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Effect>, java.util.Collection<Effect>, java.util.List<Effect>, java.util.RandomAccess, SaveElement

public class Effects
extends java.util.ArrayList<Effect>
implements SaveElement

Container for character effects

Author:

Isangeles

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Effects(Targetable owner) Effects container constructor

Method Summary

Modifier and Type	Method and Description
boolean	add(Effect effect)
boolean	addAll(java.util.Collection<? extends Effect> effects)
void	addAllFrom(EffectSource source) Adds all effects from specified source(only this effects that are NOT already active)
void	clear()
java.util.List<Effect>	get(java.lang.String effectId) Returns all effects with specified ID
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
boolean	hasEffect(Effect effect) Checks if similar effect is already active
boolean	hasEffect(java.lang.String effectId) Checks if effect with specified ID is active
boolean	hasEffectFrom(java.lang.String effectId, java.lang.String sourceEffectId) Checks if effect with specified ID and from source with specified ID is active
java.lang.String	list() Lists all active effects
boolean	remove(Effect effect) Removes and disables specified effect
boolean	removeAll(java.util.List<? extends Effect> effects) Removes and disables all effects from specified list
void	removeAllFrom(EffectSource source) Removes all active effects from specified source
void	update(int delta) Updates all effects in container

Methods inherited from class java.util.ArrayList

add, addAll, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

Effects

public Effects(Targetable owner)

Effects container constructor

Parameters:

owner - owner of this container

Method Detail

add

public boolean add(Effect effect)

Specified by:

add in interface java.util.Collection<Effect>

Specified by:

add in interface java.util.List<Effect>

Overrides:

add in class java.util.ArrayList<Effect>

addAll

public boolean addAll(java.util.Collection<? extends Effect> effects)

Specified by:

addAll in interface java.util.Collection<Effect>

Specified by:

addAll in interface java.util.List<Effect>

Overrides:

addAll in class java.util.ArrayList<Effect>

addAllFrom

public void addAllFrom(EffectSource source)

Adds all effects from specified source(only this effects that are NOT already active)

Parameters:

source - Effect source

remove

public boolean remove(Effect effect)

Removes and disables specified effect

Parameters:

effect - Effect to remove

Returns:

True if specified effect was successfully removed

removeAll

public boolean removeAll(java.util.List<? extends Effect> effects)

Removes and disables all effects from specified list

Parameters:

effects - List with effects

Returns:

True if all effects was successfully removed, false otherwise

removeAllFrom

public void removeAllFrom(EffectSource source)

Removes all active effects from specified source

Parameters:

effectsIds -

source -

update

public void update(int delta)

Updates all effects in container

Parameters:

delta - Time (in milliseconds) from last update

character - Container owner

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Effect>

Specified by:

clear in interface java.util.List<Effect>

Overrides:

clear in class java.util.ArrayList<Effect>

hasEffect

public boolean hasEffect(Effect effect)

Checks if similar effect is already active

Parameters:

effect - Effect to check

Returns:

True if such effect is already active, false otherwise

hasEffect

public boolean hasEffect(java.lang.String effectId)

Checks if effect with specified ID is active

Parameters:

effectId - Effect ID

Returns:

True if effect with specified ID is active, false otherwise

hasEffectFrom

public boolean hasEffectFrom(java.lang.String effectId,
                             java.lang.String sourceEffectId)

Checks if effect with specified ID and from source with specified ID is active

Parameters:

effectId - Effect ID

sourceEffectId - Source ID

Returns:

True if effect is active, false otherwise

get

public java.util.List<Effect> get(java.lang.String effectId)

Returns all effects with specified ID

Parameters:

effectId - Effect ID

Returns:

List with all active effects with specified ID

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

list

public java.lang.String list()

Lists all active effects

Returns:

String with all effects listed