Home Commands Examples Getting Started With Scripts Global Keywords
EntityInteractEvent EntityInteractSpecificEvent LeftClickBlockEvent LeftClickEmptyEvent PlayerInteractEvent RightClickBlockEvent RightClickEmptyEvent RightClickItemEvent
DetonateExplosionEvent DifficultyChangeEvent Event EventResult ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
LeftClickEmptyEvent RightClickBlockEvent
Next

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

blockPos
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

entity
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

face
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

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

Return Type: InteractionHand

hasResult
Getter
script.zs
// PlayerInteractEvent.hasResult as bool
myPlayerInteractEvent.hasResult

Return Type: bool

hasResult() as bool
script.zs
// PlayerInteractEvent.hasResult() as bool;
myPlayerInteractEvent.hasResult();

Return Type: bool

itemStack
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

result
Getter
script.zs
// PlayerInteractEvent.result as EventResult
myPlayerInteractEvent.result

Return Type: EventResult

Setter
script.zs
// PlayerInteractEvent.result = (result as EventResult);
myPlayerInteractEvent.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// PlayerInteractEvent.result() as EventResult;
myPlayerInteractEvent.result();

Return Type: EventResult

result(result as Result)
script.zs
// PlayerInteractEvent.result(result as EventResult);
myPlayerInteractEvent.result(myResult);

Parameters:

result Type: EventResult
setAllow
setAllow()
sets the event's result to allow
script.zs
// PlayerInteractEvent.setAllow();
myPlayerInteractEvent.setAllow();
setDefault
setDefault()
sets the event's result to default
script.zs
// PlayerInteractEvent.setDefault();
myPlayerInteractEvent.setDefault();
setDeny
setDeny()
sets the event's result to deny
script.zs
// PlayerInteractEvent.setDeny();
myPlayerInteractEvent.setDeny();
Previous
LeftClickEmptyEvent RightClickBlockEvent
Next