Importing the class

Link to 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.

ZenScript
Copy
import crafttweaker.api.world.Explosion;

Name: create

Return Type: Explosion

ZenScript
Copy
Explosion.create(world as Level, x as double, y as double, z as double, size as float, causesFire as boolean, mode as ExplosionBlockInteraction, exploder as Entity, source as DamageSource) as Explosion
ParameterTypeDescriptionOptionalDefaultValue
Parameter
world
Type
Level
Description
No Description Provided
Optional
false
DefaultValue
Parameter
x
Type
double
Description
No Description Provided
Optional
false
DefaultValue
Parameter
y
Type
double
Description
No Description Provided
Optional
false
DefaultValue
Parameter
z
Type
double
Description
No Description Provided
Optional
false
DefaultValue
Parameter
size
Type
float
Description
No Description Provided
Optional
false
DefaultValue
Parameter
causesFire
Type
boolean
Description
No Description Provided
Optional
false
DefaultValue
Parameter
mode
Type
ExplosionBlockInteraction
Description
No Description Provided
Optional
false
DefaultValue
Parameter
exploder
Type
Entity
Description
No Description Provided
Optional
true
DefaultValue
Parameter
source
Type
DamageSource
Description
No Description Provided
Optional
true
DefaultValue

Link to g--1

Name: clearToBlow

Clears the affected block positions of this Explosion.

Return Type: void

ZenScript
Copy
// Explosion.clearToBlow() as void

myExplosion.clearToBlow();

Name: explode

Performs the first part of the explosion which is destroying the blocks.

Return Type: void

ZenScript
Copy
// Explosion.explode() as void

myExplosion.explode();

Link to g--3

Name: finalizeExplosion

Performs the second part of the explosion which is the sound, drops and if enabled the particles.

Return Type: void

ZenScript
Copy
// Explosion.finalizeExplosion(spawnParticles as boolean) as void

myExplosion.finalizeExplosion(true);
ParameterTypeDescription
Parameter
spawnParticles
Type
boolean
Description
Should particles be spawned.

Link to g--4

Name: getDamageSource

Gets the damage source of this Explosion.

Returns: The damage source of this Explosion.
Return Type: DamageSource

ZenScript
Copy
// Explosion.getDamageSource() as DamageSource

myExplosion.getDamageSource();

Link to g--5

Name: getHitPlayers

Gets the player knockback map for this Explosion.

This map is only populated in Explosion#explode() so calling it before will return nothing.

This map is used to calculate the vectors that players around the explosion will be pushed back by.

Returns: A Map of PlayerEntity to Vector3d depicting knockback vectors.
Return Type: Vec3[Player]

ZenScript
Copy
// Explosion.getHitPlayers() as Vec3[Player]

myExplosion.getHitPlayers();

Link to g--6

Name: getSourceMob

Gets the LivingEntity that caused this Explosion.

For example: If the Explosion was caused by TNT, it will return the PlayerEntity that placed it. If the Explosion was caused by a Creeper or another Entity directly, it will return that Entity. If the Explosion was caused by a Ghast fireball, it will return the Ghast.

If no Entity caused this Explosion (for example, if the Explosion was caused by TNT in a Desert Temple that generated in the world), then null is returned.

You may need to cast the returned LivingEntity to not be nullable.

Returns: The LivingEntity that caused this Explosion. null if no LivingEntity caused it.
Return Type: LivingEntity

ZenScript
Copy
// Explosion.getSourceMob() as LivingEntity

myExplosion.getSourceMob();

Link to g--7

Name: getToBlow

Return Type: stdlib.List<BlockPos>

ZenScript
Copy
// Explosion.getToBlow() as stdlib.List<BlockPos>

myExplosion.getToBlow();
NameTypeHas GetterHas SetterDescription
Name
damageSource
Type
DamageSource
Has Getter
true
Has Setter
false
Description
Gets the damage source of this Explosion.
Name
playerKnockbackMap
Type
Vec3[Player]
Has Getter
true
Has Setter
false
Description
Gets the player knockback map for this Explosion.

This map is only populated in Explosion#explode() so calling it before will return nothing.

This map is used to calculate the vectors that players around the explosion will be pushed back by.
Name
sourceMob
Type
LivingEntity
Has Getter
true
Has Setter
false
Description
Gets the LivingEntity that caused this Explosion.

For example:
If the Explosion was caused by TNT, it will return the PlayerEntity that placed it.
If the Explosion was caused by a Creeper or another Entity directly, it will return that Entity.
If the Explosion was caused by a Ghast fireball, it will return the Ghast.

If no Entity caused this Explosion (for example, if the Explosion was caused by TNT in a Desert Temple that
generated in the world), then null is returned.

You may need to cast the returned LivingEntity to not be nullable.
Name
toBlow
Type
stdlib.List<BlockPos>
Has Getter
true
Has Setter
false
Description
No Description Provided