🚀 Add loop-counter & Improve loops

src/main/java/ch/njol/skript/effects/EffContinue.java

@@ -25,25 +25,33 @@
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
 import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.LoopSection;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.lang.TriggerItem;
-import ch.njol.skript.lang.TriggerSection;
-import ch.njol.skript.lang.parser.ParserInstance;
-import ch.njol.skript.sections.SecLoop;
-import ch.njol.skript.sections.SecWhile;
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
 import org.eclipse.jdt.annotation.Nullable;
 
 import java.util.List;
-import java.util.stream.Collectors;
 
 @Name("Continue")
-@Description("Skips the value currently being looped, moving on to the next value if it exists.")
-@Examples({"loop all players:",
-		"\tif loop-value does not have permission \"moderator\":",
-		"\t\tcontinue # filter out non moderators",
-		"\tbroadcast \"%loop-player% is a moderator!\" # Only moderators get broadcast"})
+@Description("Immediately moves the (while) loop on to the next iteration.")
+@Examples({
+	"# Broadcast online moderators",
+	"loop all players:",
+	"\tif loop-value does not have permission \"moderator\":",
+	"\t\tcontinue # filter out non moderators",
+	"\tbroadcast \"%loop-player% is a moderator!\" # Only moderators get broadcast",
+	" ",
+	"# Game starting counter",
+	"set {_counter} to 11",
+	"while {_counter} > 0:",
+	"\tremove 1 from {_counter}",
+	"\twait a second",
+	"\tif {_counter} != 1, 2, 3, 5 or 10:",
+	"\t\tcontinue # only print when counter is 1, 2, 3, 5 or 10",
+	"\tbroadcast \"Game starting in %{_counter}% second(s)\"",
+})
 @Since("2.2-dev37, INSERT VERSION (while loops)")
 public class EffContinue extends Effect {
 
@@ -52,20 +60,18 @@ public class EffContinue extends Effect {
 	}
 
 	@SuppressWarnings("NotNullFieldNotInitialized")
-	private TriggerSection section;
+	private LoopSection loop;
 
 	@Override
 	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
-		List<TriggerSection> currentSections = ParserInstance.get().getCurrentSections().stream()
-			.filter(s -> s instanceof SecLoop || s instanceof SecWhile)
-			.collect(Collectors.toList());
+		List<LoopSection> currentLoops = getParser().getCurrentSections(LoopSection.class);
 
-		if (currentSections.isEmpty()) {
-			Skript.error("Continue may only be used in while or loops");
+		if (currentLoops.isEmpty()) {
+			Skript.error("The 'continue' effect may only be used in while and regular loops");
 			return false;
 		}
 
-		section = currentSections.get(currentSections.size() - 1);
+		loop = currentLoops.get(currentLoops.size() - 1);
 		return true;
 	}
 
@@ -77,7 +83,7 @@ protected void execute(Event e) {
 	@Nullable
 	@Override
 	protected TriggerItem walk(Event e) {
-		return section;
+		return loop;
 	}
 
 	@Override

src/main/java/ch/njol/skript/effects/EffExit.java

@@ -25,14 +25,13 @@
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
 import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.LoopSection;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.lang.TriggerItem;
 import ch.njol.skript.lang.TriggerSection;
 import ch.njol.skript.lang.parser.ParserInstance;
 import ch.njol.skript.log.ErrorQuality;
 import ch.njol.skript.sections.SecConditional;
-import ch.njol.skript.sections.SecLoop;
-import ch.njol.skript.sections.SecWhile;
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
 import org.eclipse.jdt.annotation.Nullable;
@@ -104,7 +103,7 @@ private static int numLevels(int type) {
 			return currentSections.size();
 		int r = 0;
 		for (TriggerSection s : currentSections) {
-			if (type == CONDITIONALS ? s instanceof SecConditional : s instanceof SecLoop || s instanceof SecWhile)
+			if (type == CONDITIONALS ? s instanceof SecConditional : s instanceof LoopSection)
 				r++;
 		}
 		return r;
@@ -121,16 +120,13 @@ protected TriggerItem walk(final Event e) {
 				assert false : this;
 				return null;
 			}
-			if (n instanceof SecLoop) {
-				((SecLoop) n).exit(e);
-			} else if (n instanceof SecWhile) {
-				((SecWhile) n).reset();
-			}
+			if (n instanceof LoopSection)
+				((LoopSection) n).exit(e);
 
-			if (type == EVERYTHING || type == CONDITIONALS && n instanceof SecConditional || type == LOOPS && (n instanceof SecLoop || n instanceof SecWhile))
+			if (type == EVERYTHING || type == CONDITIONALS && n instanceof SecConditional || type == LOOPS && (n instanceof LoopSection))
 				i--;
 		}
-		return n instanceof SecLoop ? ((SecLoop) n).getActualNext() : n instanceof SecWhile ? ((SecWhile) n).getActualNext() : n.getNext();
+		return n instanceof LoopSection ? ((LoopSection) n).getActualNext() : n.getNext();
 	}
 
 	@Override

src/main/java/ch/njol/skript/effects/EffReturn.java

@@ -26,6 +26,7 @@
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
 import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.LoopSection;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.lang.TriggerItem;
 import ch.njol.skript.lang.TriggerSection;
@@ -34,8 +35,6 @@
 import ch.njol.skript.lang.function.ScriptFunction;
 import ch.njol.skript.log.RetainingLogHandler;
 import ch.njol.skript.log.SkriptLogger;
-import ch.njol.skript.sections.SecLoop;
-import ch.njol.skript.sections.SecWhile;
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
 import org.eclipse.jdt.annotation.Nullable;
@@ -116,11 +115,9 @@ protected TriggerItem walk(final Event e) {
 
 		TriggerSection parent = getParent();
 		while (parent != null) {
-			if (parent instanceof SecLoop) {
-				((SecLoop) parent).exit(e);
-			} else if (parent instanceof SecWhile) {
-				((SecWhile) parent).reset();
-			}
+			if (parent instanceof LoopSection)
+				((LoopSection) parent).exit(e);
+
 			parent = parent.getParent();
 		}
 

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

@@ -0,0 +1,119 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.doc.Description;
+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.Literal;
+import ch.njol.skript.lang.LoopSection;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.TriggerSection;
+import ch.njol.skript.lang.util.SimpleExpression;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.eclipse.jdt.annotation.Nullable;
+
+@Name("Loop Iteration")
+@Description("Returns the loop's current iteration count (for both normal and while loops).")
+@Examples({
+	"while player is online:",
+	"\tgive player 1 stone",
+	"\twait 5 ticks",
+	"\tif loop-counter > 30:",
+	"\t\tstop loop",
+	"",
+	"loop {top-balances::*}:",
+	"\tif loop-iteration <= 10:",
+	"\t\tbroadcast \"##%loop-iteration% %loop-index% has $%loop-value%\"",
+})
+@Since("INSERT VERSION")
+public class ExprLoopIteration extends SimpleExpression<Long> {
+
+	static {
+		Skript.registerExpression(ExprLoopIteration.class, Long.class, ExpressionType.SIMPLE, "[the] loop(-| )(counter|iteration)[-%-*number%]");
+	}
+
+	@SuppressWarnings("NotNullFieldNotInitialized")
+	private LoopSection loop;
+
+	private int loopNumber;
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		loopNumber = -1;
+		if (exprs[0] != null) {
+			loopNumber = ((Literal<Number>) exprs[0]).getSingle().intValue();
+		}
+
+		int i = 1;
+		LoopSection loop = null;
+
+		for (LoopSection l : getParser().getCurrentSections(LoopSection.class)) {
+
+			if (i < loopNumber) {
+				i++;
+				continue;
+			}
+
+			if (loop != null) {
+				Skript.error("There are multiple loops. Use loop-iteration-1/2/3/etc. to specify which loop-iteration you want.");
+				return false;
+			}
+			loop = l;
+
+			if (i == loopNumber)
+				break;
+		}
+
+		if (loop == null) {
+			Skript.error("The loop iteration expression must be used in a loop");
+			return false;
+		}
+
+		this.loop = loop;
+		return true;
+	}
+
+	@Override
+	protected Long[] get(Event e) {
+		return new Long[]{loop.getLoopCounter(e)};
+	}
+
+	@Override
+	public Class<? extends Long> getReturnType() {
+		return Long.class;
+	}
+
+	@Override
+	public boolean isSingle() {
+		return true;
+	}
+
+	@Override
+	public String toString(@Nullable Event e, boolean debug) {
+		return "loop-iteration" + (loopNumber != -1 ? ("-" + loopNumber) : "");
+	}
+
+}