PlayerInteractEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.neoforge.api.interact.PlayerInteractEvent;

Description

This event is the superclass of all other PlayerInteract events. Generally, you want to use the subtypes of this event.

Extends

PlayerInteractEvent extends PlayerEvent.

Members

Getter
If the interaction was on an entity, will be a BlockPos centered on the entity. If the interaction was on a block, will be the position of that block. Otherwise, will be a BlockPos centered on the player.
script.zs
// PlayerInteractEvent.blockPos as BlockPos
myPlayerInteractEvent.blockPos

Return Type: BlockPos

Getter
script.zs
// PlayerInteractEvent.entity as Player
myPlayerInteractEvent.entity

Return Type: Player

Getter
script.zs
// PlayerInteractEvent.entity as LivingEntity
myPlayerInteractEvent.entity

Return Type: LivingEntity

Getter
script.zs
// PlayerInteractEvent.entity as Entity
myPlayerInteractEvent.entity

Return Type: Entity

Getter
The face involved in this interaction. For all non-block interactions, this will return null
script.zs
// PlayerInteractEvent.face as Direction
myPlayerInteractEvent.face

Return Type: Direction

Getter
script.zs
// PlayerInteractEvent.hand as InteractionHand
myPlayerInteractEvent.hand

Return Type: InteractionHand

Getter
The stack involved in this interaction. May be empty, but will never be null.
script.zs
// PlayerInteractEvent.itemStack as IItemStack
myPlayerInteractEvent.itemStack

Return Type: IItemStack