Package org.spongepowered.api.event.impl.entity

Class AbstractAffectEntityEvent

java.lang.Object

org.spongepowered.api.event.impl.AbstractEvent

org.spongepowered.api.event.impl.entity.AbstractAffectEntityEvent

All Implemented Interfaces:

Cancellable, AffectEntityEvent, Event

Direct Known Subclasses:

AbstractDetonateEvent, AbstractSpawnEntityEvent

public abstract class AbstractAffectEntityEvent
extends AbstractEvent
implements AffectEntityEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Entity>	entities
protected List<EntitySnapshot>	entitySnapshots

Fields inherited from class org.spongepowered.api.event.impl.AbstractEvent

currentOrder

Constructor Summary

Constructors

Constructor	Description
AbstractAffectEntityEvent()

Method Summary

Modifier and Type	Method	Description
List<Entity>	entities()	Gets the List of entities who will be affected after event resolution.
List<EntitySnapshot>	entitySnapshots()	Gets an List of the entity data un-affected by event changes.
void	filterEntities(Predicate<Entity> predicate)	Filters out Entity's from AffectEntityEvent.entities() to be affected by this event.

Methods inherited from class org.spongepowered.api.event.impl.AbstractEvent

init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.event.entity.AffectEntityEvent

filterEntityLocations

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Methods inherited from interface org.spongepowered.api.event.Event

cause, context, source

Field Details

entities

protected List<Entity> entities

entitySnapshots

protected List<EntitySnapshot> entitySnapshots

Constructor Details

AbstractAffectEntityEvent

public AbstractAffectEntityEvent()

Method Details

entitySnapshots

public List<EntitySnapshot> entitySnapshots()

Description copied from interface: AffectEntityEvent

Gets an List of the entity data un-affected by event changes.

This method MUST be called at Order.PRE in order to be properly initialized, after which it can be called at any time. If it is not first called at Order.PRE, it will throw an IllegalStateException when invoked.

Specified by:

entitySnapshots in interface AffectEntityEvent

Returns:

The ImmutableList

entities

public List<Entity> entities()

Description copied from interface: AffectEntityEvent

Gets the List of entities who will be affected after event resolution. This list can only be modified using AffectEntityEvent.filterEntities(Predicate).

Specified by:

entities in interface AffectEntityEvent

Returns:

The list of entities that will be affected.

filterEntities

public void filterEntities(Predicate<Entity> predicate)

Description copied from interface: AffectEntityEvent

Filters out Entity's from AffectEntityEvent.entities() to be affected by this event.

Entities for which the predicate returns false will be removed from AffectEntityEvent.entities().

Specified by:

filterEntities in interface AffectEntityEvent

Parameters:

predicate - The predicate to use for filtering