Home Commands Examples Getting Started With Scripts Global Keywords

Event

The event is not cancelable.

The event does not have a result.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.forge.api.event.Event;

Methods

Cancels the event. Same as setCanceled(true)

script.zs
// Event.cancel()
myEvent.cancel();

Return Type: EventResult

script.zs
// Event.getResult() as EventResult
myEvent.getResult();

Return Type: boolean

script.zs
// Event.hasResult() as boolean
myEvent.hasResult();

Return Type: boolean

script.zs
// Event.isCancelable() as boolean
myEvent.isCancelable();

Return Type: boolean

script.zs
// Event.isCanceled() as boolean
myEvent.isCanceled();

sets the event’s result to allow

script.zs
// Event.setAllow()
myEvent.setAllow();
script.zs
Event.setCanceled(cancel as boolean)
ParameterType
Parameter
cancel
Type
boolean

sets the event’s result to default

script.zs
// Event.setDefault()
myEvent.setDefault();

sets the event’s result to deny

script.zs
// Event.setDeny()
myEvent.setDeny();
script.zs
Event.setResult(result as EventResult)
ParameterType
Parameter
result
Type
EventResult

Properties

NameTypeHas GetterHas Setter
Name
Type
Event
Has Getter
false
Has Setter
true
Name
cancelable
Type
boolean
Has Getter
true
Has Setter
false
Name
canceled
Type
boolean
Has Getter
true
Has Setter
true
Name
hasResult
Type
boolean
Has Getter
true
Has Setter
false
Name
result
Type
EventResult
Has Getter
true
Has Setter
false