Module gomint.api

Class ParticleData


  • public final class ParticleData
    extends Object
    Version:
    1.0
    Author:
    geNAZt
    • Method Detail

      • getFace

        public int getFace()
        Get the face value. This will be -1 when not given
        Returns:
        face value
      • getBlock

        public Block getBlock()
        Get the block value. This will be null when not given
        Returns:
        block value
      • getRed

        public int getRed()
        Get the red value. This will be -1 when not given
        Returns:
        red value
      • getGreen

        public int getGreen()
        Get the green value. This will be -1 when not given
        Returns:
        green value
      • getBlue

        public int getBlue()
        Get the blue value. This will be -1 when not given
        Returns:
        blue value
      • getAlpha

        public int getAlpha()
        Get the alpha value. This will be -1 when not given
        Returns:
        alpha value
      • blockWithFacing

        public static ParticleData blockWithFacing​(Block block,
                                                   int face)
        Create a new particle data based on the block given as argument
        Parameters:
        block - which should be used to provide data for particles
        face - which should be used in the particle
        Returns:
        particle data which can be used to send particles to the player
      • block

        public static ParticleData block​(Block block)
        Create a new particle data based on the block given as argument
        Parameters:
        block - which should be used to provide data for particles
        Returns:
        particle data which can be used to send particles to the player
      • color

        public static ParticleData color​(int r,
                                         int g,
                                         int b,
                                         int a)
        Create a new particle data based on the color given as arguments
        Parameters:
        r - amount of red
        g - amount of green
        b - amount of blue
        a - amount of alpha
        Returns:
        particle data which can be used to send particles to the player
        Throws:
        IllegalArgumentException - when one of the three values is outside of the range of 0 - 255
      • color

        public static ParticleData color​(int r,
                                         int g,
                                         int b)
        Create a new particle data based on the color given as arguments
        Parameters:
        r - amount of red
        g - amount of green
        b - amount of blue
        Returns:
        particle data which can be used to send particles to the player
        Throws:
        IllegalArgumentException - when one of the three values is outside of the range of 0 - 255