Home Commands Examples Getting Started With Scripts Global Keywords
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators

StartExplosionEvent

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.event.StartExplosionEvent;

Extends

StartExplosionEvent extends ExplosionEvent.

Implements

StartExplosionEvent implements the following interfaces:

ICancellableEvent

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.neoforge.api.event.StartExplosionEvent>(event => {
println("StartExplosionEvent ran!");
});

Members

cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// Start.cancel();
event.cancel();
Getter
script.zs
// Start.canceled as bool
event.canceled

Return Type: bool

Setter
script.zs
// Start.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// Start.canceled() as bool;
event.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// Start.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel Type: bool
Getter
script.zs
// Start.explosion as Explosion
event.explosion

Return Type: Explosion

Getter
script.zs
// Start.hasResult as bool
event.hasResult

Return Type: bool

hasResult() as bool
script.zs
// Start.hasResult() as bool;
event.hasResult();

Return Type: bool

Getter
script.zs
// Start.level as Level
event.level

Return Type: Level

Getter
script.zs
// Start.result as Result
event.result

Return Type: EventResult

Setter
script.zs
// Start.result = (result as Result);
event.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// Start.result() as Result;
event.result();

Return Type: EventResult

result(result as Result)
script.zs
// Start.result(result as Result);
event.result(myResult);

Parameters:

result Type: EventResult
setAllow()
sets the event's result to allow
script.zs
// Start.setAllow();
event.setAllow();
setDefault()
sets the event's result to default
script.zs
// Start.setDefault();
event.setDefault();
setDeny()
sets the event's result to deny
script.zs
// Start.setDeny();
event.setDeny();