com.simsilica.es

Interface EntitySet

All Superinterfaces:

java.util.Collection<Entity>, java.lang.Iterable<Entity>, java.util.Set<Entity>

All Known Implementing Classes:

DefaultEntitySet

public interface EntitySet
extends java.util.Set<Entity>

A set of entities that possess certain components with automatic updates as the entity components change.

Method Summary

Modifier and Type	Method and Description
boolean	applyChanges() Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes.
boolean	applyChanges(java.util.Set<EntityChange> updates) Deprecated. Changes collected this way are not accurate and this method will be removed in the next version. The signature is kept only for compile-time compatibility as all of the implementations now ignore the updates argument.
void	clearChangeSets() Clears all pending change sets accumulated during the last applyChanges().
boolean	containsId(EntityId id) Returns true if this set contains the entity with the specified ID.
java.util.Set<Entity>	getAddedEntities() Returns the entities that were added during applyChanges().
java.util.Set<Entity>	getChangedEntities() Returns the entities that were changed during applyChanges().
Entity	getEntity(EntityId id) Returns this set's version of the Entity for the specified ID or null if this set does not contain the specified entity.
java.util.Set<EntityId>	getEntityIds() Returns all of the EntityIds currently in this set.
java.util.Set<Entity>	getRemovedEntities() Returns the entities that were removed during applyChanges().
boolean	hasChanges() Returns true if there were entity changes during the last applyChanges().
boolean	hasType(java.lang.Class type) Returns true if this EntitySet is made of entities that have the specified type of component.
void	release() Releases this entity set from processing further entity updates.
void	resetFilter(ComponentFilter filter) Swaps out the current main filter for a new one.

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

resetFilter

void resetFilter(ComponentFilter filter)

Swaps out the current main filter for a new one. The changes will show up the next time applyChanges() is called.

containsId

boolean containsId(EntityId id)

Returns true if this set contains the entity with the specified ID.

getEntityIds

java.util.Set<EntityId> getEntityIds()

Returns all of the EntityIds currently in this set.

getEntity

Entity getEntity(EntityId id)

Returns this set's version of the Entity for the specified ID or null if this set does not contain the specified entity.

getAddedEntities

java.util.Set<Entity> getAddedEntities()

Returns the entities that were added during applyChanges().

getChangedEntities

java.util.Set<Entity> getChangedEntities()

Returns the entities that were changed during applyChanges().

getRemovedEntities

java.util.Set<Entity> getRemovedEntities()

Returns the entities that were removed during applyChanges().

clearChangeSets

void clearChangeSets()

Clears all pending change sets accumulated during the last applyChanges(). The change sets are automatically cleared at the beginning of the next applyChanges() but sometimes it can be useful to free them early (if the change set is large, etc.).

hasChanges

boolean hasChanges()

Returns true if there were entity changes during the last applyChanges().

applyChanges

boolean applyChanges()

Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes.

applyChanges

boolean applyChanges(java.util.Set<EntityChange> updates)

Deprecated. Changes collected this way are not accurate and this method will be removed in the next version. The signature is kept only for compile-time compatibility as all of the implementations now ignore the updates argument.

Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes. Changes that caused an update (not an add or a remove) will be added to the supplied updates set.

release

void release()

Releases this entity set from processing further entity updates. The entities contained in the set will remain until garbage collected normally or until clear() is called.

hasType

boolean hasType(java.lang.Class type)

Returns true if this EntitySet is made of entities that have the specified type of component.