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.
import crafttweaker.forge.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 BlockPosmyPlayerInteractEvent.blockPos
Return Type:
BlockPos
cancel()
Cancels the event. Same as script.zs
setCanceled(true)// PlayerInteractEvent.cancel();myPlayerInteractEvent.cancel();Getter
// PlayerInteractEvent.cancelable as boolmyPlayerInteractEvent.cancelable
Return Type:
bool
cancelable() as bool
// PlayerInteractEvent.cancelable() as bool;myPlayerInteractEvent.cancelable();
Return Type:
bool
Getter
// PlayerInteractEvent.canceled as boolmyPlayerInteractEvent.canceled
Return Type:
bool
Setter
// PlayerInteractEvent.canceled = (cancel as bool);myPlayerInteractEvent.canceled = myBool;Parameters:
cancel: bool Type: bool canceled() as bool
// PlayerInteractEvent.canceled() as bool;myPlayerInteractEvent.canceled();
Return Type:
bool
canceled(cancel as bool)
// PlayerInteractEvent.canceled(cancel as bool);myPlayerInteractEvent.canceled(myBool);Parameters:
cancel: bool Type: bool Getter
// PlayerInteractEvent.cancellationResult as InteractionResultmyPlayerInteractEvent.cancellationResult
Return Type:
InteractionResult
Setter
Set the EnumActionResult that will be returned to vanilla if the event is cancelled, instead of calling the relevant method of the event.
Note that this only has an effect on RightClickBlockEvent, RightClickItemEvent, EntityInteractEvent.script.zs
Note that this only has an effect on RightClickBlockEvent, RightClickItemEvent, EntityInteractEvent.
// PlayerInteractEvent.cancellationResult = (result as InteractionResult);myPlayerInteractEvent.cancellationResult = myInteractionResult;Parameters:
result: InteractionResult Type: InteractionResult Getter
// PlayerInteractEvent.entity as PlayermyPlayerInteractEvent.entity
Return Type:
Player
Getter
// PlayerInteractEvent.entity as LivingEntitymyPlayerInteractEvent.entity
Return Type:
LivingEntity
Getter
// PlayerInteractEvent.entity as EntitymyPlayerInteractEvent.entity
Return Type:
Entity
Getter
The face involved in this interaction. For all non-block interactions, this will return nullscript.zs
// PlayerInteractEvent.face as DirectionmyPlayerInteractEvent.face
Return Type:
Direction
Getter
// PlayerInteractEvent.hand as InteractionHandmyPlayerInteractEvent.hand
Return Type:
InteractionHand
Getter
// PlayerInteractEvent.hasResult as boolmyPlayerInteractEvent.hasResult
Return Type:
bool
hasResult() as bool
// PlayerInteractEvent.hasResult() as bool;myPlayerInteractEvent.hasResult();
Return Type:
bool
Getter
The stack involved in this interaction. May be empty, but will never be null.script.zs
// PlayerInteractEvent.itemStack as IItemStackmyPlayerInteractEvent.itemStack
Return Type:
IItemStack
Getter
// PlayerInteractEvent.result as ResultmyPlayerInteractEvent.result
Return Type:
EventResult
Setter
// PlayerInteractEvent.result = (result as Result);myPlayerInteractEvent.result = myResult;Parameters:
result: EventResult Type: EventResult result() as Result
// PlayerInteractEvent.result() as Result;myPlayerInteractEvent.result();
Return Type:
EventResult
result(result as Result)
// PlayerInteractEvent.result(result as Result);myPlayerInteractEvent.result(myResult);Parameters:
result: EventResult Type: EventResult setAllow()
sets the event's result to script.zs
allow// PlayerInteractEvent.setAllow();myPlayerInteractEvent.setAllow();setDefault()
sets the event's result to script.zs
default// PlayerInteractEvent.setDefault();myPlayerInteractEvent.setDefault();setDeny()
sets the event's result to script.zs
deny// PlayerInteractEvent.setDeny();myPlayerInteractEvent.setDeny();