ParticleBuilder (Glowkit 1.12.2-R6.0-SNAPSHOT API)

java.lang.Object
- com.destroystokyo.paper.ParticleBuilder

```
public class ParticleBuilder
extends Object
```
Helps prepare a particle to be sent to players. Usage of the builder is preferred over the super long World.spawnParticle(Particle, Location, int, double, double, double, double, Object) API

Constructor Summary

Constructors
Constructor and Description

ParticleBuilder(Particle particle)

Constructors
Constructor and Description
`ParticleBuilder(Particle particle)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParticleBuilder`	`allPlayers()` Sends this particle to all players in the world.
`ParticleBuilder`	`color(Color color)` Sets the particle Color.
`ParticleBuilder`	`color(int r, int g, int b)` Sets the particle Color.
`int`	`count()`
`ParticleBuilder`	`count(int count)` Sets the number of particles to spawn
`<T> T`	`data()` Gets the particle custom data.
`<T> ParticleBuilder`	`data(T data)` Sets the particle custom data.
`double`	`extra()` Gets the Particle extra data.
`ParticleBuilder`	`extra(double extra)` Sets the particle extra data.
`ParticleBuilder`	`force(boolean force)` Sets whether the particle is forcefully shown to the player.
`boolean`	`hasReceivers()` Example use: builder.receivers(16); if (builder.hasReceivers()) { sendParticleAsync(builder); }
`Location`	`location()`
`ParticleBuilder`	`location(Location location)` Sets the location of where to spawn the particle
`ParticleBuilder`	`location(World world, double x, double y, double z)` Sets the location of where to spawn the particle
`ParticleBuilder`	`offset(double offsetX, double offsetY, double offsetZ)` Sets the particle offset.
`double`	`offsetX()` Particle offset X.
`double`	`offsetY()` Particle offset Y.
`double`	`offsetZ()` Particle offset Z.
`Particle`	`particle()`
`ParticleBuilder`	`particle(Particle particle)` Changes what particle will be sent
`List<Player>`	`receivers()`
`ParticleBuilder`	`receivers(Collection<Player> receivers)`
`ParticleBuilder`	`receivers(int radius)` Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`ParticleBuilder`	`receivers(int radius, boolean byDistance)` Selects all players within the specified radius around the particle location.
`ParticleBuilder`	`receivers(int xzRadius, int yRadius)` Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`ParticleBuilder`	`receivers(int xzRadius, int yRadius, boolean byDistance)` Selects all players within the specified radius around the particle location.
`ParticleBuilder`	`receivers(int xRadius, int yRadius, int zRadius)` Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`ParticleBuilder`	`receivers(List<Player> receivers)`
`ParticleBuilder`	`receivers(Player... receivers)`
`Player`	`source()`
`ParticleBuilder`	`source(Player source)` Sets the source of this particle for visibility concerns (Vanish API)
`ParticleBuilder`	`spawn()` Sends the particle to all receiving players (or all).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParticleBuilder
```
public ParticleBuilder(Particle particle)
```
- Method Detail
  - spawn
```
public ParticleBuilder spawn()
```
    Sends the particle to all receiving players (or all). This method is safe to use Asynchronously
    
    Returns:
    
    a reference to this object.
  - particle
```
public Particle particle()
```
    Returns:
    
    The particle going to be sent
  - particle
```
public ParticleBuilder particle(Particle particle)
```
    Changes what particle will be sent
    
    Parameters:
    
    particle - The particle
    
    Returns:
    
    a reference to this object.
  - receivers
```
@Nullable
public List<Player> receivers()
```
    Returns:
    
    List of players who will receive the particle, or null for all in world
  - hasReceivers
```
public boolean hasReceivers()
```
    Example use: builder.receivers(16); if (builder.hasReceivers()) { sendParticleAsync(builder); }
    
    Returns:
    
    If this particle is going to be sent to someone
  - allPlayers
```
public ParticleBuilder allPlayers()
```
    Sends this particle to all players in the world. This is rather silly and you should likely not be doing this. Just be a logical person and use receivers by radius or collection.
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(@Nullable
                                 List<Player> receivers)
```
    Parameters:
    
    receivers - List of players to receive this particle, or null for all players in the world
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(@Nullable
                                 Collection<Player> receivers)
```
    Parameters:
    
    receivers - List of players to receive this particle, or null for all players in the world
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(Player... receivers)
```
    Parameters:
    
    receivers - List of players to be receive this particle, or null for all players in the world
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(int radius)
```
    Selects all players within a cuboid selection around the particle location, within the specified bounding box. If you want a more spherical check, see receivers(int, boolean)
    
    Parameters:
    
    radius - amount to add on all axis
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(int radius,
                                 boolean byDistance)
```
    Selects all players within the specified radius around the particle location. If byDistance is false, behavior uses cuboid selection the same as receivers(int, int) If byDistance is true, radius is tested by distance in a spherical shape
    
    Parameters:
    
    radius - amount to add on each axis
    
    byDistance - true to use a spherical radius, false to use a cuboid
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(int xzRadius,
                                 int yRadius)
```
    Selects all players within a cuboid selection around the particle location, within the specified bounding box. Allows specifying a different Y size than X and Z If you want a more cylinder check, see receivers(int, int, boolean) If you want a more spherical check, see receivers(int, boolean)
    
    Parameters:
    
    xzRadius - amount to add on the x/z axis
    
    yRadius - amount to add on the y axis
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(int xzRadius,
                                 int yRadius,
                                 boolean byDistance)
