Add an AvailableEvent(s) annotation

src/main/java/ch/njol/skript/doc/AvailableEvents.java

@@ -0,0 +1,17 @@
+package ch.njol.skript.doc;
+
+import org.bukkit.event.Event;
+
+import java.lang.annotation.*;
+
+/**
+ * Provides a list of {@link org.bukkit.event.Event}s that this syntax element can be used in.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface AvailableEvents {
+
+	Class<? extends Event>[] value();
+
+}

src/main/java/ch/njol/skript/doc/Events.java

@@ -11,10 +11,15 @@
 
 /**
  * @author Peter Güttinger
+ *
+ * @deprecated
+ * This annotation is deprecated, please use {@link AvailableEvents} instead
+ *
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@Deprecated(since = "INSERT VERSION")
 public @interface Events {
 	/**
 	 * A list of {@link SkriptEventInfo#getName() name(s)} of {@link SkriptEvent events} this expression is useful for.

src/main/java/ch/njol/skript/doc/JSONGenerator.java

@@ -36,18 +36,24 @@ public class JSONGenerator extends DocumentationGenerator {
 	/**
 	 * The current version of the JSON generator
 	 */
-	public static final Version JSON_VERSION = new Version(1, 0);
+	public static final Version JSON_VERSION = new Version(2, 0);
 
 	private static final Gson GSON = new GsonBuilder()
 		.disableHtmlEscaping()
 		.setPrettyPrinting()
 		.serializeNulls()
 		.create();
 
+	private static final Map<Class<? extends Event>, List<SkriptEventInfo<?>>> events = new HashMap<>();
+
 	public JSONGenerator(File templateDir, File outputDir) {
 		super(templateDir, outputDir);
 	}
 
+	static {
+		cacheEvents();
+	}
+
 	/**
 	 * @return The version of the JSON generator
 	 */
@@ -117,8 +123,9 @@ private static JsonObject generatedAnnotatedElement(SyntaxElementInfo<?> syntaxI
 			syntaxJsonObject.add("examples", null);
 		}
 
-		Events events = syntaxClass.getAnnotation(Events.class);
-		syntaxJsonObject.add("events", events == null ? null : convertToJsonArray(events.value()));
+		AvailableEvents availableEvents = syntaxClass.getAnnotation(AvailableEvents.class);
+		syntaxJsonObject.add("events", getSkriptEvents(availableEvents));
+
 
 		RequiredPlugins requirements = syntaxClass.getAnnotation(RequiredPlugins.class);
 		syntaxJsonObject.add("requirements", requirements == null ? null : convertToJsonArray(requirements.value()));
@@ -129,6 +136,23 @@ private static JsonObject generatedAnnotatedElement(SyntaxElementInfo<?> syntaxI
 		return syntaxJsonObject;
 	}
 
