# Uses of Class com.destroystokyo.paper.ParticleBuilder (Scissors-API 1.19-R0.1-SNAPSHOT API)
use: package: com.destroystokyo.paper, class: ParticleBuilder

# Uses of Class
com.destroystokyo.paper.ParticleBuilder

Packages that use ParticleBuilder
Package
Description
com.destroystokyo.paper
org.bukkit
The root package of the Bukkit API, contains generalized API classes.

## Uses of ParticleBuilder in com.destroystokyo.paper

Methods in com.destroystokyo.paper that return ParticleBuilder
Modifier and Type
Method
Description
`@NotNull ParticleBuilder`
ParticleBuilder.`allPlayers()`
Sends this particle to all players in the world.
`@NotNull ParticleBuilder`
ParticleBuilder.`color(int r, int g, int b)`
Sets the particle Color.
`@NotNull ParticleBuilder`
ParticleBuilder.`color(@Nullable Color color)`
Sets the particle Color.
`@NotNull ParticleBuilder`
ParticleBuilder.`color(@Nullable Color color, float size)`
Sets the particle Color and size.
`@NotNull ParticleBuilder`
ParticleBuilder.`count(int count)`
Sets the number of particles to spawn
`<T> @NotNull ParticleBuilder`
ParticleBuilder.`data(T data)`
Sets the particle custom data.
`@NotNull ParticleBuilder`
ParticleBuilder.`extra(double extra)`
Sets the particle extra data.
`@NotNull ParticleBuilder`
ParticleBuilder.`force(boolean force)`
Sets whether the particle is forcefully shown to the player.
`@NotNull ParticleBuilder`
ParticleBuilder.`location(@NotNull Location location)`
Sets the location of where to spawn the particle
`@NotNull ParticleBuilder`
ParticleBuilder.`location(@NotNull World world, double x, double y, double z)`
Sets the location of where to spawn the particle
`@NotNull ParticleBuilder`
ParticleBuilder.`offset(double offsetX, double offsetY, double offsetZ)`
Sets the particle offset.
`@NotNull ParticleBuilder`
ParticleBuilder.`particle(@NotNull Particle particle)`
Changes what particle will be sent
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(int radius)`
Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(int radius, boolean byDistance)`
Selects all players within the specified radius around the particle location.
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(int xzRadius, int yRadius)`
Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(int xzRadius, int yRadius, boolean byDistance)`
Selects all players within the specified radius around the particle location.
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(int xRadius, int yRadius, int zRadius)`
Selects all players within a cuboid selection around the particle location, within the specified bounding box.
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(@Nullable Collection<Player> receivers)`
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(@Nullable List<Player> receivers)`
`@NotNull ParticleBuilder`
ParticleBuilder.`receivers(@Nullable Player... receivers)`
`@NotNull ParticleBuilder`
ParticleBuilder.`source(@Nullable Player source)`
Sets the source of this particle for visibility concerns (Vanish API)
`@NotNull ParticleBuilder`
ParticleBuilder.`spawn()`
Sends the particle to all receiving players (or all).

## Uses of ParticleBuilder in org.bukkit

Methods in org.bukkit that return ParticleBuilder
Modifier and Type
Method
Description
`ParticleBuilder`
Particle.`builder()`
Creates a `ParticleBuilder`