Effect (EffectLib 9.4 API)

java.lang.Object
- de.slikey.effectlib.Effect

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AnimatedBallEffect, ArcEffect, AtomEffect, BaseImageEffect, BigBangEffect, BleedEffect, CircleEffect, CloudEffect, ConeEffect, CubeEffect, CuboidEffect, CylinderEffect, DiscoBallEffect, DnaEffect, DonutEffect, DragonEffect, EarthEffect, EquationEffect, ExplodeEffect, FlameEffect, FountainEffect, GridEffect, HeartEffect, HelixEffect, HillEffect, IconEffect, JumpEffect, LineEffect, LoveEffect, ModifiedEffect, MusicEffect, ParticleEffect, PlotEffect, PyramidEffect, ShieldEffect, SmokeEffect, SoundEffect, SphereEffect, SquareEffect, StarEffect, TextEffect, TornadoEffect, TraceEffect, TurnEffect, VortexEffect, WarpEffect, WaveEffect
```
public abstract class Effect
extends Object
implements Runnable
```

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`arrivalTime` Used only by the vibration particle in 1.17 and up
`boolean`	`asynchronous` If set, will run asynchronously.
`boolean`	`autoOrient` If true, and a "target" Location or Entity is set, the two Locations will orient to face one another.
`Runnable`	`callback` Callback to run, after effect is done.
`org.bukkit.Color`	`color` Can be used to colorize certain particles.
`List<org.bukkit.Color>`	`colorList`
`String`	`colors`
`int`	`delay` Delay to wait for delayed effects.
`boolean`	`disappearWithOriginEntity` Should this effect stop playing if the origin entity becomes invalid?
`boolean`	`disappearWithTargetEntity` Should this effect stop playing if the target entity becomes invalid?
`Integer`	`duration` Total duration of this effect in milliseconds.
`protected EffectManager`	`effectManager`
`int`	`iterations` Amount of repetitions to do.
`org.bukkit.Material`	`material` The Material and data to use for block and item break particles
`byte`	`materialData`
`protected int`	`maxIterations` This will store the base number of iterations
`org.bukkit.util.Vector`	`offset` If set, will offset the origin location
`protected DynamicLocation`	`origin`
`int`	`particleCount` These can be used to spawn multiple particles per packet.
`float`	`particleData` This can be used to give particles a set speed when spawned.
`float`	`particleOffsetX` These can be used to apply an offset to spawned particles, particularly useful when spawning multiples.
`float`	`particleOffsetY`
`float`	`particleOffsetZ`
`float`	`particleSize` This can be used to scale up or down a particle's size.
`int`	`period` Interval to wait for repeating effects.
`Float`	`pitch`
`float`	`pitchOffset`
`double`	`probability` Probability that this effect will play on each iteration
`org.bukkit.util.Vector`	`relativeOffset` If set, will offset the origin location, relative to the origin direction
`float`	`speed` Deprecated.
`org.bukkit.configuration.ConfigurationSection`	`subEffect`
`protected DynamicLocation`	`target`
`org.bukkit.util.Vector`	`targetOffset` If set, will offset the target location
`org.bukkit.entity.Player`	`targetPlayer` A specific player who should see this effect.
`List<org.bukkit.entity.Player>`	`targetPlayers` A group of players who should see this effect.
`org.bukkit.Color`	`toColor` Used for dust particles in 1.17 and up, to make a color transition.
`List<org.bukkit.Color>`	`toColorList`
`String`	`toColors`
`EffectType`	`type` Handles the type, the effect is played.
`boolean`	`updateDirections` If set to false, Entity-bound directions will not update during the Effect
`boolean`	`updateLocations` If set to false, Entity-bound locations will not update during the Effect
`float`	`visibleRange` Display particles to players within this radius.
`Float`	`yaw`
`float`	`yawOffset` These are used to modify the direction of the origin Location.

Constructor Summary

Constructors
Constructor and Description

Effect(EffectManager effectManager)

