org.spongepowered.api.event.block

Interface NotifyNeighborBlockEvent

All Superinterfaces:

Cancellable, Event

public interface NotifyNeighborBlockEvent
extends Event, Cancellable

Called when a block triggers an update to neighboring {link BlockType}s in one or more Directions. There is a way to mark an "update" as being "invalid" or "cancelled": filterDirections(Predicate) will apply a Predicate such that if the predicate returns false, the Direction will be removed from the getNeighbors() map.

Method Summary

Modifier and Type	Method and Description
void	filterDirections(Predicate<Direction> predicate) Filters out Directions of the BlockStates to be marked as "valid" after this event.
Map<Direction,BlockState>	getNeighbors() Gets an immutable Map of Direction to BlockState of the BlockType that will be notified of an update.
Map<Direction,BlockState>	getOriginalNeighbors() Gets the immutable Map of Direction to BlockState of the BlockType that would normally be notified of changes.

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

getOriginalNeighbors

Map<Direction,BlockState> getOriginalNeighbors()

Gets the immutable Map of Direction to BlockState of the BlockType that would normally be notified of changes.

Returns:

The original directions map

getNeighbors

Map<Direction,BlockState> getNeighbors()

Gets an immutable Map of Direction to BlockState of the BlockType that will be notified of an update. If a Direction is not required or needing to be excluded from an update, filterDirections(Predicate) will perform that exclusion.

Returns:

The map

filterDirections

void filterDirections(Predicate<Direction> predicate)

Filters out Directions of the BlockStates to be marked as "valid" after this event. If the Predicate.test(Object) returns false, the BlockState is removed from getNeighbors() map.

Parameters:

predicate - The predicate to use for filtering.