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

Interface ParticleTypeColorable

All Superinterfaces:
ParticleType
public interface ParticleTypeColorable extends ParticleType

Class used to represent particle type that can construct colored particle packet.

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

All packetColored and 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.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ParticleTypeColorable
    detachCopy()
    Makes an independent from previously called particle type, copy of this particle type.
    ParticlePacket
    packetColored(boolean far, double x, double y, double z, int r, int g, int b)
    Construct particle packet that will spawn 1 colored particle at specified position.
    ParticlePacket
    packetColored(boolean far, double x, double y, double z, org.bukkit.Color color)
    Construct particle packet that will spawn 1 colored particle at specified position.
    ParticlePacket
    packetColored(boolean far, org.bukkit.Location loc, int r, int g, int b)
    Construct particle packet that will spawn 1 colored particle at specified position.
    ParticlePacket
    packetColored(boolean far, org.bukkit.Location loc, org.bukkit.Color color)
    Construct particle packet that will spawn 1 colored particle at specified position.
    ParticlePacket
    packetColored(boolean far, org.bukkit.util.Vector loc, int r, int g, int b)
    Construct particle packet that will spawn 1 colored particle at specified position.
    ParticlePacket
    packetColored(boolean far, org.bukkit.util.Vector loc, org.bukkit.Color color)
    Construct particle packet that will spawn 1 colored particle at specified position.

    Methods inherited from interface com.github.fierioziy.particlenativeapi.api.particle.type.ParticleType

    isPresent, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet

  • Method Details

    • detachCopy

      ParticleTypeColorable detachCopy()

      Makes an independent from previously called particle type, copy of this particle type.

      Returned instance can be cached and reused.

      Specified by:
      detachCopy in interface ParticleType
      Returns:
      an independent copy of this selected particle type.

    • packetColored

      ParticlePacket packetColored(boolean far, org.bukkit.Location loc, org.bukkit.Color color)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      color - a Color object with color parameters.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetColored

      ParticlePacket packetColored(boolean far, org.bukkit.util.Vector loc, org.bukkit.Color color)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      color - a Color object with color parameters.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetColored

      ParticlePacket packetColored(boolean far, double x, double y, double z, org.bukkit.Color color)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      color - a Color object with color parameters.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetColored

      ParticlePacket packetColored(boolean far, org.bukkit.Location loc, int r, int g, int b)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      r - red color value that should be between 0 and 255.
      g - green color value that should be between 0 and 255.
      b - blue color value that should be between 0 and 255.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetColored

      ParticlePacket packetColored(boolean far, org.bukkit.util.Vector loc, int r, int g, int b)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      r - red color value that should be between 0 and 255.
      g - green color value that should be between 0 and 255.
      b - blue color value that should be between 0 and 255.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetColored

      ParticlePacket packetColored(boolean far, double x, double y, double z, int r, int g, int b)

      Construct particle packet that will spawn 1 colored particle at specified position.

      Parameters are not validated in any way.

      It is wise to check, if particle is supported by current Spigot version using ParticleType.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.
      r - red color value that should be between 0 and 255.
      g - green color value that should be between 0 and 255.
      b - blue color value that should be between 0 and 255.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.