Package org.spongepowered.api.event.block

Interface InteractBlockEvent.Secondary

All Superinterfaces:

Event, InteractBlockEvent, InteractEvent

All Known Subinterfaces:

InteractBlockEvent.Secondary.Post, InteractBlockEvent.Secondary.Pre

Enclosing interface:

InteractBlockEvent

public static interface InteractBlockEvent.Secondary
extends InteractBlockEvent

An event where the targeted block is being interacted with the client's "secondary" button.

This is usually right-click.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InteractBlockEvent.Secondary.Post
static interface	InteractBlockEvent.Secondary.Pre

Nested classes/interfaces inherited from interface org.spongepowered.api.event.block.InteractBlockEvent

InteractBlockEvent.Primary, InteractBlockEvent.Secondary

Method Summary

Modifier and Type	Method	Description
Vector3d	interactionPoint()	Gets the point of interaction where the interaction occurred as a Vector3d.
Tristate	originalUseBlockResult()	Gets the original useBlockResult().
Tristate	originalUseItemResult()
Tristate	useBlockResult()	Gets whether the interacted BlockSnapshot should be used.
Tristate	useItemResult()	Gets whether the ArmorEquipable.itemInHand(java.util.function.Supplier<? extends org.spongepowered.api.data.type.HandType>) should be used.

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

cause, context, source

Methods inherited from interface org.spongepowered.api.event.block.InteractBlockEvent

block, targetSide

Method Details

originalUseItemResult

Tristate originalUseItemResult()

originalUseBlockResult

Tristate originalUseBlockResult()

Gets the original useBlockResult().

Returns:

The original useBlockResult()

useItemResult

Tristate useItemResult()

Gets whether the ArmorEquipable.itemInHand(java.util.function.Supplier<? extends org.spongepowered.api.data.type.HandType>) should be used.

• FALSE: The ItemStack will never be used.
• UNDEFINED: The ItemStack will be used if the block fails.
• TRUE: The ItemStack will always be used.

Note: These results may differ depending on implementation.

Returns:

Whether the ArmorEquipable.itemInHand(java.util.function.Supplier<? extends org.spongepowered.api.data.type.HandType>) should be used

useBlockResult

Tristate useBlockResult()

Gets whether the interacted BlockSnapshot should be used.

• FALSE: BlockSnapshot will never be used.
• UNDEFINED: BlockSnapshot will be used as normal.
• TRUE: BlockSnapshot will always be used.

Note: These results may differ depending on implementation.

Returns:

Whether the interacted BlockSnapshot should be used

interactionPoint

Vector3d interactionPoint()

Gets the point of interaction where the interaction occurred as a Vector3d.

Returns:

The interaction point