Constructors
Constructor and Description
`Effect(EffectManager effectManager)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()`
`void`	`cancel(boolean callback)`
`protected void`	`display(org.bukkit.Particle effect, org.bukkit.Location location)`
`protected void`	`display(org.bukkit.Particle particle, org.bukkit.Location location, org.bukkit.Color color)`
`protected void`	`display(org.bukkit.Particle particle, org.bukkit.Location location, org.bukkit.Color color, org.bukkit.Color toColor, float speed, int amount)`
`protected void`	`display(org.bukkit.Particle particle, org.bukkit.Location location, org.bukkit.Color color, float speed, int amount)`
`protected void`	`display(org.bukkit.Particle particle, org.bukkit.Location location, float speed, int amount)`
`int`	`getDelay()`
`org.bukkit.entity.Entity`	`getEntity()` Extending Effect classes can use this to determine the Entity this Effect is centered upon.
`org.bukkit.Location`	`getLocation()` Extending Effect classes should use this method to obtain the current "root" Location of the effect.
`int`	`getPeriod()`
`long`	`getStartTime()`
`org.bukkit.Location`	`getTarget()` Extending Effect classes should use this method to obtain the current "target" Location of the effect.
`org.bukkit.entity.Entity`	`getTargetEntity()` Extending Effect classes can use this to determine the Entity this Effect is targeted upon.
`org.bukkit.entity.Player`	`getTargetPlayer()`
`EffectType`	`getType()`
`void`	`infinite()`
`protected void`	`initialize()`
`boolean`	`isAsynchronous()`
`boolean`	`isDone()`
`void`	`onDone()` Called when this effect is done playing (when `done()` is called).
`abstract void`	`onRun()`
`protected List<org.bukkit.Color>`	`parseColorList(String colors)`
`void`	`prepare()`
`void`	`reloadParameters()`
`protected void`	`reset()` Effects should override this if they want to be reusable, this is called prior to starting so state can be reset.
`void`	`run()`
`void`	`setDynamicOrigin(DynamicLocation location)` Set the Location this Effect is centered on.
`void`	`setDynamicTarget(DynamicLocation location)` Set the Location this Effect is targeting.
`void`	`setEntity(org.bukkit.entity.Entity entity)`
`void`	`setLocation(org.bukkit.Location location)`
`void`	`setStartTime(long startTime)`
`void`	`setTargetEntity(org.bukkit.entity.Entity entity)`
`void`	`setTargetLocation(org.bukkit.Location location)`
`void`	`setTargetPlayer(org.bukkit.entity.Player p)`
`void`	`start()`
`protected void`	`updateDuration()`
`protected void`	`updateLocation()`
`protected void`	`updateTarget()`
`protected boolean`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - subEffect
```
public org.bukkit.configuration.ConfigurationSection subEffect
```
  - type
```
public EffectType type
```
    Handles the type, the effect is played.
    
    See Also:
    
    de.slikey.effectlib.EffectType}
  - color
```
public org.bukkit.Color color
```
    Can be used to colorize certain particles. As of 1.8, those include SPELL_MOB_AMBIENT, SPELL_MOB and REDSTONE.
  - colorList
```
public List<org.bukkit.Color> colorList
```
  - colors
```
public String colors
```
  - toColor
```
public org.bukkit.Color toColor
```
    Used for dust particles in 1.17 and up, to make a color transition.
  - toColorList
```
public List<org.bukkit.Color> toColorList
```
  - toColors
```
public String toColors
```
  - arrivalTime
```
public int arrivalTime
```
    Used only by the vibration particle in 1.17 and up
  - speed
```
@Deprecated
public float speed
```
    Deprecated.
    
    This can be used to give particles a set speed when spawned. This will not work with colored particles.
  - particleData
```
public float particleData
```
    This can be used to give particles a set speed when spawned. This will not work with colored particles. This is a replacement for "speed"
  - delay
```
public int delay
```
    Delay to wait for delayed effects.
    
    See Also:
    
    de.slikey.effectlib.EffectType}
  - period
```
public int period
```
    Interval to wait for repeating effects.
    
    See Also:
    
    de.slikey.effectlib.EffectType}
  - iterations
