Package studio.magemonkey.fabled.api.particle

Class ParticleSettings

java.lang.Object

studio.magemonkey.fabled.api.particle.ParticleSettings

public class ParticleSettings
extends Object

Settings for playing a particle

Field Summary

Fields

Modifier and Type	Field	Description
final int	amount
static final String	AMOUNT_KEY
static final String	DATA_KEY
static final String	DURABILITY_KEY
static final String	DUST_COLOR
static final String	DUST_SIZE
final float	dx
static final String	DX_KEY
final float	dy
static final String	DY_KEY
final float	dz
static final String	DZ_KEY
static final String	FINAL_DUST_COLOR
static final String	MATERIAL_KEY
final Object	object
static final String	PARTICLE_KEY
final float	speed
static final String	SPEED_KEY
final org.bukkit.Particle	type

Constructor Summary

Constructors

Constructor	Description
ParticleSettings(org.bukkit.Particle type, float dx, float dy, float dz, float speed, int amount, org.bukkit.Material material, int cmd, int durability, org.bukkit.Color dustColor, org.bukkit.Color toColor, float dusSize)	Sets up a particle that requires material cmd
ParticleSettings(studio.magemonkey.codex.mccore.config.parse.DataSection config)	Loads a particle setup from config data
ParticleSettings(Settings config, String prefix)	Loads a particle setup from config data

Method Summary

Modifier and Type	Method	Description
void	instance(org.bukkit.entity.Player player, double x, double y, double z)	Makes a new instance of the particle effect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARTICLE_KEY

public static final String PARTICLE_KEY

See Also:

• Constant Field Values

MATERIAL_KEY

public static final String MATERIAL_KEY

See Also:

• Constant Field Values

DURABILITY_KEY

public static final String DURABILITY_KEY

See Also:

• Constant Field Values

DATA_KEY

public static final String DATA_KEY

See Also:

• Constant Field Values

AMOUNT_KEY

public static final String AMOUNT_KEY

See Also:

• Constant Field Values

DX_KEY

public static final String DX_KEY

See Also:

• Constant Field Values

DY_KEY

public static final String DY_KEY

See Also:

• Constant Field Values

DZ_KEY

public static final String DZ_KEY

See Also:

• Constant Field Values

SPEED_KEY

public static final String SPEED_KEY

See Also:

• Constant Field Values

DUST_COLOR

public static final String DUST_COLOR

See Also:

• Constant Field Values

FINAL_DUST_COLOR

public static final String FINAL_DUST_COLOR

See Also:

• Constant Field Values

DUST_SIZE

public static final String DUST_SIZE

See Also:

• Constant Field Values

type

public final org.bukkit.Particle type

dx

public final float dx

dy

public final float dy

dz

public final float dz

speed

public final float speed

amount

public final int amount

object

public final Object object

Constructor Details

ParticleSettings

public ParticleSettings(org.bukkit.Particle type,
 float dx,
 float dy,
 float dz,
 float speed,
 int amount,
 org.bukkit.Material material,
 int cmd,
 int durability,
 org.bukkit.Color dustColor,
 org.bukkit.Color toColor,
 float dusSize)

Sets up a particle that requires material cmd

Parameters:

type - particle type

dx - DX value

dy - DY value

dz - DZ value

speed - particle speed

amount - particle amount

material - material to use

cmd - material cmd value

ParticleSettings

public ParticleSettings(studio.magemonkey.codex.mccore.config.parse.DataSection config)

Loads a particle setup from config data

Parameters:

config - config data to load from

ParticleSettings

public ParticleSettings(Settings config,
 String prefix)

Loads a particle setup from config data

Parameters:

config - config data to load from

prefix - string to look for at the beginning of each config key

Method Details

instance

public void instance(org.bukkit.entity.Player player,
 double x,
 double y,
 double z)

Makes a new instance of the particle effect

Parameters:

x - X-axis coordinates

y - Y-axis coordinates

z - Z-axis coordinates