org.spongepowered.api.event.block

Interface InteractBlockEvent.Secondary

All Superinterfaces:

Cancellable, Event, HandInteractEvent, InteractBlockEvent, InteractEvent, TargetBlockEvent

All Known Subinterfaces:

InteractBlockEvent.Secondary.MainHand, InteractBlockEvent.Secondary.OffHand

Enclosing interface:

InteractBlockEvent

public static interface InteractBlockEvent.Secondary
extends InteractBlockEvent, HandInteractEvent

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 and Description
static interface	InteractBlockEvent.Secondary.MainHand A InteractBlockEvent.Secondary event where the interaction is from the client's main hand.
static interface	InteractBlockEvent.Secondary.OffHand A InteractBlockEvent.Secondary event where the interaction is from the client's off hand.

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

InteractBlockEvent.Primary, InteractBlockEvent.Secondary

Method Summary

Modifier and Type	Method and Description
Tristate	getOriginalUseBlockResult() Gets the original getUseBlockResult().
Tristate	getOriginalUseItemResult()
Tristate	getUseBlockResult() Gets whether the interacted BlockSnapshot should be used.
Tristate	getUseItemResult() Gets whether the ArmorEquipable.getItemInHand(org.spongepowered.api.data.type.HandType) should be used.
void	setUseBlockResult(Tristate result) Sets whether the interacted BlockSnapshot should be used.
void	setUseItemResult(Tristate result) Sets whether the ArmorEquipable.getItemInHand(org.spongepowered.api.data.type.HandType) should be used.

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

getTargetSide

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

getTargetBlock

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.HandInteractEvent

getHandType

Methods inherited from interface org.spongepowered.api.event.action.InteractEvent

getInteractionPoint

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

getOriginalUseItemResult

Tristate getOriginalUseItemResult()

getOriginalUseBlockResult

Tristate getOriginalUseBlockResult()

Gets the original getUseBlockResult().

Returns:

The original getUseBlockResult()

getUseItemResult

Tristate getUseItemResult()

Gets whether the ArmorEquipable.getItemInHand(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.getItemInHand(org.spongepowered.api.data.type.HandType) should be used

getUseBlockResult

Tristate getUseBlockResult()

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

setUseItemResult

void setUseItemResult(Tristate result)

Sets whether the ArmorEquipable.getItemInHand(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.

Parameters:

result - Whether the ArmorEquipable.getItemInHand(org.spongepowered.api.data.type.HandType) should be used

setUseBlockResult

void setUseBlockResult(Tristate result)

Sets 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.

Parameters:

result - Whether the interacted BlockSnapshot should be used