```
public int iterations
```
    Amount of repetitions to do. Set this to -1 for an infinite effect
    
    See Also:
    
    de.slikey.effectlib.EffectType}
  - duration
```
public Integer duration
```
    Total duration of this effect in milliseconds. If set, this will adjust iterations to match the defined delay such that the effect lasts a specific duration.
  - probability
```
public double probability
```
    Probability that this effect will play on each iteration
  - callback
```
public Runnable callback
```
    Callback to run, after effect is done.
    
    See Also:
    
    java.lang.Runnable}
  - visibleRange
```
public float visibleRange
```
    Display particles to players within this radius.
  - autoOrient
```
public boolean autoOrient
```
    If true, and a "target" Location or Entity is set, the two Locations will orient to face one another.
  - offset
```
public org.bukkit.util.Vector offset
```
    If set, will offset the origin location
  - relativeOffset
```
public org.bukkit.util.Vector relativeOffset
```
    If set, will offset the origin location, relative to the origin direction
  - targetOffset
```
public org.bukkit.util.Vector targetOffset
```
    If set, will offset the target location
  - yawOffset
```
public float yawOffset
```
    These are used to modify the direction of the origin Location.
  - pitchOffset
```
public float pitchOffset
```
  - yaw
```
public Float yaw
```
  - pitch
```
public Float pitch
```
  - updateLocations
```
public boolean updateLocations
```
    If set to false, Entity-bound locations will not update during the Effect
  - updateDirections
```
public boolean updateDirections
```
    If set to false, Entity-bound directions will not update during the Effect
  - targetPlayer
```
public org.bukkit.entity.Player targetPlayer
```
    A specific player who should see this effect.
  - targetPlayers
```
public List<org.bukkit.entity.Player> targetPlayers
```
    A group of players who should see this effect.
  - material
```
public org.bukkit.Material material
```
    The Material and data to use for block and item break particles
  - materialData
```
public byte materialData
```
  - particleCount
```
public int particleCount
```
    These can be used to spawn multiple particles per packet. It will not work with colored particles, however.
  - particleOffsetX
```
public float particleOffsetX
```
    These can be used to apply an offset to spawned particles, particularly useful when spawning multiples.
  - particleOffsetY
```
public float particleOffsetY
```
  - particleOffsetZ
```
public float particleOffsetZ
```
  - particleSize
```
public float particleSize
```
    This can be used to scale up or down a particle's size. This currently only works with the redstone particle in 1.13 and up.
  - asynchronous
```
public boolean asynchronous
```
    If set, will run asynchronously. Some effects don't support this (TurnEffect, JumpEffect) Generally this shouldn't be changed, unless you want to make an async effect synchronous.
  - effectManager
```
protected final EffectManager effectManager
```
  - origin
```
protected DynamicLocation origin
```
  - target
```
protected DynamicLocation target
```
  - maxIterations
```
protected int maxIterations
```
    This will store the base number of iterations
  - disappearWithOriginEntity
```
public boolean disappearWithOriginEntity
```
    Should this effect stop playing if the origin entity becomes invalid?
  - disappearWithTargetEntity
```
public boolean disappearWithTargetEntity
```
    Should this effect stop playing if the target entity becomes invalid?
- Constructor Detail
  - Effect
```
public Effect(EffectManager effectManager)
```
- Method Detail
  - parseColorList
```
protected List<org.bukkit.Color> parseColorList(String colors)
```
  - initialize
```
protected void initialize()
```
  - cancel
```
public final void cancel()
```
  - cancel
```
public final void cancel(boolean callback)
```
  - isDone
```
public final boolean isDone()
```
  - onRun
```
public abstract void onRun()
```
  - onDone
```
public void onDone()
```
    Called when this effect is done playing (when done() is called).
  - run
```
public final void run()
```
    Specified by:
    
    run in interface Runnable
  - reset
```
protected void reset()
```
    Effects should override this if they want to be reusable, this is called prior to starting so state can be reset.
  - prepare
```
public void prepare()
```
  - start
```
public final void start()
```
  - infinite
```
public final void infinite()
```
  - getEntity
