org.spongepowered.api.world.explosion

Interface Explosion

All Superinterfaces:

Locatable

public interface Explosion
extends Locatable

Represents an explosion in a World.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Explosion.Builder A builder for Explosion.

Method Summary

Modifier and Type	Method and Description
static Explosion.Builder	builder() Creates a new Explosion.Builder to build a Explosion.
boolean	canCauseFire() Gets whether the affected blocks have a chance to catch on fire.
default double	getKnockback() Gets the relative strength of the knockback applied to nearby objects that can be knocked back.
float	getRadius() Gets the radius of the explosion.
default float	getRandomness() Gets an indication of the randomness of the form of the explosion.
default int	getResolution() Gets a value that indicates the relative strength of an explosion.
Optional<Explosive>	getSourceExplosive() Gets the source Explosive of the explosion.
boolean	shouldBreakBlocks() Gets whether the affected blocks should be destroyed on explosion.
boolean	shouldDamageEntities() Gets whether this explosion will damage entities.
boolean	shouldPlaySmoke() Gets whether the explosion will play a smoke effect.

Methods inherited from interface org.spongepowered.api.world.Locatable

getLocation, getWorld

Method Detail

builder

static Explosion.Builder builder()

Creates a new Explosion.Builder to build a Explosion.

Returns:

The new builder

getSourceExplosive

Optional<Explosive> getSourceExplosive()

Gets the source Explosive of the explosion.

Returns:

The source explosive or null if there is no source

getRadius

float getRadius()

Gets the radius of the explosion.

Returns:

The radius

canCauseFire

boolean canCauseFire()

Gets whether the affected blocks have a chance to catch on fire.

Returns:

Whether the affected blocks can catch on fire

shouldPlaySmoke

boolean shouldPlaySmoke()

Gets whether the explosion will play a smoke effect.

Returns:

Whether the explosion will play smoke

shouldBreakBlocks

boolean shouldBreakBlocks()

Gets whether the affected blocks should be destroyed on explosion.

Returns:

Whether the affected blocks should be destroyed

shouldDamageEntities

boolean shouldDamageEntities()

Gets whether this explosion will damage entities.

Returns:

Whether the explosion will damage entities

getResolution

default int getResolution()

Gets a value that indicates the relative strength of an explosion.

Returns:

The resolution of the explosion.

getRandomness

default float getRandomness()

Gets an indication of the randomness of the form of the explosion.

This value indicates how close to being symmetrical the explosion is. A value of zero indicates a completely symmetrical blast (in all three dimensions). A larger value indicates a lower likelihood of symmetry. A value of one indicates the platform default.

Note, this is a hint to the implementation. Implementations may not provide the means to produce semi-random form explosions.

Returns:

The potential randomness of the form of the explosion.

getKnockback

default double getKnockback()

Gets the relative strength of the knockback applied to nearby objects that can be knocked back.

Note that the default behavior and strength is not defined here. A return value of 1 simply indicates the default behavior which is implementation dependent.

Returns:

The multiple by which the knockback of entities will be changed