Package org.spongepowered.api.event.block

Interface CollideBlockEvent

All Superinterfaces:

Cancellable, CollideEvent, Event

All Known Subinterfaces:

CollideBlockEvent.Fall, CollideBlockEvent.Impact, CollideBlockEvent.Inside, CollideBlockEvent.Move, CollideBlockEvent.StepOn

public interface CollideBlockEvent
extends CollideEvent

Fired when an Entity collides with a BlockSnapshot.

Note that this event is fired very often. You might want to listen to one of its sub-events instead.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CollideBlockEvent.Fall	Fires when an Entity falls on a block.
static interface	CollideBlockEvent.Impact	Fired when an Entity impacts another BlockSnapshot.
static interface	CollideBlockEvent.Inside	Fires when an Entity is inside a block.
static interface	CollideBlockEvent.Move	Fires when an Entity moves into a block and collides with it.
static interface	CollideBlockEvent.StepOn	Fires when an Entity steps on a block.

Method Summary

Modifier and Type	Method	Description
BlockState	targetBlock()	Gets the target BlockState being interacted with.
ServerLocation	targetLocation()	Gets the target ServerLocation being interacted with.
Direction	targetSide()	Gets the target "side" of the BlockState being interacted with or Direction.NONE if not known.

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

isCancelled, setCancelled

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

cause, context, source

Method Detail

targetLocation

ServerLocation targetLocation()

Gets the target ServerLocation being interacted with.

Returns:

The location

targetBlock

BlockState targetBlock()

Gets the target BlockState being interacted with.

Returns:

The block state

targetSide

Direction targetSide()

Gets the target "side" of the BlockState being interacted with or Direction.NONE if not known.

Returns:

An optional containing the side being interacted with or Direction.NONE