com.simsilica.es

Interface WatchedEntity

All Superinterfaces:

Entity

All Known Implementing Classes:

DefaultWatchedEntity

public interface WatchedEntity
extends Entity

A specialized entity that can be updated like an EntitySet, thus effectively providing an EntitySet of one. This is useful for monitoring a single entity as one would monitor a set since there is no way to filter an EntitySet by a single ID.

Unlike the entities in an EntitySet, this Entity can actually have null values for some components depending on their current state. The WatchedEntity is watching a specific ID with a subset of its components but is not using the components for any kind of "membership" inclusion (like EntitySet does).

Method Summary

Modifier and Type	Method and Description
boolean	applyChanges() Applies any accumulated changes to this entity since the last time applyChanges() was called and returns true if changes were applied.
boolean	applyChanges(java.util.Set<EntityChange> updates) Applies any accumulated changes to this entity since the last time applyChanges() was called and returns true if changes were applied.
boolean	hasChanges() Returns true if this entity has changes ready to be applied.
void	release() Releases this entity from processing further entity updates.

Methods inherited from interface com.simsilica.es.Entity

get, getComponents, getId, isComplete, set

Method Detail

hasChanges

boolean hasChanges()

Returns true if this entity has changes ready to be applied.

applyChanges

boolean applyChanges()

Applies any accumulated changes to this entity since the last time applyChanges() was called and returns true if changes were applied.

applyChanges

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

Applies any accumulated changes to this entity since the last time applyChanges() was called and returns true if changes were applied. Changes that caused an update will be added to the supplied updates set.

release

void release()

Releases this entity from processing further entity updates. After this call hasChanges() will always return false and applyChanges() will do nothing.