```
    Selects all players within the specified radius around the particle location. If byDistance is false, behavior uses cuboid selection the same as receivers(int, int) If byDistance is true, radius is tested by distance on the y plane and on the x/z plane, in a cylinder shape.
    
    Parameters:
    
    xzRadius - amount to add on the x/z axis
    
    yRadius - amount to add on the y axis
    
    byDistance - true to use a cylinder shape, false to use cuboid
    
    Returns:
    
    a reference to this object.
  - receivers
```
public ParticleBuilder receivers(int xRadius,
                                 int yRadius,
                                 int zRadius)
```
    Selects all players within a cuboid selection around the particle location, within the specified bounding box. If you want a more cylinder check, see receivers(int, int, boolean) If you want a more spherical check, see receivers(int, boolean)
    
    Parameters:
    
    xRadius - amount to add on the x axis
    
    yRadius - amount to add on the y axis
    
    zRadius - amount to add on the z axis
    
    Returns:
    
    a reference to this object.
  - source
```
public Player source()
```
    Returns:
    
    The player considered the source of this particle (for Visibility concerns), or null
  - source
```
public ParticleBuilder source(Player source)
```
    Sets the source of this particle for visibility concerns (Vanish API)
    
    Parameters:
    
    source - The player who is considered the source
    
    Returns:
    
    a reference to this object.
  - location
```
public Location location()
```
    Returns:
    
    Location of where the particle will spawn
  - location
```
public ParticleBuilder location(Location location)
```
    Sets the location of where to spawn the particle
    
    Parameters:
    
    location - The location of the particle
    
    Returns:
    
    a reference to this object.
  - location
```
public ParticleBuilder location(World world,
                                double x,
                                double y,
                                double z)
```
    Sets the location of where to spawn the particle
    
    Parameters:
    
    world - World to spawn particle in
    
    x - X location
    
    y - Y location
    
    z - Z location
    
    Returns:
    
    a reference to this object.
  - count
```
public int count()
```
    Returns:
    
    Number of particles to spawn
  - count
```
public ParticleBuilder count(int count)
```
    Sets the number of particles to spawn
    
    Parameters:
    
    count - Number of particles
    
    Returns:
    
    a reference to this object.
  - offsetX
```
public double offsetX()
```
    Particle offset X. Varies by particle on how this is used
    
    Returns:
    
    Particle offset X.
  - offsetY
```
public double offsetY()
```
    Particle offset Y. Varies by particle on how this is used
    
    Returns:
    
    Particle offset Y.
  - offsetZ
```
public double offsetZ()
```
    Particle offset Z. Varies by particle on how this is used
    
    Returns:
    
    Particle offset Z.
  - offset
```
public ParticleBuilder offset(double offsetX,
                              double offsetY,
                              double offsetZ)
```
    Sets the particle offset. Varies by particle on how this is used
    
    Parameters:
    
    offsetX - Particle offset X
    
    offsetY - Particle offset Y
    
    offsetZ - Particle offset Z
    
    Returns:
    
    a reference to this object.
  - extra
```
public double extra()
```
    Gets the Particle extra data. Varies by particle on how this is used
    
    Returns:
    
    the extra particle data
  - extra
```
public ParticleBuilder extra(double extra)
```
    Sets the particle extra data. Varies by particle on how this is used
    
    Parameters:
    
    extra - the extra particle data
    
    Returns:
    
    a reference to this object.
  - data
```
public <T> T data()
```
    Gets the particle custom data. Varies by particle on how this is used
    
    Type Parameters:
    
    T - The Particle data type
    
    Returns:
    
    the ParticleData for this particle
  - data
```
public <T> ParticleBuilder data(T data)
```
    Sets the particle custom data. Varies by particle on how this is used
    
    Type Parameters:
    
    T - The Particle data type
    
    Parameters:
    
    data - The new particle data
    
    Returns:
    
    a reference to this object.
  - force
```
public ParticleBuilder force(boolean force)
```
    Sets whether the particle is forcefully shown to the player. If forced, the particle will show faraway, as far as the player's view distance allows. If false, the particle will show according to the client's particle settings.
    
    Parameters:
    
    force - true to force, false for normal
    
    Returns:
    
    a reference to this object.
  - color
```
public ParticleBuilder color(Color color)
```
    Sets the particle Color. Only valid for REDSTONE, SPELL_MOB and SPELL_MOB_AMBIENT.
    
    Parameters:
    
    color - the new particle color
    
    Returns:
    
    a reference to this object.
  - color
```
public ParticleBuilder color(int r,
                             int g,
                             int b)
```
    Sets the particle Color. Only valid for REDSTONE, SPELL_MOB and SPELL_MOB_AMBIENT.
    
    Parameters:
    
    r - red color component
    
    g - green color component
    
    b - blue color component
    
    Returns:
    
    a reference to this object.

Class ParticleBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticleBuilder

Method Detail

spawn

particle

particle

receivers

hasReceivers

allPlayers

receivers

receivers

receivers

receivers

receivers

receivers

receivers

receivers

source

source

location

location

location

count

count

offsetX

offsetY

offsetZ

offset

extra

extra

data

data

force

color

color