```
public org.bukkit.entity.Entity getEntity()
```
    Extending Effect classes can use this to determine the Entity this Effect is centered upon. This may return null, even for an Effect that was set with an Entity, if the Entity gets GC'd.
  - getTargetEntity
```
public org.bukkit.entity.Entity getTargetEntity()
```
    Extending Effect classes can use this to determine the Entity this Effect is targeted upon. This is probably a very rare case, such as an Effect that "links" two Entities together somehow. (Idea!) This may return null, even for an Effect that was set with a target Entity, if the Entity gets GC'd.
  - getLocation
```
public final org.bukkit.Location getLocation()
```
    Extending Effect classes should use this method to obtain the current "root" Location of the effect. This method will not return null when called from onRun. Effects with invalid locations will be cancelled.
  - getTarget
```
public final org.bukkit.Location getTarget()
```
    Extending Effect classes should use this method to obtain the current "target" Location of the effect. Unlike getLocation, this may return null.
  - setDynamicOrigin
```
public void setDynamicOrigin(DynamicLocation location)
```
    Set the Location this Effect is centered on.
  - setDynamicTarget
```
public void setDynamicTarget(DynamicLocation location)
```
    Set the Location this Effect is targeting.
  - validate
```
protected final boolean validate()
```
  - updateDuration
```
protected void updateDuration()
```
  - updateLocation
```
protected void updateLocation()
```
  - updateTarget
```
protected void updateTarget()
```
  - display
```
protected void display(org.bukkit.Particle effect,
                       org.bukkit.Location location)
```
  - display
```
protected void display(org.bukkit.Particle particle,
                       org.bukkit.Location location,
                       org.bukkit.Color color)
```
  - display
```
protected void display(org.bukkit.Particle particle,
                       org.bukkit.Location location,
                       float speed,
                       int amount)
```
  - display
```
protected void display(org.bukkit.Particle particle,
                       org.bukkit.Location location,
                       org.bukkit.Color color,
                       float speed,
                       int amount)
```
  - display
```
protected void display(org.bukkit.Particle particle,
                       org.bukkit.Location location,
                       org.bukkit.Color color,
                       org.bukkit.Color toColor,
                       float speed,
                       int amount)
```
  - getType
```
public EffectType getType()
```
  - isAsynchronous
```
public boolean isAsynchronous()
```
  - getDelay
```
public int getDelay()
```
  - getPeriod
```
public int getPeriod()
```
  - setEntity
```
public void setEntity(org.bukkit.entity.Entity entity)
```
  - setLocation
```
public void setLocation(org.bukkit.Location location)
```
  - setTargetEntity
```
public void setTargetEntity(org.bukkit.entity.Entity entity)
```
  - setTargetLocation
```
public void setTargetLocation(org.bukkit.Location location)
```
  - getTargetPlayer
```
public org.bukkit.entity.Player getTargetPlayer()
```
  - setTargetPlayer
```
public void setTargetPlayer(org.bukkit.entity.Player p)
```
  - getStartTime
```
public long getStartTime()
```
  - setStartTime
```
public void setStartTime(long startTime)
```
  - reloadParameters
```
public void reloadParameters()
```

Class Effect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

subEffect

type

color

colorList

colors

toColor

toColorList

toColors

arrivalTime

speed

particleData

delay

period

iterations

duration

probability

callback

visibleRange

autoOrient

offset

relativeOffset

targetOffset

yawOffset

pitchOffset

yaw

pitch

updateLocations

updateDirections

targetPlayer

targetPlayers

material

materialData

particleCount

particleOffsetX

particleOffsetY

particleOffsetZ

particleSize

asynchronous

effectManager

origin

target

maxIterations

disappearWithOriginEntity

disappearWithTargetEntity

Constructor Detail

Effect

Method Detail

parseColorList

initialize

cancel

cancel

isDone

onRun

onDone

run

reset

prepare

start

infinite

getEntity

getTargetEntity

getLocation

getTarget

setDynamicOrigin

setDynamicTarget

validate

updateDuration

updateLocation

updateTarget

display

display

display

display

display