Package net.demilich.metastone.game.spells.custom

Class EnvironmentEntityList

java.lang.Object

net.demilich.metastone.game.spells.custom.EnvironmentEntityList

All Implemented Interfaces:

Serializable, Cloneable, EnvironmentValue

public final class EnvironmentEntityList
extends Object
implements EnvironmentValue, Serializable

Stores a list of entities in the environment, instead of on an attribute on an entity.

This class behaves like a multimap of source entity keys and EntityReference values. Use getList(GameContext) to retrieve the general entity list, or use getList(GameContext, Environment) for an entity list named by a particular environment variable.

Use getCards(GameContext, Entity) to get a list of cards associated with a specific source entity.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EnvironmentEntityList()

Method Summary

Modifier and Type	Method	Description
void	add(Entity source, Entity target)
void	clear(Entity source)
List<Card>	getCards(GameContext context, Entity source)	Retrieves a read-only view of a list of cards from this list.
EnvironmentValue	getCopy()
static EnvironmentEntityList	getList(GameContext context)
static EnvironmentEntityList	getList(GameContext context, Environment environmentVariable)
List<EntityReference>	getReferences(Entity source)	Gets a list of referenced cards.

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentEntityList

public EnvironmentEntityList()

Method Details

getList

public static EnvironmentEntityList getList(GameContext context)

Parameters:

context -

Returns:

getList

public static EnvironmentEntityList getList(GameContext context,
 Environment environmentVariable)

getCopy

public EnvironmentValue getCopy()

Specified by:

getCopy in interface EnvironmentValue

add

public void add(Entity source,
 Entity target)

clear

public void clear(Entity source)

getReferences

public List<EntityReference> getReferences(Entity source)

Gets a list of referenced cards. This reference will always reflect the underlying list as it gets changed, but is not mutable

Parameters:

source -

Returns:

See Also:

• to mutate this list.

getCards

public List<Card> getCards(GameContext context,
 Entity source)

Retrieves a read-only view of a list of cards from this list.

Parameters:

context -

source -

Returns: