Package net.demilich.metastone.game.spells.desc.filter

Class EntityFilter

java.lang.Object

net.demilich.metastone.game.spells.desc.filter.EntityFilter

All Implemented Interfaces:

java.io.Serializable, HasDesc<EntityFilterDesc>

Direct Known Subclasses:

AmalgamRaceFilter, AndFilter, AttributeFilter, CardFilter, CollectibleFilter, CopiesHaveBeenPlayedFilter, DamagedFilter, EntityEqualsFilter, EntityTypeFilter, HasAttackedFilter, HasEffectsFilter, HasEnchantmentFilter, HasTextFilter, HasTurnEffectsFilter, HealedFilter, HighestAttributeFilter, IsDestroyedFilter, ManaCostFilter, NullFilter, OrFilter, OwnedByPlayerFilter, RaceEqualsFilter, RaceFilter, SameHeroClassFilter, SpecificCardFilter, SpellFilter, StorageContainsFilter, SummonedByPlayerFilter, TargetSelectionFilter, ZoneContainsFilter

public abstract class EntityFilter
extends java.lang.Object
implements java.io.Serializable, HasDesc<EntityFilterDesc>

Filters Entity objects using its test(GameContext, Player, Entity, Entity) implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EntityFilter(EntityFilterDesc desc)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.lang.Object	getArg(EntityFilterArg arg)
EntityFilterDesc	getDesc()
protected java.util.List<Entity>	getTargetedEntities(GameContext context, Player player, Entity host)
boolean	hasArg(EntityFilterArg arg)
<T extends Entity> java.util.function.Predicate<T>	matcher(GameContext context, Player player, Entity host)
boolean	matches(GameContext context, Player player, Entity entity, Entity host)	A method that calls the subclass's test(GameContext, Player, Entity, Entity) implementation that determines whether or not a given entity matches the filter.
void	setDesc(Desc<?,?> desc)
protected abstract boolean	test(GameContext context, Player player, Entity entity, Entity host)	The subclasses of this class implement this method to actually perform the logic of the filtering.

Methods inherited from class java.lang.Object

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

Constructor Details

EntityFilter

public EntityFilter(EntityFilterDesc desc)

Method Details

getDesc

public EntityFilterDesc getDesc()

Specified by:

getDesc in interface HasDesc<EntityFilterDesc>

getArg

public java.lang.Object getArg(EntityFilterArg arg)

hasArg

public boolean hasArg(EntityFilterArg arg)

matcher

public <T extends Entity> java.util.function.Predicate<T> matcher(GameContext context, Player player, Entity host)

matches

@Suspendable public boolean matches(GameContext context, Player player, Entity entity, Entity host)

A method that calls the subclass's test(GameContext, Player, Entity, Entity) implementation that determines whether or not a given entity matches the filter.

EntityFilterArg.TARGET_PLAYER is interpreted as the point of view from which the test(GameContext, Player, Entity, Entity) call is evaluated.

If an EntityFilterArg.AND_CONDITION is specified, the filter's test and the condition must pass. Works The condition uses the player passed into this function, not the EntityFilterArg.TARGET_PLAYER that is potentially specified on this filter. for any filter. The condition uses the player passed into this function, not the EntityFilterArg.TARGET_PLAYER that is potentially specified on this filter.

Parameters:

context -

player -

entity -

host -

Returns:

true if the entity passes the filter, otherwise false.

test

@Suspendable protected abstract boolean test(GameContext context, Player player, Entity entity, Entity host)

The subclasses of this class implement this method to actually perform the logic of the filtering. Observe that results from filtering other entities are not available here; this function is stateless in the sense that an earlier acceptance or rejection of an entity cannot influence the acceptance or rejection of a current entity.

Parameters:

context -

player -

entity -

host -

Returns:

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getTargetedEntities

protected java.util.List<Entity> getTargetedEntities(GameContext context, Player player, Entity host)

setDesc

public void setDesc(Desc<?,?> desc)

Specified by:

setDesc in interface HasDesc<EntityFilterDesc>