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

Interface ParticleTypeMotion

All Superinterfaces:
ParticleType
public interface ParticleTypeMotion extends ParticleType

Class used to represent particle type that can construct particle packet with desired initial motion.

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

All packetMotion 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
    ParticleTypeMotion
    detachCopy()
    Makes an independent from previously called particle type, copy of this particle type.
    ParticlePacket
    packetMotion(boolean far, double x, double y, double z, double dirX, double dirY, double dirZ)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.
    ParticlePacket
    packetMotion(boolean far, double x, double y, double z, org.bukkit.util.Vector dir)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.
    ParticlePacket
    packetMotion(boolean far, org.bukkit.Location loc, double dirX, double dirY, double dirZ)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.
    ParticlePacket
    packetMotion(boolean far, org.bukkit.Location loc, org.bukkit.util.Vector dir)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.
    ParticlePacket
    packetMotion(boolean far, org.bukkit.util.Vector loc, double dirX, double dirY, double dirZ)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.
    ParticlePacket
    packetMotion(boolean far, org.bukkit.util.Vector loc, org.bukkit.util.Vector dir)
    Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

    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

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

    • packetMotion

      ParticlePacket packetMotion(boolean far, org.bukkit.Location loc, org.bukkit.util.Vector dir)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dir - a Vector direction.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetMotion

      ParticlePacket packetMotion(boolean far, org.bukkit.util.Vector loc, org.bukkit.util.Vector dir)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dir - a Vector direction.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetMotion

      ParticlePacket packetMotion(boolean far, double x, double y, double z, org.bukkit.util.Vector dir)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dir - a Vector direction.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetMotion

      ParticlePacket packetMotion(boolean far, org.bukkit.Location loc, double dirX, double dirY, double dirZ)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dirX - component of direction vector.
      dirY - component of direction vector.
      dirZ - component of direction vector.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetMotion

      ParticlePacket packetMotion(boolean far, org.bukkit.util.Vector loc, double dirX, double dirY, double dirZ)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dirX - component of direction vector.
      dirY - component of direction vector.
      dirZ - component of direction vector.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.

    • packetMotion

      ParticlePacket packetMotion(boolean far, double x, double y, double z, double dirX, double dirY, double dirZ)

      Construct particle packet that will spawn 1 particle at specified position with motion set to provided direction.

      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.
      dirX - component of direction vector.
      dirY - component of direction vector.
      dirZ - component of direction vector.
      Returns:
      an NMS Packet wrapped in shared ParticlePacket object.
      Throws:
      ParticleException - when requested particle type is not supported by this server version.