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 MCWorld, x as double, y as double, z as double, size as float, causesFire as boolean, mode as ExplosionMode, exploder as MCEntity, source as DamageSource) as Explosion
ParameterTypeDescriptionOptionalDefaultValue
Parameter
world
Type
MCWorld
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
ExplosionMode
Description
No Description Provided
Optional
false
DefaultValue
Parameter
exploder
Type
MCEntity
Description
No Description Provided
Optional
true
DefaultValue
Parameter
source
Type
DamageSource
Description
No Description Provided
Optional
true
DefaultValue

Link to clearAffectedBlockPositions

Name: clearAffectedBlockPositions

Clears the affected block positions of this Explosion.

Return Type: void

ZenScript
Copy
// Explosion.clearAffectedBlockPositions() as void

myExplosion.clearAffectedBlockPositions();

Name: doExplosionA

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

Return Type: void

ZenScript
Copy
// Explosion.doExplosionA() as void

myExplosion.doExplosionA();

Name: doExplosionB

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

Return Type: void

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

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

Link to getAffectedBlockPositions

Name: getAffectedBlockPositions

Return Type: stdlib.List<BlockPos>

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

myExplosion.getAffectedBlockPositions();

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();

Name: getExploder

Gets the actual Entity that caused this Explosion to occur.

Examples: TNT will return itself. Creeper will return itself. A Ghast fireball will return itself.

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

Returns: The Entity that caused this Explosion. If the Explosion wasn't caused by any Entity, it will return null.
Return Type: MCEntity?

ZenScript
Copy
// Explosion.getExploder() as MCEntity?

myExplosion.getExploder();

Link to getExplosivePlacedBy

Name: getExplosivePlacedBy

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: MCLivingEntity?

ZenScript
Copy
// Explosion.getExplosivePlacedBy() as MCLivingEntity?

myExplosion.getExplosivePlacedBy();

Link to getPlayerKnockbackMap

Name: getPlayerKnockbackMap

Gets the player knockback map for this Explosion.

This map is only populated in Explosion#doExplosionA() 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: MCVector3d[MCPlayerEntity]

ZenScript
Copy
// Explosion.getPlayerKnockbackMap() as MCVector3d[MCPlayerEntity]

myExplosion.getPlayerKnockbackMap();

Name: getPosition

Return Type: MCVector3d

ZenScript
Copy
// Explosion.getPosition() as MCVector3d

myExplosion.getPosition();
NameTypeHas GetterHas SetterDescription
Name
Type
MCEntity?
Has Getter
true
Has Setter
false
Description
Gets the actual Entity that caused this Explosion to occur.

Examples:
TNT will return itself.
Creeper will return itself.
A Ghast fireball will return itself.

You may need to cast the returned Entity to not be nullable.
Name
affectedBlockPositions
Type
stdlib.List<BlockPos>
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
damageSource
Type
DamageSource
Has Getter
true
Has Setter
false
Description
Gets the damage source of this Explosion.
Name
explosivePlacedBy
Type
MCLivingEntity?
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
playerKnockbackMap
Type
MCVector3d[MCPlayerEntity]
Has Getter
true
Has Setter
false
Description
Gets the player knockback map for this Explosion.

This map is only populated in Explosion#doExplosionA() 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
position
Type
MCVector3d
Has Getter
true
Has Setter
false
Description
No Description Provided