PlayerInteractEntity

Link to playerinteractentity

The PlayerInteractEntity Event is fired whenever a player interacts with an Entity. It can be canceled to prevent the interaction from taking place. If the event is canceled, a specific result of success, fail or pass can be provided. By default, the result is pass.

You will need to cast the event in the function header as this class:
crafttweaker.event.PlayerInteractEntityEvent
You can, of course, also import the class before and use that name then.

Event interface extensions

Link to event-interface-extensions

PlayerInteractEntity Events implement the following interfaces and are able to call all of their methods/getters/setters as well:

ZenGetters & ZenSetters

Link to zengetters--zensetters

The following information can be retrieved from the event:

ZenGetterZenSettersReturn Type
ZenGetter
player
ZenSetters
Return Type
IPlayer
ZenGetter
target
ZenSetters
Return Type
IEntity
ZenGetter
cancellationResult
ZenSetters
cancellationResult
Return Type
string ("success" / "pass" / "fail")
  • event.cancel() sets the event as cancelled.