✨Particles

A descriptive overview of the Voucher particle effects within Vouchers+

Vouchers+ allows you to include a particle effect that is run every time a voucher is redeemed. This is under the Particles configuration area of the YML file.

There are three primary settings that are included within the sound option. These are below:

• ParticleID: This is the minecraft Enum value of the particle to be shown. This may be set to 'none' to prevent any particles from being shown.

• Count: This is the number of particles that are generated.

• Offset: This is how far randomly offset (spread) the particles are from the origin (player torso). It is recommended to keep this value at 1 or below to ensure that the particles are not intrusive to other players.

It is worth noting that all particles are visible to all players, this can not be adjusted.

Validation

There are a couple of validation rules applied internally, these apply to the three primary configuration areas surrounding the particle setting.

ParticleID

The ParticleID must be a valid minecraft particle Enum in order for a particle to be shown. A list of valid particle Enum's can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html

Some data manipulation is applied to allow for different standards of writing. For example, let us consider the particle Enum VILLAGER_HAPPY This may be written as villager_happy, or villager.happy The plugin will automatically manipulate the data to the standard format of writing. That being said, this will not apply to all scenarios, and thus it is recommended that you enter the particle Enum exactly as found within the list.

Count

The Count value must be a valid integer (number) that is greater than or equal to 0. If a value less than 0 is given, the plugin will default to the value 20.

Offset

The Offset value must be a valid decimal-integer (number) that is greater than or equal to 0.0. If a value less than 0 is given, the plugin will default to the value 1.

Example Configuration Extract

An example configuration extract for the particle with Enum HEART, with count 20 and offset 1 has been included below:

# The particle data to be spawned on the player upon pouch redeem.
# Don't add this section if you don't need it.
Particles:
  ParticleID: 'HEART'
  Count: 20
  Offset: 1