Package com.github.fierioziy.particlenativeapi.api.particle.type

Interface ParticleTypeBlockMotion

public interface ParticleTypeBlockMotion

Class used to represent block particle type that needs a block type.

It provides a non-reflective of method overloads to construct ParticleTypeMotion with selected block type.

All of methods does not validate parameters in any way.

IMPORTANT NOTE: All methods annotated with Shared annotation caches and returns exactly one and the same instance with changed state between method calls. For an independent copy of returned instances, check detachCopy methods on them.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isPresent()
    Checks if this particle is supported by this Spigot version.
    ParticleTypeMotion
    of(org.bukkit.Material block)
    Selects a block this particle should represents.
    ParticleTypeMotion
    of(org.bukkit.Material block, byte meta)
    Selects a block this particle should represents.
    ParticleTypeMotion
    of(org.bukkit.Material block, int meta)
    Selects a block this particle should represents.

  • Method Details

    • of

      ParticleTypeMotion of(org.bukkit.Material block)

      Selects a block this particle should represents.

      Parameters are not validated in any way.

      Parameters:
      block - a Material object representing desired block type.
      Returns:
      a valid shared ParticleTypeMotion object with selected block type.

    • of

      ParticleTypeMotion of(org.bukkit.Material block, int meta)

      Selects a block this particle should represents.

      Parameters are not validated in any way.

      Parameters:
      block - a Material object representing desired block type.
      meta - a metadata used by certain blocks (it is ignored since 1.13).
      Returns:
      a valid shared ParticleTypeMotion object with selected block type.

    • of

      ParticleTypeMotion of(org.bukkit.Material block, byte meta)

      Selects a block this particle should represents.

      Parameters are not validated in any way.

      This method is overridden by dynamically generated subclasses.

      Parameters:
      block - a Material object representing desired block type.
      meta - a metadata used by certain blocks (it is ignored since 1.13).
      Returns:
      a valid shared ParticleTypeMotion object with selected block type.

    • isPresent

      boolean isPresent()

      Checks if this particle is supported by this Spigot version.

      This method is overridden by dynamically generated subclasses.

      Returns:
      true if this particle is supported by this Spigot version, false otherwise.