PlayerEvent
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.event.entity.player.PlayerEvent;Extends
PlayerEvent extends LivingEvent.
Members
cancel()
Cancels the event. Same as script.zs
setCanceled(true)// PlayerEvent.cancel();myPlayerEvent.cancel();Getter
// PlayerEvent.cancelable as boolmyPlayerEvent.cancelable
Return Type:
bool
cancelable() as bool
// PlayerEvent.cancelable() as bool;myPlayerEvent.cancelable();
Return Type:
bool
Getter
// PlayerEvent.canceled as boolmyPlayerEvent.canceled
Return Type:
bool
Setter
// PlayerEvent.canceled = (cancel as bool);myPlayerEvent.canceled = myBool;Parameters:
cancel: bool Type: bool canceled() as bool
// PlayerEvent.canceled() as bool;myPlayerEvent.canceled();
Return Type:
bool
canceled(cancel as bool)
// PlayerEvent.canceled(cancel as bool);myPlayerEvent.canceled(myBool);Parameters:
cancel: bool Type: bool Getter
// PlayerEvent.entity as PlayermyPlayerEvent.entity
Return Type:
Player
Getter
// PlayerEvent.hasResult as boolmyPlayerEvent.hasResult
Return Type:
bool
hasResult() as bool
// PlayerEvent.hasResult() as bool;myPlayerEvent.hasResult();
Return Type:
bool
Getter
// PlayerEvent.result as ResultmyPlayerEvent.result
Return Type:
EventResult
Setter
// PlayerEvent.result = (result as Result);myPlayerEvent.result = myResult;Parameters:
result: EventResult Type: EventResult result() as Result
result(result as Result)
// PlayerEvent.result(result as Result);myPlayerEvent.result(myResult);Parameters:
result: EventResult Type: EventResult setAllow()
sets the event's result to script.zs
allow// PlayerEvent.setAllow();myPlayerEvent.setAllow();setDefault()
sets the event's result to script.zs
default// PlayerEvent.setDefault();myPlayerEvent.setDefault();setDeny()
sets the event's result to script.zs
deny// PlayerEvent.setDeny();myPlayerEvent.setDeny();