Active Item API

src/main/java/ch/njol/skript/conditions/CondIsHandRaised.java

@@ -0,0 +1,102 @@
+/**
+ *   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.conditions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.conditions.base.PropertyCondition;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.event.Event;
+import org.bukkit.inventory.EquipmentSlot;
+import org.eclipse.jdt.annotation.Nullable;
+
+@Name("Is Hand Raised")
+@Description({
+	"Checks whether an entity has one or both of their hands raised. ",
+	"Hands are raised when an entity is using an item (eg: blocking, drawing a bow, eating)."
+})
+@Examples({
+	"on damage of player:",
+	"\tif victim's main hand is raised:",
+	"\t\tdrop player's tool at player",
+	"\t\tset player's tool to air"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Paper")
+public class CondIsHandRaised extends PropertyCondition<LivingEntity> {
+
+	static {
+		Skript.registerCondition(CondIsHandRaised.class,
+			"%livingentities%'[s] [:main] hand[s] (is|are) raised",
+			"%livingentities%'[s] [:main] hand[s] (isn't|is not|aren't|are not) raised",
+			"%livingentities%'[s] off[( |-)]hand[s] (is|are) raised",
+			"%livingentities%'[s] off[( |-)]hand[s] (isn't|is not|aren't|are not) raised");
+	}
+
+	private Expression<LivingEntity> entities;
+
+	// 0 for either hand, 1 for main hand, 2 for off-hand.
+	private static final int EITHER_HAND = 0, MAIN_HAND = 1, OFF_HAND = 2;
+	private int hand;
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		setExpr((Expression<LivingEntity>) exprs[0]);
+		setNegated(matchedPattern == 1 || matchedPattern == 3);
+		if (matchedPattern >= 2) {
+			hand = OFF_HAND;
+		} else if (parseResult.hasTag("main")) {
+			hand = MAIN_HAND;
+		} else {
+			hand = EITHER_HAND;
+		}
+		return true;
+	}
+
+	@Override
+	public boolean check(LivingEntity livingEntity) {
+		if (hand == EITHER_HAND) {
+			return livingEntity.isHandRaised();
+		} else if (hand == MAIN_HAND) {
+			return livingEntity.isHandRaised() && livingEntity.getHandRaised().equals(EquipmentSlot.HAND);
+		} else if (hand == OFF_HAND) {
+			return livingEntity.isHandRaised() && livingEntity.getHandRaised().equals(EquipmentSlot.OFF_HAND);
+		}
+		return false;
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return "hand raised";
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return entities.toString(event, debug) + "'s  " + (hand == 0 ? "" : (hand == 1 ? "main " : "off ")) + "hand " +
+			(entities.isSingle() ? "is" : "s are") + " raised ";
+	}
+
+}

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

@@ -0,0 +1,77 @@
+/**
+ *   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.effects;
+
+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.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Effect;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.event.Event;
+import org.eclipse.jdt.annotation.Nullable;
+
+@Name("Cancel Active Item Use")
+@Description({
+	"Interrupts the action an entity is trying to complete. ",
+	"For example, interrupting eating, or drawing back a bow."
+})
+@Examples({
+	"on damage of player:",
+	"\tif victim's active tool is a bow:",
+	"\t\tinterrupt player's active item use"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Paper 1.16.1+")
+public class EffCancelItemUse extends Effect {
+
+	static {
+		if (Skript.methodExists(LivingEntity.class, "clearActiveItem")) {
+			Skript.registerEffect(EffCancelItemUse.class,
+				"(cancel|interrupt) %livingentities%'[s] [active|current] item us(e|age)",
+				"(cancel|interrupt) [active|current] item us(e|age) [of %livingentities%]");
+		}
+	}
+
+	private Expression<LivingEntity> entityExpression;
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		entityExpression = (Expression<LivingEntity>) exprs[0];
+		return true;
+	}
+
+	@Override
+	protected void execute(Event event) {
+		for (LivingEntity entity : entityExpression.getArray(event)) {
+			entity.clearActiveItem();
+		}
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return "cancel item usage of " + entityExpression.toString(event, debug);
+	}
+
+}

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

@@ -0,0 +1,79 @@
+/**
+ *   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.aliases.ItemType;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.expressions.base.PropertyExpression;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.event.Event;
+import org.eclipse.jdt.annotation.Nullable;
+
+@Name("Active Item")
+@Description(
+		"Returns the item the entity is currently using (ie: the food they're eating, " +
+		"the bow they're drawing back, etc.). This cannot be changed. " +
+		"If an entity is not using any item, this will return 0 air."
+)
+@Examples({
+		"on damage of player:",
+		"\tif victim's active tool is a bow:",
+		"\t\tinterrupt player's active item use"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Paper")
+public class ExprActiveItem extends PropertyExpression<LivingEntity, ItemType> {
+
+	static {
+		if (Skript.methodExists(LivingEntity.class, "getActiveItem"))
+			register(ExprActiveItem.class, ItemType.class, "(raised|active) (tool|item|weapon)", "livingentities");
+	}
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		setExpr((Expression<LivingEntity>) exprs[0]);
+		return true;
+	}
+
+	@Override
+	protected ItemType[] get(Event event, LivingEntity[] source) {
+		return get(source, (livingEntity -> {
+			return new ItemType(livingEntity.getActiveItem());
+		}));
+	}
+
+	@Override
+	public Class<? extends ItemType> getReturnType() {
+		return ItemType.class;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return "active item of " + getExpr().toString(event, debug);
+	}
+
+}

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

@@ -0,0 +1,82 @@
+/**
+ *   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.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.expressions.base.SimplePropertyExpression;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.util.Timespan;
+import ch.njol.util.Kleenean;
+import org.bukkit.entity.LivingEntity;
+import org.eclipse.jdt.annotation.Nullable;
+
+@Name("Active Item Use Time")
+@Description(
+	"Returns the time that an the entity either has spent using an item, " +
+	"or the time left for them to finish using an item. " +
+	"If an entity is not using any item, this will return 0 seconds."
+)
+@Examples({
+	"on right click:",
+	"\tbroadcast player's remaining item use time",
+	"\twait 1 second",
+	"\tbroadcast player's item use time"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Paper")
+public class ExprEntityItemUseTime extends SimplePropertyExpression<LivingEntity, Timespan> {
+
+	static {
+		if (Skript.methodExists(LivingEntity.class, "getItemUseRemainingTime"))
+			register(ExprEntityItemUseTime.class, Timespan.class, "[elapsed|:remaining] (item|tool) use time", "livingentities");
+	}
+
+	private boolean remaining;
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		setExpr((Expression<LivingEntity>) exprs[0]);
+		remaining = parseResult.hasTag("remaining");
+		return true;
+	}
+
+	@Override
+	public Timespan convert(LivingEntity livingEntity) {
+		if (remaining)
+			return Timespan.fromTicks(livingEntity.getItemUseRemainingTime());
+		return Timespan.fromTicks(livingEntity.getHandRaisedTime());
+	}
+
+	@Override
+	public Class<? extends Timespan> getReturnType() {
+		return Timespan.class;
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return (remaining ? "remaining" : "elapsed") + " item use time";
+	}
+
+}