EffectLib
EffectLib
Wiki https://github.com/elBukkit/EffectLib/wiki
Support on Discord: https://discord.gg/fWJ3W3kMjG
Forum (Outdated): http://forums.bukkit.org/threads/effectlib-manage-your-effects-the-nice-way.259879/
Description
THIS PLUGIN HAS NO USE FOR SERVER-OWNERS
This library is a possibility for developers to out-source their effect-managment. This library comes with a handy collection of customizable effects, but you can easily add your own effects and manage them in the library.
Usage
- See documentation for Maven-based instructions.
- OR Add the EffectLib.jar to you project and to the plugins in your server.
- Create a new EffectManager to handle your effects.
EffectManager em = new EffectManager(plugin);
- Create a new Effect and start it.
Effect effect = new BleedEffect(em); effect.setEntity(target); effect.start();
- Dispose of the EffectManager after when you are completely done with it.
em.dispose();
Demo
This demo creates a bleed-effect when a player joins. After 15 seconds, the effect runs out and the callback is called, that kills the player and sends them a message.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.yourdomain.yourplugin; import org.bukkit.Bukkit; import org.bukkit.event.EventHandler; import org.bukkit.event.HandlerList; import org.bukkit.event.Listener; import org.bukkit.event.player.PlayerJoinEvent; import org.bukkit.plugin.java.JavaPlugin; import de.slikey.effectlib.EffectManager; import de.slikey.effectlib.effect.BleedEffect; public class EffectLibTest extends JavaPlugin implements Listener { private EffectManager effectManager; @Override public void onEnable() { Bukkit.getPluginManager().registerEvents(this, this); // Initialize a new EffectManager effectManager = new EffectManager(this); } @Override public void onDisable() { // Dispose of the EffectManager effectManager.dispose(); HandlerList.unregisterAll((Listener) this); } @EventHandler public void onPlayerJoin(final PlayerJoinEvent event) { // Create the Effect and attach it to the Player BleedEffect bleedEffect = new BleedEffect(effectManager); bleedEffect.setEntity(event.getPlayer()); // Add a callback to the effect bleedEffect.callback = new Runnable() { @Override public void run() { event.getPlayer().sendMessage("You bled out.."); event.getPlayer().setHealth(0d); } }; // Bleeding takes 15 seconds // period * iterations = time of effect bleedEffect.iterations = 15 * 20; bleedEffect.start(); } } |
Effects Control
All effects can attach to a Location (setLocation) or an Entity (setEntity). Some Effects (like LineEffect) can work with two locations- use setTargetEntity and setTarget to control the "second point".
You can cancel all running effects of an EffectManager by cancel(boolean callback).
Configuration-Driven Effects
There is also a Configuration-driven interface you may use, EffectManager.start.
You may pass in the Effect class as a String, and additional parameters as a ConfigurationSection. This can be a fully-qualified path (for custom externally-defined Effects) or a simple class name for the builtin classes. For example:
summon: class: VortexEffect iterations: 4 particle: smoke helixes: 16 circles: 7 grow: 0.1 radius: 1
And then to use it, something like this:
ConfigurationSection effectConfig = getConfig().getConfigurationSection("summon"); String clasName = effectConfig.getString("class"); effectManager.start(className, effectConfig, player);
There are several different versions of the start() method as of 3.4, the longest one would look like this:
effectManager.start(className, effectConfig, player.getLocation(), player, null, null, null);
The latter three parameters are optional, the two "target" parameters used only in certain FX. The last line can be used for the TextEffect to have parameterizable text messages- for instance, if you wish to insert the Player's name in a Configuration-drive text message.
Current Effects
- ArcEffect - Create architectual correct arc of particles
- AtomEffect - Create the orbital-model of the atom
- BigBangEffect - Create a large cluster of fireworks.
- BleedEffect - Let the target entity bleed.
- ConeEffect - Cast a cone in all possible directions
- EarthEffect - Create a model of the Earth
- DnaEffect - Create DNA molecule
- ExplodeEffect - Create a explosion at location.
- FlameEffect - Let the target entity burn.
- FountainEffect - Create a foundtain for you well
- GridEffect - Customizable grid for you signwall
- HelixEffect - Create a customizable static helix.
- JumpEffect - Forces an entity to jump naturally.
- LineEffect - Draw line from A to B
- LoveEffect - The target entity is in love.
- MusicEffect - Circle of notes appeares above the entity.
- MusicEffect - Circle of notes appeares at a location.
- ShieldEffect - Spherical Shield around an entity.
- SkyRocketEffect - Foces an entity to fly into the sky.
- SmokeEffect - Let the target entity smoke.
- StarEffect - Create fully customizable 3D star
- TextEffect - Create particle-text with custom font, size and text
- TraceEffect - Create a trace along an entitys path.
- TurnPlayerEffect - Forces the player to turn in a circle.
- VortexEffect - Create a vortex of particles at location
- WarpEffect - Create a warp-effect around an entity
- WaveEffect - Create waves with surf.
- Feel free to send me your effects if you have coded up some custom ones of your own!
All effects have the ability to be changed. Let the effect repeat, increase duration or change period of iterations.
Any Effect will work when attached to a static location, or to an Entity. If both are provided, it will attach at the target Location, but move relative to that along with the entity (great for tagging hit locations, or attaching to an Entity's head or other body part specifically!)
Source
Get the source on GitHub!
What command do i use To have the spinny partical around me!!!!
What is the command to give yourself the effect
How do you use this
Really, really amazing lib. I can't believe I have gone so long without knowing about this amazing resource!!! Great work to all those involved.
^Thats my code, which I have tested and it didnt work..there isnt any error in the console.
Is there a way to cast a spell that lights up an area?
Thanks
Simply amazing <3
Going to use this all the time :D
10/10 Would ride this Effectlib into battle.
Does anyone know how to make a floating circle with particle effects above the player?
i've been looking for something like this for a long time thanks!!!! :D <3
@KingMagnus00
@Valon750
The 2.0 version can attach any Effect to any Entity. There is also an "orient" flag you can set- the end result being you can attach a ConeEffect to an origin Entity, and aim it at a target Entity.
This would make the effect follow both entities, "tying" them together as they move around.
Version 2.0
Hello everyone! I'm happy to announce that we've submitted version 2.0 - but please be aware the API has changed, and is not backwards-compatible!
The way you construct and start Effects has changed a bit, but there is now also a Configuration-driven approach you can use. I urge you to check this out when you switch, and consider making all of your effects configuration-driven. This will ultimately give your users more control over your Plugin's FX, which is a win for everyone! :)
The other major change is that all the class names are different. There is no longer a distinction between an "EntityEffect" and a "LocationEffect". Any Effect can now be played at a static Location, or attached to follow an Entity.
Let us know what you think, I'm hoping it won't be a big burden to migrate. When you do, make sure to check out the Maven shading options if you'd like to avoid version incompatibility issues in the future, and not rely on an external EffectLib plugin.
@Valon750
Location location = player.getLocation(); location.setDirection(location.getDirection().multiply(-1)); start effect with location
Is your Jenkis down ?
@Lennix3
it's the VortexLocationEffect :)
Can anyone say me how to create this?
@KingMagnus00
It seems to work, but you'd need to have a short particle life. I've only tried it with lines.
Quick question, I haven't used this yet but will in the future. Is it possible for an animation like the spiral effect to follow a player while that player is moving?
It does not work with an Scheduler?