Package studio.magemonkey.fabled.api.particle

Class EffectPlayer

java.lang.Object

studio.magemonkey.fabled.api.particle.EffectPlayer

public class EffectPlayer
extends Object

Handles playing effects based on configuration settings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMOUNT
static final String	ANIM_DIR
static final String	ANIM_SIZE
static final String	ANIMATION
static final String	CMD
static final String	DURABILITY
static final String	DUST_COLOR
static final String	DUST_SIZE
static final String	DX
static final String	DY
static final String	DZ
static final String	FINAL_DUST_COLOR
static final String	INITIAL_ROTATION
static final String	INTERVAL
static final String	MAT
static final String	P_TYPE
static final String	SHAPE
static final String	SHAPE_DIR
static final String	SHAPE_SIZE
static final String	SPEED
static final String	VIEW_RANGE
static final String	WITH_ROTATION

Constructor Summary

Constructors

Constructor	Description
EffectPlayer(Settings settings)	Sets up an effect player that applies effects based of the values in the provided settings.

Method Summary

Modifier and Type	Method	Description
void	start(EffectTarget target, String key, int ticks, int level)	Plays a particle effect, grabbing values from the settings data
void	start(EffectTarget target, String key, int ticks, int level, boolean noPrefix)	Plays a particle effect, grabbing values from the settings data

Methods inherited from class java.lang.Object

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

Field Details

SHAPE

public static final String SHAPE

See Also:

• Constant Field Values

SHAPE_DIR

public static final String SHAPE_DIR

See Also:

• Constant Field Values

SHAPE_SIZE

public static final String SHAPE_SIZE

See Also:

• Constant Field Values

ANIMATION

public static final String ANIMATION

See Also:

• Constant Field Values

ANIM_DIR

public static final String ANIM_DIR

See Also:

• Constant Field Values

ANIM_SIZE

public static final String ANIM_SIZE

See Also:

• Constant Field Values

INTERVAL

public static final String INTERVAL

See Also:

• Constant Field Values

VIEW_RANGE

public static final String VIEW_RANGE

See Also:

• Constant Field Values

WITH_ROTATION

public static final String WITH_ROTATION

See Also:

• Constant Field Values

INITIAL_ROTATION

public static final String INITIAL_ROTATION

See Also:

• Constant Field Values

P_TYPE

public static final String P_TYPE

See Also:

• Constant Field Values

MAT

public static final String MAT

See Also:

• Constant Field Values

DURABILITY

public static final String DURABILITY

See Also:

• Constant Field Values

CMD

public static final String CMD

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

AMOUNT

public static final String AMOUNT

See Also:

• Constant Field Values

DX

public static final String DX

See Also:

• Constant Field Values

DY

public static final String DY

See Also:

• Constant Field Values

DZ

public static final String DZ

See Also:

• Constant Field Values

SPEED

public static final String SPEED

See Also:

• Constant Field Values

Constructor Details

EffectPlayer

public EffectPlayer(Settings settings)

Sets up an effect player that applies effects based of the values in the provided settings. All of the available settings are provided as static values in this class.

Parameters:

settings - settings to read from

Method Details

start

public void start(EffectTarget target,
 String key,
 int ticks,
 int level)

Plays a particle effect, grabbing values from the settings data

Parameters:

target - target to play for

key - effect key to use

ticks - duration of effect in ticks

level - level of the effect

start

public void start(EffectTarget target,
 String key,
 int ticks,
 int level,
 boolean noPrefix)

Plays a particle effect, grabbing values from the settings data

Parameters:

target - target to play for

key - effect key to use

ticks - duration of effect in ticks

level - level of the effect

noPrefix - exclude prefix when grabbing settings