Package studio.magemonkey.fabled.api.particle

Class ParticleHelper

java.lang.Object

studio.magemonkey.fabled.api.particle.ParticleHelper

public final class ParticleHelper
extends Object

Simplified particle utility compared to MCCore's

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMOUNT_KEY
static final String	ARRANGEMENT_KEY
static final String	CMD_KEY
static final String	DATA_KEY
static final String	DIRECTION_KEY
static final String	DURABILITY_KEY
static final String	DUST_COLOR
static final String	DUST_SIZE
static final String	DX_KEY
static final String	DY_KEY
static final String	DZ_KEY
static final String	FINAL_DUST_COLOR
static final String	LEVEL
static final String	MATERIAL_KEY
static final String	PARTICLE_KEY
static final String	POINTS_KEY
static final String	RADIUS_KEY
static final String	SPEED_KEY
static final String	VISIBLE_RADIUS_KEY

Method Summary

Modifier and Type	Method	Description
static void	fillCircle(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object)
static void	fillCircle(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object, String particleKey, Set<org.bukkit.entity.Player> viewers)	Plays several of a particle type randomly within a circle
static void	fillHemisphere(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object)
static void	fillHemisphere(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object, String particleKey, Set<org.bukkit.entity.Player> viewers)	Randomly plays particle effects within the hemisphere
static void	fillSphere(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object)
static void	fillSphere(org.bukkit.Location loc, Settings settings, int level, int points, double visibleRadius, org.bukkit.Particle particle, int amount, double dx, double dy, double dz, float speed, Object object, String particleKey, Set<org.bukkit.entity.Player> viewers)	Randomly plays particle effects within the sphere
static Set<org.bukkit.entity.Player>	filterPlayers(Collection<org.bukkit.entity.Player> players, org.bukkit.Location location, double visibleRadius)
static org.bukkit.Particle	getFromKey(String particleKey)
static Object	makeObject(org.bukkit.Particle particle, org.bukkit.Material material, int cmd, int durability, org.bukkit.Color dustColor, org.bukkit.Color toColor, float dustSize)
static Object	makeObject(org.bukkit.Particle particle, Settings settings)
static Object	makeObject(org.bukkit.Particle particle, Settings settings, String particleKey)
static void	play(org.bukkit.Location loc, Settings settings)	Plays particles about the given location using the given settings
static void	play(org.bukkit.Location loc, Settings settings, Set<org.bukkit.entity.Player> viewers, String particleKey, org.bukkit.util.BoundingBox targetHitbox)	Plays particles about the given location using the given settings

Methods inherited from class java.lang.Object

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

Field Details

ARRANGEMENT_KEY

public static final String ARRANGEMENT_KEY

See Also:

• Constant Field Values

POINTS_KEY

public static final String POINTS_KEY

See Also:

• Constant Field Values

LEVEL

public static final String LEVEL

See Also:

• Constant Field Values

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

CMD_KEY

public static final String CMD_KEY

See Also:

• Constant Field Values

DURABILITY_KEY

public static final String DURABILITY_KEY

See Also:

• Constant Field Values

RADIUS_KEY

public static final String RADIUS_KEY

See Also:

• Constant Field Values

AMOUNT_KEY

public static final String AMOUNT_KEY

See Also:

• Constant Field Values

DIRECTION_KEY

public static final String DIRECTION_KEY

See Also:

• Constant Field Values

VISIBLE_RADIUS_KEY

public static final String VISIBLE_RADIUS_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

DATA_KEY

public static final String DATA_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

Method Details

getFromKey

public static org.bukkit.Particle getFromKey(String particleKey)

play

public static void play(org.bukkit.Location loc,
 Settings settings,
 @Nullable
 Set<org.bukkit.entity.Player> viewers,
 String particleKey,
 @Nullable
 org.bukkit.util.BoundingBox targetHitbox)

Plays particles about the given location using the given settings

play

public static void play(org.bukkit.Location loc,
 Settings settings)

Plays particles about the given location using the given settings

fillCircle

public static void fillCircle(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object,
 String particleKey,
 @Nullable
 Set<org.bukkit.entity.Player> viewers)

Plays several of a particle type randomly within a circle

fillCircle

public static void fillCircle(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object)

fillSphere

public static void fillSphere(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object,
 String particleKey,
 @Nullable
 Set<org.bukkit.entity.Player> viewers)

Randomly plays particle effects within the sphere

fillSphere

public static void fillSphere(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object)

fillHemisphere

public static void fillHemisphere(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object,
 String particleKey,
 @Nullable
 Set<org.bukkit.entity.Player> viewers)

Randomly plays particle effects within the hemisphere

fillHemisphere

public static void fillHemisphere(org.bukkit.Location loc,
 Settings settings,
 int level,
 int points,
 double visibleRadius,
 org.bukkit.Particle particle,
 int amount,
 double dx,
 double dy,
 double dz,
 float speed,
 Object object)

makeObject

public static Object makeObject(org.bukkit.Particle particle,
 Settings settings,
 String particleKey)

makeObject

public static Object makeObject(org.bukkit.Particle particle,
 Settings settings)

makeObject

public static Object makeObject(org.bukkit.Particle particle,
 org.bukkit.Material material,
 int cmd,
 int durability,
 org.bukkit.Color dustColor,
 org.bukkit.Color toColor,
 float dustSize)

filterPlayers

public static Set<org.bukkit.entity.Player> filterPlayers(Collection<org.bukkit.entity.Player> players,
 org.bukkit.Location location,
 double visibleRadius)