org.spongepowered.api.event.block

Interface ChangeBlockEvent.Pre

All Superinterfaces:

Cancellable, Event

Enclosing interface:

ChangeBlockEvent

public static interface ChangeBlockEvent.Pre
extends Event, Cancellable

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
List<Location<World>>	getLocations() Represents a list of one or more Location's where BlockState changes can occur.

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

getLocations

List<Location<World>> getLocations()

Represents a list of one or more Location's where BlockState changes can occur.

Canceling this event will prevent block logic from running and also stop BlockSnapshot's from being generated.

Note: This event is not intended to always be fired before changing a BlockState but rather it is primarily used to prevent one or more BlockState's from being changed.

Returns:

The immutable list of one or more locations that can change