Package org.spongepowered.api.event.block

Interface ChangeBlockEvent

All Superinterfaces:

Event

All Known Subinterfaces:

ChangeBlockEvent.All, ChangeBlockEvent.Post, ChangeBlockEvent.Pre

public interface ChangeBlockEvent
extends Event

Plain event for when one or many BlockStates may be changing within a ServerWorld. Ideally, the ChangeBlockEvent.All.transactions() will contain a full list in order of which the changes are taking place, but the overall list may not be the full breadth of what changes take place during some complex operations. To record the entirety of all transactions taking place, ChangeBlockEvent.Post provides additional aide with knowing which BlockTransactionReceipts are recorded in a particluar ServerWorld without the additional cost of having multiple events thrown throughout.

To determine whether a particular BlockTransaction is a break, place, modify, etc. please refer to the BlockTransaction.operation()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChangeBlockEvent.All
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 BlockEntity "ticked", the Cause will have the BlockEntity.
static interface	ChangeBlockEvent.Pre	Called before running specific block logic at one or more ServerLocation's such as BlockTypes.WATER.

Method Summary

Modifier and Type	Method	Description
ServerWorld	world()	Gets the world this event is affecting.

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

cause, context, source

Method Details

world

ServerWorld world()

Gets the world this event is affecting.

Returns:

The world encompassing these block changes