org.spongepowered.api.event.block

Interface ChangeBlockEvent

All Superinterfaces:

Cancellable, Event

All Known Subinterfaces:

ChangeBlockEvent.Break, ChangeBlockEvent.Decay, ChangeBlockEvent.Grow, ChangeBlockEvent.Modify, ChangeBlockEvent.Place, ChangeBlockEvent.Post, ExplosionEvent.Post, LightningEvent.Strike

public interface ChangeBlockEvent
extends Event, Cancellable

Base event for when BlockStates at Locations are being changed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChangeBlockEvent.Break Called when BlockStates at Locations are being broke.
static interface	ChangeBlockEvent.Decay Called when specific BlockTypes have a notion of "decaying" for various reasons such that the changes are always caused by themselves.
static interface	ChangeBlockEvent.Grow Called when a BlockType decides to "grow" either other blocks or itself or both.
static interface	ChangeBlockEvent.Modify Called when one or more BlockTypes are modified in the world.
static interface	ChangeBlockEvent.Place Called when one or more BlockTypes are added to the world.
static interface	ChangeBlockEvent.Post Called when there are multiple block changes due to a BlockType having "ticked", in which the Cause will have a BlockSnapshot, or, in the case that an Entity has "ticked", in which the Cause will have an Entity, or, in the case that a TileEntity "ticked", the Cause will have the TileEntity.
static interface	ChangeBlockEvent.Pre Called before running specific block logic at one or more Location's such as BlockTypes.FLOWING_WATER.

Method Summary

Modifier and Type	Method and Description
default List<Transaction<BlockSnapshot>>	filter(Predicate<Location<World>> predicate) Applies the provided Predicate to the List of Transactions from getTransactions() such that any time that Predicate.test(Object) returns false on the location of the Transaction, the Transaction is marked as "invalid" and will not apply post event.
default void	filterAll() Invalidates the list as such that all Transactions are marked as "invalid" and will not apply post event.
List<Transaction<BlockSnapshot>>	getTransactions() Gets a list of the Transactions for this event.

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

getCause, getContext, getSource

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

isCancelled, setCancelled

Method Detail

getTransactions

List<Transaction<BlockSnapshot>> getTransactions()

Gets a list of the Transactions for this event. If a transaction is requested to be marked as "invalid", Transaction.setValid(boolean) can be used.

Returns:

The unmodifiable list of transactions

filter

default List<Transaction<BlockSnapshot>> filter(Predicate<Location<World>> predicate)

Applies the provided Predicate to the List of Transactions from getTransactions() such that any time that Predicate.test(Object) returns false on the location of the Transaction, the Transaction is marked as "invalid" and will not apply post event.

Transaction.getOriginal() is used to get the Location

Parameters:

predicate - The predicate to use for filtering

Returns:

The transactions for which the predicate returned false

filterAll

default void filterAll()

Invalidates the list as such that all Transactions are marked as "invalid" and will not apply post event.