+	private static @Nullable JsonArray getSkriptEvents(@Nullable AvailableEvents availableEvents) {
+		if (availableEvents == null || availableEvents.value().length == 0) 
+			return null;
+		JsonArray skriptEvents = new JsonArray();
+		for (Class<? extends Event> event : availableEvents.value()) {
+			if (events.get(event) == null) 
+				continue;
+			for (SkriptEventInfo<?> skriptEvent : events.get(event)) {
+				JsonObject skriptEventJson = new JsonObject();
+				skriptEventJson.addProperty("id", skriptEvent.getDocumentationID() == null ? skriptEvent.getId() : skriptEvent.getDocumentationID());
+				skriptEventJson.addProperty("name", skriptEvent.getName());
+				skriptEvents.add(skriptEventJson);
+			}
+		}
+		return skriptEvents;
+	}
+
 	/**
 	 * Generates the documentation JsonObject for an event
 	 *
@@ -372,6 +396,14 @@ private static JsonArray cleanPatterns(String... strings) {
 		return convertToJsonArray(strings);
 	}
 
+	private static void cacheEvents() {
+		for (SkriptEventInfo<?> eventInfo : Skript.getEvents()) {
+			for (Class<? extends Event> event : eventInfo.events) {
+				events.computeIfAbsent(event, key -> new ArrayList<>()).add(eventInfo);
+			}
+		}
+	}
+
 	/**
 	 * Writes the documentation JsonObject to an output path
 	 *

src/main/java/ch/njol/skript/expressions/ExprAbsorbedBlocks.java

@@ -3,17 +3,13 @@
 import java.util.Iterator;
 import java.util.List;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.block.BlockState;
 import org.bukkit.event.Event;
 import org.bukkit.event.block.SpongeAbsorbEvent;
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.Skript;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -24,6 +20,7 @@
 
 @Name("Absorbed blocks")
 @Description("The blocks absorbed by a sponge block.")
+@AvailableEvents(SpongeAbsorbEvent.class)
 @Events("sponge absorb")
 @Examples("the absorbed blocks")
 @Since("2.5")

src/main/java/ch/njol/skript/expressions/ExprAppliedEffect.java

@@ -21,6 +21,7 @@
 		"\telse if applied effect = secondary effect:",
 			"\t\tbroadcast \"Is Secondary\""
 })
+@AvailableEvents(BeaconEffectEvent.class)
 @Events("Beacon Effect")
 @RequiredPlugins("Paper")
 @Since("2.10")

src/main/java/ch/njol/skript/expressions/ExprAppliedEnchantments.java

@@ -1,17 +1,13 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.event.Event;
 import org.bukkit.event.enchantment.EnchantItemEvent;
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.classes.Changer.ChangeMode;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -26,6 +22,7 @@
 				" Deleting or removing the applied enchantments will prevent the item's enchantment."})
 @Examples({"on enchant:",
 			"\tset the applied enchantments to sharpness 10 and fire aspect 5"})
+@AvailableEvents(EnchantItemEvent.class)
 @Events("enchant")
 @Since("2.5")
 public class ExprAppliedEnchantments extends SimpleExpression<EnchantmentType> {

src/main/java/ch/njol/skript/expressions/ExprAttacked.java

@@ -2,6 +2,7 @@
 
 import java.lang.reflect.Array;
 
+import ch.njol.skript.doc.*;
 import ch.njol.skript.lang.EventRestrictedSyntax;
 import ch.njol.util.coll.CollectionUtils;
 import org.bukkit.entity.Entity;
@@ -16,11 +17,6 @@
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.Skript;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.entity.EntityData;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
@@ -37,6 +33,8 @@
 	"\tvictim is a creeper",
 	"\tdamage the attacked by 1 heart"})
 @Since("1.3, 2.6.1 (projectile hit event)")
+@AvailableEvents({EntityDamageEvent.class, EntityDeathEvent.class,
+	VehicleDamageEvent.class, VehicleDestroyEvent.class, ProjectileHitEvent.class})
 @Events({"damage", "death", "projectile hit"})
 public class ExprAttacked extends SimpleExpression<Entity> implements EventRestrictedSyntax {
 

src/main/java/ch/njol/skript/expressions/ExprAttacker.java

@@ -1,5 +1,6 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.doc.*;
 import ch.njol.skript.lang.EventRestrictedSyntax;
 import ch.njol.util.coll.CollectionUtils;
 import org.bukkit.entity.Entity;
@@ -13,11 +14,6 @@
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.Skript;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -37,6 +33,8 @@
 		"	health of attacker is less than or equal to 2",
 		"	damage victim by 1 heart"})
 @Since("1.3")
+@AvailableEvents({EntityDamageEvent.class, EntityDeathEvent.class,
+	VehicleDamageEvent.class, VehicleDestroyEvent.class})
 @Events({"damage", "death", "destroy"})
 public class ExprAttacker extends SimpleExpression<Entity> implements EventRestrictedSyntax {
 

src/main/java/ch/njol/skript/expressions/ExprBeaconValues.java

@@ -37,6 +37,7 @@
 	"add 1 to range of {_block}"
 })
 @RequiredPlugins("Paper (range)")
+@AvailableEvents({PlayerChangeBeaconEffectEvent.class, BeaconEffectEvent.class, BeaconActivatedEvent.class, BeaconDeactivatedEvent.class})
 @Events({"Beacon Effect", "Beacon Toggle", "Beacon Change Effect"})
 @Since("2.10")
 public class ExprBeaconValues extends PropertyExpression<Block, Object> {

src/main/java/ch/njol/skript/expressions/ExprClicked.java

@@ -2,6 +2,7 @@
 
 import java.lang.reflect.Array;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.block.Block;
 import org.bukkit.entity.Entity;
 import org.bukkit.event.Event;
@@ -17,11 +18,6 @@
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.ItemType;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.entity.EntityData;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
@@ -41,6 +37,7 @@
 		"\tshow the inventory of the clicked block to the player"
 })
 @Since("1.0, 2.2-dev35 (more clickable things)")
+@AvailableEvents({PlayerInteractEntityEvent.class, PlayerInteractAtEntityEvent.class, InventoryClickEvent.class, EnchantItemEvent.class, PlayerInteractEvent.class})
 @Events({"click", "inventory click"})
 public class ExprClicked extends SimpleExpression<Object> {
 

src/main/java/ch/njol/skript/expressions/ExprCommand.java

@@ -1,6 +1,7 @@
 package ch.njol.skript.expressions;
 
 import ch.njol.skript.command.ScriptCommandEvent;
+import ch.njol.skript.doc.*;
 import ch.njol.skript.lang.EventRestrictedSyntax;
 import ch.njol.util.coll.CollectionUtils;
 import org.bukkit.event.Event;
@@ -9,11 +10,6 @@
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.Skript;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -32,6 +28,7 @@
 		"\t\t\tmessage \"You're not allowed to use commands during the game\"",
 		"\t\t\tcancel the event"})
 @Since("2.0, 2.7 (support for script commands)")
+@AvailableEvents({PlayerCommandPreprocessEvent.class, ServerCommandEvent.class, ScriptCommandEvent.class})
 @Events("command")
 public class ExprCommand extends SimpleExpression<String> implements EventRestrictedSyntax {
 

src/main/java/ch/njol/skript/expressions/ExprCommandSender.java

@@ -1,13 +1,12 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.command.ScriptCommandEvent;
+import ch.njol.skript.doc.*;
 import org.bukkit.command.CommandSender;
 
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.EventValueExpression;
+import org.bukkit.event.player.PlayerCommandPreprocessEvent;
+import org.bukkit.event.server.ServerCommandEvent;
 
 @Name("Command Sender")
 @Description({
@@ -21,6 +20,7 @@
 		"\tlog \"%executor% used command /%command% %arguments%\" to \"commands.log\""
 })
 @Since("2.0")
+@AvailableEvents({PlayerCommandPreprocessEvent.class, ServerCommandEvent.class, ScriptCommandEvent.class})
 @Events("command")
 public class ExprCommandSender extends EventValueExpression<CommandSender> {
 

src/main/java/ch/njol/skript/expressions/ExprDamage.java

@@ -1,5 +1,6 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.event.Event;
 import org.bukkit.event.entity.EntityDamageEvent;
 import org.bukkit.event.player.PlayerItemDamageEvent;
@@ -9,11 +10,6 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.bukkitutil.HealthUtils;
 import ch.njol.skript.classes.Changer.ChangeMode;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -36,6 +32,7 @@
 		"\tincrease the damage by 2"
 })
 @Since("1.3.5, 2.8.0 (item damage event)")
+@AvailableEvents({EntityDamageEvent.class, VehicleDamageEvent.class, PlayerItemDamageEvent.class})
 @Events({"Damage", "Vehicle Damage", "Item Damage"})
 public class ExprDamage extends SimpleExpression<Number> {
 

src/main/java/ch/njol/skript/expressions/ExprEgg.java

@@ -1,19 +1,17 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.entity.Egg;
 import org.bukkit.event.Event;
+import org.bukkit.event.player.PlayerEggThrowEvent;
 import org.jetbrains.annotations.Nullable;
 
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.EventValueExpression;
 
 @Name("The Egg")
 @Description("The egg thrown in a Player Egg Throw event.")
 @Examples("spawn an egg at the egg")
+@AvailableEvents(PlayerEggThrowEvent.class)
 @Events("Egg Throw")
 @Since("2.7")
 public class ExprEgg extends EventValueExpression<Egg> {

src/main/java/ch/njol/skript/expressions/ExprEnchantItem.java

@@ -1,5 +1,6 @@
 package ch.njol.skript.expressions;
 
+import ch.njol.skript.doc.*;
 import org.bukkit.event.Event;
 import org.bukkit.event.enchantment.EnchantItemEvent;
 import org.bukkit.event.enchantment.PrepareItemEnchantEvent;
@@ -8,11 +9,6 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.ItemType;
 import ch.njol.skript.classes.Changer.ChangeMode;
-import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Events;
-import ch.njol.skript.doc.Examples;
-import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -28,6 +24,7 @@
 			"\tset the enchanted item to a diamond chestplate",
 			"on enchant prepare:",
 			"\tset the enchant item to a wooden sword"})
+@AvailableEvents({EnchantItemEvent.class, PrepareItemEnchantEvent.class})
 @Events({"enchant prepare", "enchant"})
 @Since("2.5")
 public class ExprEnchantItem extends SimpleExpression<ItemType> {