Package me.deecaad.weaponmechanics.weapon.explode.shapes

Interface ExplosionShape

All Superinterfaces:
net.kyori.adventure.key.Keyed, org.bukkit.Keyed, me.deecaad.core.file.Serializer<ExplosionShape>
All Known Implementing Classes:
CubeExplosion, DefaultExplosion, ParabolaExplosion, SphereExplosion
public interface ExplosionShape extends org.bukkit.Keyed, me.deecaad.core.file.Serializer<ExplosionShape>
This interface outlines the shape an explosion may take.

All subclasses of this interface should be registered in ExplosionShapes.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getArea()
    Returns the area, measured in meters cubed (blocks cubed), of this shape.
    List<org.bukkit.block.Block>
    getBlocks(org.bukkit.Location origin)
    Returns a list of all effected blocks effected by this shape if an explosion were to trigger at the given origin.
    List<org.bukkit.entity.LivingEntity>
    getEntities(org.bukkit.Location origin)
    Returns a list of all effect entities effected by this shape.
    double
    getMaxDistance()
    Returns the maximum distance from the origin of the explosion that an entity is considered to be contained in the explosion.
    boolean
    isContained(org.bukkit.Location origin, org.bukkit.Location point)
    Returns true if the given point is contained in this shape, assuming the shape's center is located at origin.

    Methods inherited from interface org.bukkit.Keyed

    getKey, key

    Methods inherited from interface me.deecaad.core.file.Serializer

    canUsePathTo, getKeyword, getName, getParentKeywords, getWikiLink, letPassThrough, serialize, shouldSerialize, tryPathTo, useLater

  • Method Details

    • getBlocks

      @NotNull List<org.bukkit.block.Block> getBlocks(@NotNull org.bukkit.Location origin)
      Returns a list of all effected blocks effected by this shape if an explosion were to trigger at the given origin. This list will not contain any air blocks, but may still contain liquids/bedrock/ otherwise.

      Implementations should not filter blocks out by material (Like IRON_BLOCK, DIRT, STONE). Instead, let BlockDamage handle that. You may still filter out "tough" blocks, like liquids, bedrock, or obsidian.

      Parameters:
      origin - The non-null origin of the explosion (Usually the center).
      Returns:
      The non-null list of blocks contained in the explosion.

    • getEntities

      List<org.bukkit.entity.LivingEntity> getEntities(@NotNull org.bukkit.Location origin)
      Returns a list of all effect entities effected by this shape. An entity is effected if they are contained in the area of the explosion.

      Data returned by this method is usually consumed by an ExplosionExposure.

      Parameters:
      origin - The non-null origin of the explosion (Usually the center).
      Returns:
      The non-null list of entities contained in the explosion.

    • getMaxDistance

      @Nonnegative double getMaxDistance()
      Returns the maximum distance from the origin of the explosion that an entity is considered to be contained in the explosion. This method should NOT be used to determine whether a point is in an explosion (use isContained(Location, Location)). This method is useful for helping to determine an entity's exposure. See DistanceExposure.
      Returns:
      The maximum distance away an entity takes damage.

    • isContained

      boolean isContained(@NotNull org.bukkit.Location origin, @NotNull org.bukkit.Location point)
      Returns true if the given point is contained in this shape, assuming the shape's center is located at origin.
      Parameters:
      origin - The non-null origin of the explosion.
      point - The non-null point to test.
      Returns:
      True if the point is in this shape.

    • getArea

      @Nonnegative double getArea()
      Returns the area, measured in meters cubed (blocks cubed), of this shape. Note that the returned value will be inaccurate to an unknown degree, since some shapes (like DefaultExplosion) are based on randomness and ray-tracing.
      Returns:
      The maximum area effected by this shape.