Event-values in custom events now have changer support

Added api-version to plugin.yml
Added docs for `usable in` section in custom syntax

Author: TPGamesNL

docs/advanced/custom-syntax/conditions.md

@@ -6,6 +6,8 @@
 {% code-tabs-item title="Syntax" %}
 ```text
 [local] condition <pattern>:
+  usable in:
+    # events, optional
   parse:
     # code, optional
   check:
@@ -20,6 +22,8 @@
 {% code-tabs-item title="Syntax" %}
 ```text
 [local] condition:
+  usable in:
+    # events, optional
   patterns:
     # patterns, one per line
   parse:
@@ -36,6 +40,8 @@
 {% code-tabs-item title="Syntax" %}
 ```text
 [local] <skript type> property condition <pattern>:
+  usable in:
+    # events, optional
   parse:
     # code, optional
   check:
@@ -54,11 +60,17 @@ Specifying that a condition is `local` makes the condition only usable from with
 Local conditions are guaranteed to be parsed before other custom conditions, but not necessarily before conditions from other addons.
 {% endhint %}
 
+### Section `usable in`
+
+Each entry in this section should be either an imported class or a custom event \(syntax: `custom event %string%`\).
+
+This condition will error if it is used outside of all the given events.
+
 ### Section `parse`
 
 Code in this section is executed whenever the condition is parsed. This section may be used to emit errors if the condition is used in an improper context.
 
-If this section is included, you must also [`continue`](./#continue) if the effect was parsed successfully.
+If this section is included, you must also [`continue`](README.md#continue) if the effect was parsed successfully.
 
 {% hint style="info" %}
 Local variables created in this section are copied by-value to other sections.
@@ -82,5 +94,5 @@ condition example:
 
 ### Section `check`
 
-Code in this section is executed whenever the condition is checked. This section must [`continue`](./#continue) if the condition is met. The section may exit without continuing if the condition fails.
+Code in this section is executed whenever the condition is checked. This section must [`continue`](README.md#continue) if the condition is met. The section may exit without continuing if the condition fails.
 

docs/advanced/custom-syntax/effects.md

@@ -6,6 +6,8 @@
 {% code-tabs-item title="Syntax" %}
 ```text
 [local] effect <pattern>:
+  usable in:
+    # events, optional
   parse:
     # code, optional
   trigger:
@@ -20,6 +22,8 @@
 {% code-tabs-item title="Syntax" %}
 ```text
 [local] effect:
+  usable in:
+    # events, optional
   patterns:
     # patterns, one per line
   parse:
@@ -40,11 +44,17 @@ Specifying that an effect is `local` makes the effect only usable from within th
 Local effects are guaranteed to be parsed before other custom effects, but not necessarily before effects from other addons.
 {% endhint %}
 
+### Section `usable in`
+
+Each entry in this section should be either an imported class or a custom event \(syntax: `custom event %string%`\).
+
+This condition will error if it is used outside of all the given events.
+
 ### Section `parse`
 
 Code in this section is executed whenever the effect is parsed. This section may be used to emit errors if the effect is used in an improper context.
 
-If this section is included, you must also [`continue`](./#continue) if the effect was parsed successfully.
+If this section is included, you must also [`continue`](README.md#continue) if the effect was parsed successfully.
 
 {% hint style="info" %}
 Local variables created in this section are copied by-value to other sections.

docs/advanced/custom-syntax/events.md

@@ -121,5 +121,7 @@ In the event itself, you can get the extra data with the data expression:
 In the syntax above, `%strings%` is the index. This doesn't have to be plural, but can be.
 
 {% hint style="info" %}
-It may look fancier to create a custom expression instead of using extra data. To do so, you need to call `event.getData(%index%)` to get the data value.
+It may look fancier to create a custom expression instead of using extra data.
+To do so, you need to call `event.getData(%index%)` to get the data value.
+See the `usable in` sections in [effects](effects.md#section-usable-in), [conditions](conditions.md#section-usable-in) and [expressions](expressions.md#section-usable-in).
 {% endhint %}

docs/advanced/custom-syntax/expressions.md

@@ -8,6 +8,8 @@
 [local] [(plural|non(-|[ ])single))] expression <pattern>:
   return type: <skript type (cannot be a java type)> # optional
   loop of: <text> # optional
+  usable in:
+    # events, optional
   parse:
     # code, optional
   get:
@@ -37,6 +39,8 @@
   patterns:
     # patterns, one per line
   return type: <skript type (cannot be a java type)> # optional
+  usable in:
+    # events, optional
   parse:
     # code, optional
   get:
@@ -64,6 +68,8 @@
 ```text
 [local] <skript types> property <pattern>:
   return type: <skript type> # optional
