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

Interface ParticleTypeVibrationSingle

public interface ParticleTypeVibrationSingle

Class used to represent vibration particle type since MC 1.17.

It provides a non-reflective packet method overloads to construct particle packet with desired parameters.

All packet 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.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isPresent()
    Checks if this particle is supported by this Spigot version.
    ParticlePacket
    packet(boolean far, double x, double y, double z, double targetX, double targetY, double targetZ, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
    ParticlePacket
    packet(boolean far, double x, double y, double z, org.bukkit.entity.Entity targetEntity, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.
    ParticlePacket
    packet(boolean far, org.bukkit.Location loc, org.bukkit.entity.Entity targetEntity, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.
    ParticlePacket
    packet(boolean far, org.bukkit.Location loc, org.bukkit.Location target, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
    ParticlePacket
    packet(boolean far, org.bukkit.Location loc, org.bukkit.util.Vector target, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
    ParticlePacket
    packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.entity.Entity targetEntity, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.
    ParticlePacket
    packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.Location target, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.
    ParticlePacket
    packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.util.Vector target, int ticks)
    Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

  • Method Details

    • packet

      ParticlePacket packet(boolean far, org.bukkit.Location loc, org.bukkit.Location target, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Location containing position.
      target - a Location containing target position.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, org.bukkit.Location loc, org.bukkit.util.Vector target, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Location containing position.
      target - a Vector containing target position.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, org.bukkit.Location loc, org.bukkit.entity.Entity targetEntity, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Location containing position.
      targetEntity - an Entity.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.Location target, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Vector containing position.
      target - a Location containing target position.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.util.Vector target, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Vector containing position.
      target - a Vector containing target position.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, org.bukkit.util.Vector loc, org.bukkit.entity.Entity targetEntity, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      loc - a Vector containing position.
      targetEntity - an Entity.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, double x, double y, double z, double targetX, double targetY, double targetZ, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target position.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      This method is overridden by dynamically generated subclasses.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      x - component of a position.
      y - component of a position.
      z - component of a position.
      targetX - component of a target position.
      targetY - component of a target position.
      targetZ - component of a target position.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packet

      ParticlePacket packet(boolean far, double x, double y, double z, org.bukkit.entity.Entity targetEntity, int ticks)

      Construct particle packet that will spawn 1 vibration particle at specified position flying toward target entity.

      Currently, positions are aligned to block centers.

      Parameters are not validated in any way.

      This method is overridden by dynamically generated subclasses.

      It is wise to check, if particle is supported by current Spigot version using isPresent() method.

      Parameters:
      far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).
      x - component of a position.
      y - component of a position.
      z - component of a position.
      targetEntity - target entity.
      ticks - flight duration (in ticks).
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • 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.