+  usable in:
+    # events, optional
   parse:
     # code, optional
   get:
@@ -149,11 +155,17 @@ on script load:
 {% endcode-tabs-item %}
 {% endcode-tabs %}
 
+### Section `usable in`
+
+Each entry in this section should be either an imported class or a custom event \(syntax: `custom event %string%`\).
+
+This condition will error if it is used outside of all the given events.
+
 ### Section `parse`
 
 Code in this section is executed whenever the effect is parsed. This section may be used to emit errors if the effect is used in an improper context.
 
-If this section is included, you must also [`continue`](./#continue) if the effect was parsed successfully.
+If this section is included, you must also [`continue`](README.md#continue) if the effect was parsed successfully.
 
 {% hint style="info" %}
 Local variables created in this section are copied by-value to other sections.
@@ -177,7 +189,7 @@ expression example:
 
 ### Section `get`
 
-Code in this section is executed whenever the expression's value is read. This section must [return](expressions.md#return) a value and must not contain delays.
+Code in this section is executed whenever the expression's value is read. This section must [return](#return) a value and must not contain delays.
 
 #### Return
 

src/main/java/com/btk5h/skriptmirror/skript/custom/CustomSyntaxSection.java

@@ -246,7 +246,7 @@ protected boolean handleUsableSection(SectionNode sectionNode, Map<T, List<Suppl
       String usableKey = usableNode.getKey();
       assert usableKey != null;
 
-
+      Supplier<Boolean> supplier;
       if (usableKey.startsWith("custom event ")) {
         String customEventString = usableKey.substring("custom event ".length());
         VariableString variableString = VariableString.newInstance(
@@ -256,15 +256,12 @@ protected boolean handleUsableSection(SectionNode sectionNode, Map<T, List<Suppl
           return false;
         } else {
           String identifier = variableString.toString(null);
-          whichInfo.forEach(which ->
-            usableSuppliers.computeIfAbsent(which, (whichIndex) -> new ArrayList<>())
-              .add(() -> {
-                if (!ScriptLoader.isCurrentEvent(BukkitCustomEvent.class))
-                  return false;
-                EventSyntaxInfo eventWhich = CustomEvent.lastWhich;
-                return CustomEventUtils.getName(eventWhich).equalsIgnoreCase(identifier);
-              })
-          );
+          supplier = () -> {
+            if (!ScriptLoader.isCurrentEvent(BukkitCustomEvent.class))
+              return false;
+            EventSyntaxInfo eventWhich = CustomEvent.lastWhich;
+            return CustomEventUtils.getName(eventWhich).equalsIgnoreCase(identifier);
+          };
         }
       } else {
         JavaType javaType = CustomImport.lookup(currentScript, usableKey);
@@ -275,11 +272,12 @@ protected boolean handleUsableSection(SectionNode sectionNode, Map<T, List<Suppl
         }
         Class<? extends Event> eventClass = (Class<? extends Event>) javaClass;
 
-        whichInfo.forEach(which ->
-          usableSuppliers.computeIfAbsent(which, (whichIndex) -> new ArrayList<>())
-            .add(() -> ScriptLoader.isCurrentEvent(eventClass))
-        );
+        supplier = () -> ScriptLoader.isCurrentEvent(eventClass);
       }
+      whichInfo.forEach(which ->
+        usableSuppliers.computeIfAbsent(which, (whichIndex) -> new ArrayList<>())
+          .add(supplier)
+      );
     }
     return true;
   }

src/main/java/com/btk5h/skriptmirror/skript/custom/EffContinue.java

@@ -30,6 +30,7 @@ protected TriggerItem walk(Event e) {
         TriggerItem.walk(((EffectTriggerEvent) e).getNext(),
             ((EffectTriggerEvent) e).getDirectEvent());
       }
+      // TODO make ContinuableEvent interface / abstract class or sth alike
     } else if (e instanceof ConditionCheckEvent) {
       ((ConditionCheckEvent) e).markContinue();
     } else if (e instanceof SyntaxParseEvent) {

src/main/java/com/btk5h/skriptmirror/skript/custom/event/BukkitCustomEvent.java

@@ -16,6 +16,8 @@
  *
  * If extra data is needed, {@link #setData(String, Object)} and {@link #getData(String)} can be used.
  */
+// TODO generics for getters / setters
+// TODO do more checks for init return true vs SkriptUtil#canInitSafely
 public class BukkitCustomEvent extends Event implements Cancellable {
 
   private static final HandlerList HANDLERS = new HandlerList();

src/main/java/com/btk5h/skriptmirror/skript/custom/event/EffCallEvent.java

@@ -21,7 +21,7 @@ public class EffCallEvent extends Effect {
   @Override
   public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
     eventExpr = SkriptUtil.defendExpression(exprs[0]);
-    return true;
+    return SkriptUtil.canInitSafely(eventExpr);
   }
 
   @Override

src/main/java/com/btk5h/skriptmirror/skript/custom/event/ExprCustomEvent.java

@@ -50,13 +50,16 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
       }
     }
 
-    return true;
+    return SkriptUtil.canInitSafely(customEventName, eventValueVarList, dataVarList);
   }
 
   @Nullable
   @Override
   protected Event[] get(Event e) {
-    BukkitCustomEvent bukkitCustomEvent = new BukkitCustomEvent(this.customEventName.getSingle(e));
+    String name = this.customEventName.getSingle(e);
+    if (name == null)
+      return null;
+    BukkitCustomEvent bukkitCustomEvent = new BukkitCustomEvent(name);
 
     if (eventValueVarList != null)
       eventValueVarList.variablesIterator(e).forEachRemaining(pair -> {

src/main/java/com/btk5h/skriptmirror/skript/custom/event/ExprCustomEventValue.java

@@ -2,6 +2,7 @@
 
 import ch.njol.skript.ScriptLoader;
 import ch.njol.skript.Skript;
+import ch.njol.skript.classes.Changer;
 import ch.njol.skript.classes.ClassInfo;
 import ch.njol.skript.expressions.base.EventValueExpression;
 import ch.njol.skript.lang.Expression;
@@ -22,13 +23,15 @@ public class ExprCustomEventValue<T> extends EventValueExpression<T> {
     Skript.registerExpression(ExprCustomEventValue.class, Object.class, ExpressionType.PATTERN_MATCHES_EVERYTHING, "[the] [event-]<.+>");
   }
 
-  private ClassInfo<?> classInfo;
+  private ClassInfo<? super T> classInfo;
+  private Changer<? super T> changer;
 
   @SuppressWarnings("unchecked")
   public ExprCustomEventValue() {
     super((Class<? extends T>) Object.class);
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public boolean init(final Expression<?>[] exprs, final int matchedPattern, final Kleenean isDelayed, final SkriptParser.ParseResult parseResult) {
     if (!ScriptLoader.isCurrentEvent(BukkitCustomEvent.class, EventTriggerEvent.class))
@@ -38,7 +41,7 @@ public boolean init(final Expression<?>[] exprs, final int matchedPattern, final
       return false;
 
     String stringClass = parseResult.regexes.get(0).group();
-    classInfo = Classes.getClassInfoFromUserInput(stringClass);
+    classInfo = (ClassInfo<? super T>) Classes.getClassInfoFromUserInput(stringClass);
     if (classInfo == null) {
       return false;
     }
@@ -69,9 +72,22 @@ public T[] get(Event event) {
     return tArray;
   }
 
+  @Override
+  public Class<?>[] acceptChange(Changer.ChangeMode mode) {
+    changer = classInfo.getChanger();
+    return changer == null ? null : changer.acceptChange(mode);
+  }
+
+  @Override
+  public void change(Event e, Object[] delta, Changer.ChangeMode mode) {
+    if (changer == null)
+      throw new UnsupportedOperationException();
+    Changer.ChangerUtils.change(changer, getArray(e), delta, mode);
+  }
+
   @Override
   public String toString(final @Nullable Event e, final boolean debug) {
-    return "event-" + this.getReturnType();
+    return "event-" + classInfo.getCodeName();
   }
 
   @SuppressWarnings("unchecked")