diff --git a/.github/workflows/checkstyle.yml b/.github/workflows/checkstyle.yml new file mode 100644 index 00000000000..409ca6b4fd7 --- /dev/null +++ b/.github/workflows/checkstyle.yml @@ -0,0 +1,37 @@ +name: checkstyle + +on: + push: + branches: + - master + - 'dev/**' + pull_request: + +jobs: + build: + if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: validate gradle wrapper + uses: gradle/wrapper-validation-action@v2 + - name: Set up JDK 21 + uses: actions/setup-java@v4 + with: + java-version: '21' + distribution: 'adopt' + cache: gradle + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Run checkstyle + run: ./gradlew clean checkstyleMain + - name: Upload checkstyle report + uses: actions/upload-artifact@v4 + if: success() + with: + name: checkstyle-report + path: | + build/reports/checkstyle/*.xml + build/reports/checkstyle/*.html diff --git a/build.gradle b/build.gradle index 3f9e05b5d68..2b24d2f48b8 100644 --- a/build.gradle +++ b/build.gradle @@ -7,6 +7,7 @@ plugins { id 'com.github.johnrengelman.shadow' version '8.1.1' id 'maven-publish' id 'java' + id 'checkstyle' } configurations { @@ -50,6 +51,11 @@ dependencies { testShadow group: 'org.easymock', name: 'easymock', version: '5.4.0' } +checkstyle { + configFile = new File("checkstyle.xml") + sourceSets = [] // disables checkstyle after build task +} + task checkAliases { description 'Checks for the existence of the aliases.' doLast { diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100644 index 00000000000..42794bbeccb --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/code-conventions.md b/code-conventions.md index c9b70f8d5a4..f47329495a0 100644 --- a/code-conventions.md +++ b/code-conventions.md @@ -97,6 +97,7 @@ If we need to remove or alter contributed code due to a licensing issue we will - The exception to this is breaking up conditional statements (e.g. `if (x || y)`) where the condition starts may be aligned * Each class begins with an empty line +* Each Java file ends with an empty line * No squeezing of multiple lines of code on a single line * Separate method declarations with empty lines - Empty line after last method in a class is *not* required diff --git a/gradle.properties b/gradle.properties index a620b360bd5..8fa041e0878 100644 --- a/gradle.properties +++ b/gradle.properties @@ -5,7 +5,7 @@ org.gradle.parallel=true groupid=ch.njol name=skript -version=2.9.2 +version=2.9.3 jarName=Skript.jar testEnv=java21/paper-1.21.0 testEnvJavaVersion=21 diff --git a/src/main/java/ch/njol/skript/SkriptCommand.java b/src/main/java/ch/njol/skript/SkriptCommand.java index e850820aaca..9dc50018dd5 100644 --- a/src/main/java/ch/njol/skript/SkriptCommand.java +++ b/src/main/java/ch/njol/skript/SkriptCommand.java @@ -215,7 +215,11 @@ public boolean onCommand(CommandSender sender, Command command, String label, St if (scriptInfo.files == 0) { info(sender, "reload.empty folder", fileName); } else { - reloaded(sender, logHandler, timingLogHandler, "x scripts in folder", fileName, scriptInfo.files); + if (logHandler.numErrors() == 0) { + reloaded(sender, logHandler, timingLogHandler, "x scripts in folder success", fileName, scriptInfo.files); + } else { + reloaded(sender, logHandler, timingLogHandler, "x scripts in folder error", fileName, scriptInfo.files); + } } }); } diff --git a/src/main/java/ch/njol/skript/aliases/Aliases.java b/src/main/java/ch/njol/skript/aliases/Aliases.java index 19daed69359..3e67971698a 100644 --- a/src/main/java/ch/njol/skript/aliases/Aliases.java +++ b/src/main/java/ch/njol/skript/aliases/Aliases.java @@ -395,17 +395,17 @@ public static void load() { } /** - * Temporarily create an alias for a material which may not have an alias yet. + * Temporarily create an alias for materials which do not have aliases yet. */ private static void loadMissingAliases() { if (!Skript.methodExists(Material.class, "getKey")) return; for (Material material : Material.values()) { - if (!provider.hasAliasForMaterial(material)) { + if (!material.isLegacy() && !provider.hasAliasForMaterial(material)) { NamespacedKey key = material.getKey(); String name = key.getKey().replace("_", " "); parser.loadAlias(name + "¦s", key.toString()); - Skript.debug(ChatColor.YELLOW + "Creating temporary alias for: " + key.toString()); + Skript.debug(ChatColor.YELLOW + "Creating temporary alias for: " + key); } } } diff --git a/src/main/java/ch/njol/skript/aliases/ItemType.java b/src/main/java/ch/njol/skript/aliases/ItemType.java index cab9aede67e..c7c18fb42ff 100644 --- a/src/main/java/ch/njol/skript/aliases/ItemType.java +++ b/src/main/java/ch/njol/skript/aliases/ItemType.java @@ -1,21 +1,3 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.aliases; import ch.njol.skript.aliases.ItemData.OldItemData; @@ -41,6 +23,7 @@ import org.bukkit.Material; import org.bukkit.OfflinePlayer; import org.bukkit.Tag; +import org.bukkit.Bukkit; import org.bukkit.block.Block; import org.bukkit.block.BlockState; import org.bukkit.block.Skull; @@ -391,22 +374,35 @@ public boolean hasType() { */ public boolean setBlock(Block block, boolean applyPhysics) { for (int i = random.nextInt(types.size()); i < types.size(); i++) { - ItemData d = types.get(i); - Material blockType = ItemUtils.asBlock(d.type); + ItemData data = types.get(i); + Material blockType = ItemUtils.asBlock(data.type); + if (blockType == null) // Ignore items which cannot be placed continue; - if (BlockUtils.set(block, blockType, d.getBlockValues(), applyPhysics)) { - ItemMeta itemMeta = getItemMeta(); - if (itemMeta instanceof SkullMeta) { - OfflinePlayer offlinePlayer = ((SkullMeta) itemMeta).getOwningPlayer(); - if (offlinePlayer == null) - continue; - Skull skull = (Skull) block.getState(); + + if (!BlockUtils.set(block, blockType, data.getBlockValues(), applyPhysics)) + continue; + + ItemMeta itemMeta = getItemMeta(); + + if (itemMeta instanceof SkullMeta) { + OfflinePlayer offlinePlayer = ((SkullMeta) itemMeta).getOwningPlayer(); + if (offlinePlayer == null) + continue; + Skull skull = (Skull) block.getState(); + if (offlinePlayer.getName() != null) { skull.setOwningPlayer(offlinePlayer); - skull.update(false, applyPhysics); + } else if (ItemUtils.CAN_CREATE_PLAYER_PROFILE) { + //noinspection deprecation + skull.setOwnerProfile(Bukkit.createPlayerProfile(offlinePlayer.getUniqueId(), "")); + } else { + //noinspection deprecation + skull.setOwner(""); } - return true; + skull.update(false, applyPhysics); } + + return true; } return false; } diff --git a/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java b/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java index 5a2912039fb..f47a3f5d8d7 100644 --- a/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java +++ b/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java @@ -70,11 +70,7 @@ public class BukkitUnsafe { @Nullable public static Material getMaterialFromMinecraftId(String id) { - // On 1.13, Vanilla and Spigot names are same - if (id.length() > 9) - return Material.matchMaterial(id.substring(10)); // Strip 'minecraft:' out - else // Malformed material name - return null; + return Material.matchMaterial(id); } public static void modifyItemStack(ItemStack stack, String arguments) { diff --git a/src/main/java/ch/njol/skript/bukkitutil/ItemUtils.java b/src/main/java/ch/njol/skript/bukkitutil/ItemUtils.java index ced9f5a8367..a74a604664d 100644 --- a/src/main/java/ch/njol/skript/bukkitutil/ItemUtils.java +++ b/src/main/java/ch/njol/skript/bukkitutil/ItemUtils.java @@ -21,7 +21,9 @@ import ch.njol.skript.Skript; import ch.njol.skript.aliases.ItemType; import ch.njol.skript.util.slot.Slot; +import org.bukkit.Bukkit; import org.bukkit.Material; +import org.bukkit.OfflinePlayer; import org.bukkit.Tag; import org.bukkit.TreeType; import org.bukkit.block.Block; @@ -32,9 +34,11 @@ import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.meta.Damageable; import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.inventory.meta.SkullMeta; import org.jetbrains.annotations.Nullable; import java.util.HashMap; +import java.util.UUID; /** * Miscellaneous static utility methods related to items. @@ -44,6 +48,7 @@ public class ItemUtils { public static final boolean HAS_MAX_DAMAGE = Skript.methodExists(Damageable.class, "getMaxDamage"); // Introduced in Paper 1.21 public static final boolean HAS_RESET = Skript.methodExists(Damageable.class, "resetDamage"); + public static final boolean CAN_CREATE_PLAYER_PROFILE = Skript.methodExists(Bukkit.class, "createPlayerProfile", UUID.class, String.class); /** * Gets damage/durability of an item, or 0 if it does not have damage. @@ -148,6 +153,30 @@ public static void setDamage(ItemType itemType, int damage) { } } + /** + * Sets the owner of a player head. + * @param skull player head item to modify + * @param player owner of the head + */ + public static void setHeadOwner(ItemType skull, OfflinePlayer player) { + ItemMeta meta = skull.getItemMeta(); + if (!(meta instanceof SkullMeta)) + return; + + SkullMeta skullMeta = (SkullMeta) meta; + + if (player.getName() != null) { + skullMeta.setOwningPlayer(player); + } else if (CAN_CREATE_PLAYER_PROFILE) { + //noinspection deprecation + skullMeta.setOwnerProfile(Bukkit.createPlayerProfile(player.getUniqueId(), "")); + } else { + skullMeta.setOwningPlayer(null); + } + + skull.setItemMeta(skullMeta); + } + /** * Gets a block material corresponding to given item material, which might * be the given material. If no block material is found, null is returned. diff --git a/src/main/java/ch/njol/skript/classes/data/BukkitClasses.java b/src/main/java/ch/njol/skript/classes/data/BukkitClasses.java index 9ad42420c93..c0271da3ae7 100644 --- a/src/main/java/ch/njol/skript/classes/data/BukkitClasses.java +++ b/src/main/java/ch/njol/skript/classes/data/BukkitClasses.java @@ -75,6 +75,7 @@ import org.bukkit.entity.Projectile; import org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason; import org.bukkit.event.entity.EntityDamageEvent.DamageCause; +import org.bukkit.event.entity.EntityPotionEffectEvent; import org.bukkit.event.entity.EntityRegainHealthEvent.RegainReason; import org.bukkit.event.entity.EntityTransformEvent.TransformReason; import org.bukkit.event.inventory.ClickType; @@ -1522,7 +1523,12 @@ public String toVariableNameString(EnchantmentOffer eo) { .name("Transform Reason") .description("Represents a transform reason of an entity transform event.") .since("2.8.0")); - + + Classes.registerClass(new EnumClassInfo<>(EntityPotionEffectEvent.Cause.class, "entitypotioncause", "entity potion causes") + .user("(entity )?potion ?effect ?cause") + .name("Entity Potion Cause") + .description("Represents the cause of the action of a potion effect on an entity, e.g. arrow, command") + .since("INSERT VERSION")); } } diff --git a/src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java b/src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java index 82fca450068..c53810d5d69 100644 --- a/src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java +++ b/src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java @@ -109,6 +109,7 @@ import org.bukkit.event.entity.EntityTeleportEvent; import org.bukkit.event.entity.EntityTransformEvent; import org.bukkit.event.entity.EntityTransformEvent.TransformReason; +import org.bukkit.event.entity.EntityPotionEffectEvent; import org.bukkit.event.entity.FireworkExplodeEvent; import org.bukkit.event.entity.HorseJumpEvent; import org.bukkit.event.entity.ItemDespawnEvent; @@ -178,6 +179,7 @@ import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.PlayerInventory; import org.bukkit.inventory.Recipe; +import org.bukkit.potion.PotionEffect; import org.bukkit.potion.PotionData; import org.bukkit.potion.PotionEffectType; import org.bukkit.potion.PotionType; @@ -548,6 +550,33 @@ public DamageCause get(final EntityDeathEvent e) { return ldc == null ? null : ldc.getCause(); } }, 0); + + // Entity Potion Effect + EventValues.registerEventValue(EntityPotionEffectEvent.class, PotionEffect.class, new Getter() { + @Override + public PotionEffect get(EntityPotionEffectEvent event) { + return event.getOldEffect(); + } + }, EventValues.TIME_PAST); + EventValues.registerEventValue(EntityPotionEffectEvent.class, PotionEffect.class, new Getter() { + @Override + public PotionEffect get(EntityPotionEffectEvent event) { + return event.getNewEffect(); + } + }, EventValues.TIME_NOW); + EventValues.registerEventValue(EntityPotionEffectEvent.class, PotionEffectType.class, new Getter() { + @Override + public PotionEffectType get(EntityPotionEffectEvent event) { + return event.getModifiedType(); + } + }, EventValues.TIME_NOW); + EventValues.registerEventValue(EntityPotionEffectEvent.class, EntityPotionEffectEvent.Cause.class, new Getter() { + @Override + public EntityPotionEffectEvent.Cause get(EntityPotionEffectEvent event) { + return event.getCause(); + } + }, EventValues.TIME_NOW); + // ProjectileHitEvent // ProjectileHitEvent#getHitBlock was added in 1.11 if (Skript.methodExists(ProjectileHitEvent.class, "getHitBlock")) diff --git a/src/main/java/ch/njol/skript/classes/data/DefaultOperations.java b/src/main/java/ch/njol/skript/classes/data/DefaultOperations.java index 860c7ee1030..1588d31ece8 100644 --- a/src/main/java/ch/njol/skript/classes/data/DefaultOperations.java +++ b/src/main/java/ch/njol/skript/classes/data/DefaultOperations.java @@ -47,11 +47,7 @@ public class DefaultOperations { return left.doubleValue() * right.doubleValue(); }); Arithmetics.registerOperation(Operator.DIVISION, Number.class, (left, right) -> left.doubleValue() / right.doubleValue()); - Arithmetics.registerOperation(Operator.EXPONENTIATION, Number.class, (left, right) -> { - if (Utils.isInteger(left, right) && right.longValue() >= 0) - return (long) Math.pow(left.longValue(), right.longValue()); - return Math.pow(left.doubleValue(), right.doubleValue()); - }); + Arithmetics.registerOperation(Operator.EXPONENTIATION, Number.class, (left, right) -> Math.pow(left.doubleValue(), right.doubleValue())); Arithmetics.registerDifference(Number.class, (left, right) -> { if (Utils.isInteger(left, right)) return Math.abs(left.longValue() - right.longValue()); diff --git a/src/main/java/ch/njol/skript/conditions/CondIsWithin.java b/src/main/java/ch/njol/skript/conditions/CondIsWithin.java index e6b88ed710a..7ec25401ae8 100644 --- a/src/main/java/ch/njol/skript/conditions/CondIsWithin.java +++ b/src/main/java/ch/njol/skript/conditions/CondIsWithin.java @@ -103,7 +103,7 @@ public boolean check(Event event) { Location one = loc1.getSingle(event); Location two = loc2.getSingle(event); if (one == null || two == null || one.getWorld() != two.getWorld()) - return false; + return isNegated(); AABB box = new AABB(one, two); return locsToCheck.check(event, box::contains, isNegated()); } @@ -111,7 +111,7 @@ public boolean check(Event event) { // else, within an entity/block/chunk/world Object area = this.area.getSingle(event); if (area == null) - return false; + return isNegated(); // Entities if (area instanceof Entity) { diff --git a/src/main/java/ch/njol/skript/effects/EffCancelEvent.java b/src/main/java/ch/njol/skript/effects/EffCancelEvent.java index 317cdd3a9ee..3343f032cdf 100644 --- a/src/main/java/ch/njol/skript/effects/EffCancelEvent.java +++ b/src/main/java/ch/njol/skript/effects/EffCancelEvent.java @@ -1,34 +1,5 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.effects; -import org.bukkit.entity.Player; -import org.bukkit.event.Cancellable; -import org.bukkit.event.Event; -import org.bukkit.event.Event.Result; -import org.bukkit.event.block.BlockCanBuildEvent; -import org.bukkit.event.inventory.InventoryInteractEvent; -import org.bukkit.event.player.PlayerDropItemEvent; -import org.bukkit.event.player.PlayerInteractEvent; -import org.bukkit.event.player.PlayerLoginEvent; -import org.jetbrains.annotations.Nullable; - import ch.njol.skript.Skript; import ch.njol.skript.bukkitutil.PlayerUtils; import ch.njol.skript.doc.Description; @@ -42,39 +13,58 @@ import ch.njol.skript.log.ErrorQuality; import ch.njol.skript.util.Utils; import ch.njol.util.Kleenean; +import org.bukkit.entity.Player; +import org.bukkit.event.Cancellable; +import org.bukkit.event.Event; +import org.bukkit.event.block.BlockCanBuildEvent; +import org.bukkit.event.entity.EntityToggleSwimEvent; +import org.bukkit.event.inventory.InventoryInteractEvent; +import org.bukkit.event.player.PlayerDropItemEvent; +import org.bukkit.event.player.PlayerInteractEvent; +import org.bukkit.event.player.PlayerLoginEvent; +import org.jetbrains.annotations.Nullable; -/** - * @author Peter Güttinger - */ @Name("Cancel Event") @Description("Cancels the event (e.g. prevent blocks from being placed, or damage being taken).") -@Examples({"on damage:", - " victim is a player", - " victim has the permission \"skript.god\"", - " cancel the event"}) +@Examples({ + "on damage:", + "\tvictim is a player", + "\tvictim has the permission \"skript.god\"", + "\tcancel the event" +}) @Since("1.0") public class EffCancelEvent extends Effect { + static { Skript.registerEffect(EffCancelEvent.class, "cancel [the] event", "uncancel [the] event"); } private boolean cancel; - - @SuppressWarnings("null") + @Override - public boolean init(final Expression[] vars, final int matchedPattern, final Kleenean isDelayed, final ParseResult parser) { + public boolean init(Expression[] expressions, int matchedPattern, + Kleenean isDelayed, ParseResult parseResult) { if (isDelayed == Kleenean.TRUE) { - Skript.error("Can't cancel an event anymore after it has already passed", ErrorQuality.SEMANTIC_ERROR); + Skript.error("An event cannot be cancelled after it has already passed", ErrorQuality.SEMANTIC_ERROR); return false; } + cancel = matchedPattern == 0; - final Class[] es = getParser().getCurrentEvents(); - if (es == null) + Class[] currentEvents = getParser().getCurrentEvents(); + + if (currentEvents == null) + return false; + + if (cancel && getParser().isCurrentEvent(EntityToggleSwimEvent.class)) { + Skript.error("Cancelling a toggle swim event has no effect"); return false; - for (final Class e : es) { - if (Cancellable.class.isAssignableFrom(e) || BlockCanBuildEvent.class.isAssignableFrom(e)) + } + + for (Class event : currentEvents) { + if (Cancellable.class.isAssignableFrom(event) || BlockCanBuildEvent.class.isAssignableFrom(event)) return true; // TODO warning if some event(s) cannot be cancelled even though some can (needs a way to be suppressed) } + if (getParser().isCurrentEvent(PlayerLoginEvent.class)) Skript.error("A connect event cannot be cancelled, but the player may be kicked ('kick player by reason of \"...\"')", ErrorQuality.SEMANTIC_ERROR); else @@ -83,24 +73,24 @@ public boolean init(final Expression[] vars, final int matchedPattern, final } @Override - public void execute(final Event e) { - if (e instanceof Cancellable) - ((Cancellable) e).setCancelled(cancel); - if (e instanceof PlayerInteractEvent) { - EvtClick.interactTracker.eventModified((Cancellable) e); - ((PlayerInteractEvent) e).setUseItemInHand(cancel ? Result.DENY : Result.DEFAULT); - ((PlayerInteractEvent) e).setUseInteractedBlock(cancel ? Result.DENY : Result.DEFAULT); - } else if (e instanceof BlockCanBuildEvent) { - ((BlockCanBuildEvent) e).setBuildable(!cancel); - } else if (e instanceof PlayerDropItemEvent) { - PlayerUtils.updateInventory(((PlayerDropItemEvent) e).getPlayer()); - } else if (e instanceof InventoryInteractEvent) { - PlayerUtils.updateInventory(((Player) ((InventoryInteractEvent) e).getWhoClicked())); + public void execute(Event event) { + if (event instanceof Cancellable) + ((Cancellable) event).setCancelled(cancel); + if (event instanceof PlayerInteractEvent) { + EvtClick.interactTracker.eventModified((Cancellable) event); + ((PlayerInteractEvent) event).setUseItemInHand(cancel ? Event.Result.DENY : Event.Result.DEFAULT); + ((PlayerInteractEvent) event).setUseInteractedBlock(cancel ? Event.Result.DENY : Event.Result.DEFAULT); + } else if (event instanceof BlockCanBuildEvent) { + ((BlockCanBuildEvent) event).setBuildable(!cancel); + } else if (event instanceof PlayerDropItemEvent) { + PlayerUtils.updateInventory(((PlayerDropItemEvent) event).getPlayer()); + } else if (event instanceof InventoryInteractEvent) { + PlayerUtils.updateInventory(((Player) ((InventoryInteractEvent) event).getWhoClicked())); } } @Override - public String toString(final @Nullable Event e, final boolean debug) { + public String toString(@Nullable Event event, boolean debug) { return (cancel ? "" : "un") + "cancel event"; } diff --git a/src/main/java/ch/njol/skript/effects/EffSort.java b/src/main/java/ch/njol/skript/effects/EffSort.java index d387fe7bae0..25f7fc840e0 100644 --- a/src/main/java/ch/njol/skript/effects/EffSort.java +++ b/src/main/java/ch/njol/skript/effects/EffSort.java @@ -1,21 +1,3 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.effects; import ch.njol.skript.Skript; @@ -48,10 +30,13 @@ import java.util.Set; @Name("Sort") -@Description({ - "Sorts a list variable using either the natural ordering of the contents or the results of the given expression.", - "Be warned, this will overwrite the indices of the list variable." -}) +@Description(""" + Sorts a list variable using either the natural ordering of the contents or the results of the given expression. + Be warned, this will overwrite the indices of the list variable. + + When using the full sort %~objects% (by|based on) <expression> pattern, + the input expression can be used to refer to the current item being sorted. + (See input expression for more information.)""") @Examples({ "set {_words::*} to \"pineapple\", \"banana\", \"yoghurt\", and \"apple\"", "sort {_words::*} # alphabetical sort", diff --git a/src/main/java/ch/njol/skript/events/EvtEntityPotion.java b/src/main/java/ch/njol/skript/events/EvtEntityPotion.java new file mode 100644 index 00000000000..ab56287ef2b --- /dev/null +++ b/src/main/java/ch/njol/skript/events/EvtEntityPotion.java @@ -0,0 +1,74 @@ +/** + * 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 . + * + * Copyright Peter Güttinger, SkriptLang team and contributors + */ +package ch.njol.skript.events; + +import ch.njol.skript.Skript; +import ch.njol.skript.lang.Expression; +import ch.njol.skript.lang.Literal; +import ch.njol.skript.lang.SkriptEvent; +import ch.njol.skript.lang.SkriptParser.ParseResult; +import org.bukkit.event.Event; +import org.bukkit.event.entity.EntityPotionEffectEvent; +import org.bukkit.potion.PotionEffectType; + +import javax.annotation.Nullable; + +public class EvtEntityPotion extends SkriptEvent { + + static { + Skript.registerEvent("Entity Potion Effect", EvtEntityPotion.class, EntityPotionEffectEvent.class, + "entity potion effect [modif[y|ication]] [[of] %-potioneffecttypes%] [due to %-entitypotioncause%]") + .description("Called when an entity's potion effect is modified.", "This modification can include adding, removing or changing their potion effect.") + .examples( + "on entity potion effect modification:", + "\t\tbroadcast \"A potion effect was added to %event-entity%!\" ", + "", + "on entity potion effect modification of night vision:") + .since("INSERT VERSION"); + } + + @SuppressWarnings("unchecked") + private Expression potionEffects; + private Expression cause; + + @Override + public boolean init(Literal[] args, int matchedPattern, ParseResult parseResult) { + potionEffects = (Expression) args[0]; + cause = (Expression) args[1]; + return true; + } + + @Override + public boolean check(Event event) { + EntityPotionEffectEvent potionEvent = (EntityPotionEffectEvent) event; + boolean effectMatches = potionEffects == null || + (potionEvent.getOldEffect() != null && potionEffects.check(event, effectType -> effectType.equals(potionEvent.getOldEffect().getType()))) || + (potionEvent.getNewEffect() != null && potionEffects.check(event, effectType -> effectType.equals(potionEvent.getNewEffect().getType()))); + + boolean causeMatches = cause == null || cause.check(event, cause -> cause.equals(potionEvent.getCause())); + + return effectMatches && causeMatches; + } + + + @Override + public String toString(@Nullable Event event, boolean debug) { + return "on entity potion effect modification"; + } +} diff --git a/src/main/java/ch/njol/skript/expressions/ExprHoverList.java b/src/main/java/ch/njol/skript/expressions/ExprHoverList.java index a3b58b6b9d3..835319f3449 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprHoverList.java +++ b/src/main/java/ch/njol/skript/expressions/ExprHoverList.java @@ -104,7 +104,7 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) { if (HAS_NEW_LISTED_PLAYER_INFO) { List values = new ArrayList<>(); - if (mode != ChangeMode.DELETE && mode != ChangeMode.RESET) { + if (mode != ChangeMode.DELETE && mode != ChangeMode.RESET && mode != ChangeMode.REMOVE) { for (Object object : delta) { if (object instanceof Player) { Player player = (Player) object; @@ -124,7 +124,9 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) { sample.addAll(values); break; case REMOVE: - sample.removeAll(values); + for (Object value : delta) { + sample.removeIf(profile -> profile.name().equals(value)); + } break; case DELETE: case RESET: @@ -135,7 +137,7 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) { } List values = new ArrayList<>(); - if (mode != ChangeMode.DELETE && mode != ChangeMode.RESET) { + if (mode != ChangeMode.DELETE && mode != ChangeMode.RESET && mode != ChangeMode.REMOVE) { for (Object object : delta) { if (object instanceof Player) { Player player = (Player) object; @@ -150,13 +152,14 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) { switch (mode) { case SET: sample.clear(); - sample.addAll(values); - break; + // $FALL-THROUGH$ case ADD: sample.addAll(values); break; case REMOVE: - sample.removeAll(values); + for (Object value : delta) { + sample.removeIf(profile -> profile.getName() != null && profile.getName().equals(value)); + } break; case DELETE: case RESET: diff --git a/src/main/java/ch/njol/skript/expressions/ExprItems.java b/src/main/java/ch/njol/skript/expressions/ExprItems.java index 652cb3f6a72..4fb0c11d66a 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprItems.java +++ b/src/main/java/ch/njol/skript/expressions/ExprItems.java @@ -1,21 +1,3 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.expressions; import ch.njol.skript.Skript; @@ -54,7 +36,7 @@ public class ExprItems extends SimpleExpression { private static final ItemType[] ALL_BLOCKS = Arrays.stream(Material.values()) - .filter(Material::isBlock) + .filter(material -> !material.isLegacy() && material.isBlock()) .map(ItemType::new) .toArray(ItemType[]::new); diff --git a/src/main/java/ch/njol/skript/expressions/ExprPlayerChatCompletions.java b/src/main/java/ch/njol/skript/expressions/ExprPlayerChatCompletions.java new file mode 100644 index 00000000000..7bf7d335214 --- /dev/null +++ b/src/main/java/ch/njol/skript/expressions/ExprPlayerChatCompletions.java @@ -0,0 +1,93 @@ +package ch.njol.skript.expressions; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.stream.Collectors; + +import org.bukkit.entity.Player; +import org.bukkit.event.Event; +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.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.util.coll.CollectionUtils; + +@Name("Player Chat Completions") +@Description({ + "The custom chat completion suggestions. You can add, set, remove, and clear them. Removing the names of online players with this expression is ineffective.", + "This expression will not return anything due to Bukkit limitations." +}) +@Examples({ + "add \"Skript\" and \"Njol\" to chat completions of all players", + "remove \"text\" from {_p}'s chat completions", + "clear player's chat completions" +}) +@RequiredPlugins("Spigot 1.19+") +@Since("INSERT VERSION") +public class ExprPlayerChatCompletions extends SimplePropertyExpression { + + static { + if (Skript.methodExists(Player.class, "addCustomChatCompletions", Collection.class)) + register(ExprPlayerChatCompletions.class, String.class, "[custom] chat completion[s]", "players"); + } + + @Override + public @Nullable String convert(Player player) { + return null; // Due to Bukkit limitations + } + + @Override + public @Nullable Class[] acceptChange(ChangeMode mode) { + return switch (mode) { + case ADD, SET, REMOVE, DELETE, RESET -> CollectionUtils.array(String[].class); + default -> null; + }; + } + + @Override + public void change(Event event, Object @Nullable [] delta, ChangeMode mode) { + Player[] players = getExpr().getArray(event); + if (players.length == 0) + return; + List completions = new ArrayList<>(); + if (delta != null && (mode == ChangeMode.ADD || mode == ChangeMode.REMOVE || mode == ChangeMode.SET)) { + completions = Arrays.stream(delta) + .filter(String.class::isInstance) + .map(String.class::cast) + .collect(Collectors.toList()); + } + switch (mode) { + case DELETE, RESET, SET -> { + for (Player player : players) + player.setCustomChatCompletions(completions); + } + case ADD -> { + for (Player player : players) + player.addCustomChatCompletions(completions); + } + case REMOVE -> { + for (Player player : players) + player.removeCustomChatCompletions(completions); + } + } + } + + @Override + public Class getReturnType() { + return String.class; + } + + @Override + protected String getPropertyName() { + return "custom chat completions"; + } + +} diff --git a/src/main/java/ch/njol/skript/expressions/ExprRandomNumber.java b/src/main/java/ch/njol/skript/expressions/ExprRandomNumber.java index 9cf189d5643..f9ae82447fd 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprRandomNumber.java +++ b/src/main/java/ch/njol/skript/expressions/ExprRandomNumber.java @@ -18,9 +18,11 @@ */ package ch.njol.skript.expressions; +import java.util.Arrays; import java.util.Random; import java.util.concurrent.ThreadLocalRandom; +import ch.njol.skript.lang.Literal; import ch.njol.util.Math2; import org.bukkit.event.Event; import org.jetbrains.annotations.Nullable; @@ -36,62 +38,90 @@ import ch.njol.skript.lang.util.SimpleExpression; import ch.njol.util.Kleenean; -@Name("Random Number") +@Name("Random Numbers") @Description({ - "A random number or integer between two given numbers. Use 'number' if you want any number with decimal parts, or use use 'integer' if you only want whole numbers.", - "Please note that the order of the numbers doesn't matter, i.e. random number between 2 and 1 will work as well as random number between 1 and 2." + "A given amount of random numbers or integers between two given numbers. Use 'number' if you want any number with decimal parts, or use use 'integer' if you only want whole numbers.", + "Please note that the order of the numbers doesn't matter, i.e. random number between 2 and 1 will work as well as random number between 1 and 2." }) @Examples({ - "set the player's health to a random number between 5 and 10", - "send \"You rolled a %random integer from 1 to 6%!\" to the player" + "set the player's health to a random number between 5 and 10", + "send \"You rolled a %random integer from 1 to 6%!\" to the player", + "set {_chances::*} to 5 random integers between 5 and 96", + "set {_decimals::*} to 3 random numbers between 2.7 and -1.5" }) -@Since("1.4") +@Since("1.4, INSERT VERSION (Multiple random numbers)") public class ExprRandomNumber extends SimpleExpression { static { Skript.registerExpression(ExprRandomNumber.class, Number.class, ExpressionType.COMBINED, - "[a] random (:integer|number) (from|between) %number% (to|and) %number%"); + "[a|%-integer%] random (:integer|number)[s] (from|between) %number% (to|and) %number%"); } - private Expression from, to; + @Nullable + private Expression amount; + private Expression lower, upper; private boolean isInteger; @Override @SuppressWarnings("unchecked") - public boolean init(Expression[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parser) { - from = (Expression) exprs[0]; - to = (Expression) exprs[1]; - isInteger = parser.hasTag("integer"); + public boolean init(Expression[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) { + amount = (Expression) exprs[0]; + lower = (Expression) exprs[1]; + upper = (Expression) exprs[2]; + isInteger = parseResult.hasTag("integer"); return true; } @Override @Nullable protected Number[] get(Event event) { - Number from = this.from.getSingle(event); - Number to = this.to.getSingle(event); + Number lowerNumber = lower.getSingle(event); + Number upperNumber = upper.getSingle(event); + if (upperNumber == null || lowerNumber == null || !Double.isFinite(lowerNumber.doubleValue()) || !Double.isFinite(upperNumber.doubleValue())) + return new Number[0]; - if (to == null || from == null || !Double.isFinite(from.doubleValue()) || !Double.isFinite(to.doubleValue())) + Integer amount = this.amount == null ? Integer.valueOf(1) : this.amount.getSingle(event); + if (amount == null || amount <= 0) return new Number[0]; + double lower = Math.min(lowerNumber.doubleValue(), upperNumber.doubleValue()); + double upper = Math.max(lowerNumber.doubleValue(), upperNumber.doubleValue()); Random random = ThreadLocalRandom.current(); - double min = Math.min(from.doubleValue(), to.doubleValue()); - double max = Math.max(from.doubleValue(), to.doubleValue()); - if (isInteger) { - long inf = Math2.ceil(min); - long sup = Math2.floor(max); - if (max - min < 1 && inf - sup <= 1) { - if (sup == inf || min == inf) - return new Long[] {inf}; - if (max == sup) - return new Long[] {sup}; + Long[] longs = new Long[amount]; + long floored_upper = Math2.floor(upper); + long ceiled_lower = Math2.ceil(lower); + + // catch issues like `integer between 0.5 and 0.6` + if (upper - lower < 1 && ceiled_lower - floored_upper <= 1) { + if (floored_upper == ceiled_lower || lower == ceiled_lower) { + Arrays.fill(longs, ceiled_lower); + return longs; + } + if (upper == floored_upper) { + Arrays.fill(longs, floored_upper); + return longs; + } return new Long[0]; } - return new Long[] {inf + Math2.mod(random.nextLong(), sup - inf + 1)}; + + for (int i = 0; i < amount; i++) + longs[i] = Math2.ceil(lower) + Math2.mod(random.nextLong(), floored_upper - ceiled_lower + 1); + return longs; + // non-integers + } else { + Double[] doubles = new Double[amount]; + for (int i = 0; i < amount; i++) + doubles[i] = Math.min(lower + random.nextDouble() * (upper - lower), upper); + return doubles; } + } - return new Double[] {min + random.nextDouble() * (max - min)}; + @Override + public boolean isSingle() { + if (amount instanceof Literal) + return ((Literal) amount).getSingle() == 1; + return amount == null; } @Override @@ -101,12 +131,8 @@ public Class getReturnType() { @Override public String toString(@Nullable Event event, boolean debug) { - return "a random " + (isInteger ? "integer" : "number") + " between " + from.toString(event, debug) + " and " + to.toString(event, debug); - } - - @Override - public boolean isSingle() { - return true; + return (amount == null ? "a" : amount.toString(event, debug)) + " random " + (isInteger ? "integer" : "number") + + (amount == null ? "" : "s") + " between " + lower.toString(event, debug) + " and " + upper.toString(event, debug); } } diff --git a/src/main/java/ch/njol/skript/expressions/ExprSkull.java b/src/main/java/ch/njol/skript/expressions/ExprSkull.java index bce8422a76d..8b8c0e0e19b 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprSkull.java +++ b/src/main/java/ch/njol/skript/expressions/ExprSkull.java @@ -1,86 +1,45 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.expressions; +import ch.njol.skript.bukkitutil.ItemUtils; import org.bukkit.Material; import org.bukkit.OfflinePlayer; -import org.bukkit.inventory.meta.SkullMeta; import org.jetbrains.annotations.Nullable; -import ch.njol.skript.Skript; -import ch.njol.skript.aliases.Aliases; 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.Since; import ch.njol.skript.expressions.base.SimplePropertyExpression; -import ch.njol.skript.lang.Expression; -import ch.njol.skript.lang.SkriptParser.ParseResult; -import ch.njol.util.Kleenean; -/** - * @author Peter Güttinger - */ @Name("Player Skull") @Description("Gets a skull item representing a player. Skulls for other entities are provided by the aliases.") -@Examples({"give the victim's skull to the attacker", - "set the block at the entity to the entity's skull"}) +@Examples({ + "give the victim's skull to the attacker", + "set the block at the entity to the entity's skull" +}) @Since("2.0") -public class ExprSkull extends SimplePropertyExpression { - +public class ExprSkull extends SimplePropertyExpression { + static { register(ExprSkull.class, ItemType.class, "(head|skull)", "offlineplayers"); } - - /** - * In 2017, SkullMeta finally got a method that takes OfflinePlayer. - */ - private static final boolean newSkullOwner = Skript.methodExists(SkullMeta.class, "setOwningPlayer", OfflinePlayer.class); - - @Override - public boolean init(final Expression[] exprs, final int matchedPattern, final Kleenean isDelayed, final ParseResult parseResult) { - return super.init(exprs, matchedPattern, isDelayed, parseResult); - } - - @SuppressWarnings("deprecation") + @Override - @Nullable - public ItemType convert(final Object o) { + public @Nullable ItemType convert(OfflinePlayer player) { ItemType skull = new ItemType(Material.PLAYER_HEAD); - SkullMeta meta = (SkullMeta) skull.getItemMeta(); - if (newSkullOwner) - meta.setOwningPlayer((OfflinePlayer) o); - else - meta.setOwner(((OfflinePlayer) o).getName()); - skull.setItemMeta(meta); + ItemUtils.setHeadOwner(skull, player); return skull; } - + @Override public Class getReturnType() { return ItemType.class; } - + @Override protected String getPropertyName() { return "skull"; } - + } diff --git a/src/main/java/ch/njol/skript/expressions/ExprSkullOwner.java b/src/main/java/ch/njol/skript/expressions/ExprSkullOwner.java index ec80ad70793..bc102126022 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprSkullOwner.java +++ b/src/main/java/ch/njol/skript/expressions/ExprSkullOwner.java @@ -1,23 +1,6 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.expressions; +import ch.njol.skript.bukkitutil.ItemUtils; import ch.njol.skript.classes.Changer.ChangeMode; import ch.njol.skript.doc.Description; import ch.njol.skript.doc.Examples; @@ -25,6 +8,7 @@ import ch.njol.skript.doc.Since; import ch.njol.skript.expressions.base.SimplePropertyExpression; import ch.njol.util.coll.CollectionUtils; +import org.bukkit.Bukkit; import org.bukkit.OfflinePlayer; import org.bukkit.block.Block; import org.bukkit.block.BlockState; @@ -66,11 +50,20 @@ public void change(Event event, Object @Nullable [] delta, ChangeMode mode) { OfflinePlayer offlinePlayer = (OfflinePlayer) delta[0]; for (Block block : getExpr().getArray(event)) { BlockState state = block.getState(); - if (state instanceof Skull) { - Skull skull = (Skull) state; + if (!(state instanceof Skull)) + continue; + + Skull skull = (Skull) state; + if (offlinePlayer.getName() != null) { skull.setOwningPlayer(offlinePlayer); - skull.update(true, false); + } else if (ItemUtils.CAN_CREATE_PLAYER_PROFILE) { + //noinspection deprecation + skull.setOwnerProfile(Bukkit.createPlayerProfile(offlinePlayer.getUniqueId(), "")); + } else { + //noinspection deprecation + skull.setOwner(""); } + skull.update(true, false); } } diff --git a/src/main/java/ch/njol/skript/expressions/ExprTime.java b/src/main/java/ch/njol/skript/expressions/ExprTime.java index 4e769f6656d..e2199e18a80 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprTime.java +++ b/src/main/java/ch/njol/skript/expressions/ExprTime.java @@ -1,27 +1,5 @@ -/** - * 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 . - * - * Copyright Peter Güttinger, SkriptLang team and contributors - */ package ch.njol.skript.expressions; -import org.bukkit.World; -import org.bukkit.event.Event; -import org.jetbrains.annotations.Nullable; - import ch.njol.skript.Skript; import ch.njol.skript.classes.Changer.ChangeMode; import ch.njol.skript.doc.Description; @@ -32,42 +10,51 @@ import ch.njol.skript.lang.Expression; import ch.njol.skript.lang.ExpressionType; import ch.njol.skript.lang.SkriptParser.ParseResult; -import ch.njol.skript.registrations.Classes; -import ch.njol.skript.util.Getter; import ch.njol.skript.util.Time; import ch.njol.skript.util.Timeperiod; import ch.njol.skript.util.Timespan; import ch.njol.util.Kleenean; import ch.njol.util.coll.CollectionUtils; +import org.bukkit.World; +import org.bukkit.event.Event; +import org.jetbrains.annotations.Nullable; -/** - * @author Peter Güttinger - */ @Name("Time") -@Description("The time of a world.") -@Examples({"time in world is between 18:00 and 6:00:", - " broadcast \"It's night-time, watch out for monsters!\""}) +@Description({ + "The time of a world.", + "Use the \"minecraft timespan\" syntax to change the time according " + + "to Minecraft's time intervals.", + "Since Minecraft uses discrete intervals for time (ticks), " + + "changing the time by real-world minutes or real-world seconds only changes it approximately.", + "Removing an amount of time from a world's time will move the clock forward a day." +}) +@Examples({ + "set time of world \"world\" to 2:00", + "add 2 minecraft hours to time of world \"world\"", + "add 54 real seconds to time of world \"world\" # approximately 1 minecraft hour" +}) @Since("1.0") public class ExprTime extends PropertyExpression { + + // 18000 is the offset to allow for using "add 2:00" without going to a new day + // and causing unexpected behaviour + private static final int TIME_TO_TIMESPAN_OFFSET = 18000; + static { - Skript.registerExpression(ExprTime.class, Time.class, ExpressionType.PROPERTY, "[the] time[s] [([with]in|of) %worlds%]", "%worlds%'[s] time[s]"); + Skript.registerExpression(ExprTime.class, Time.class, ExpressionType.PROPERTY, + "[the] time[s] [([with]in|of) %worlds%]", "%worlds%'[s] time[s]"); } - - @SuppressWarnings({"unchecked", "null"}) + + @SuppressWarnings("unchecked") @Override - public boolean init(final Expression[] exprs, final int matchedPattern, final Kleenean isDelayed, final ParseResult parser) { - setExpr((Expression) exprs[0]); + public boolean init(Expression[] expressions, int matchedPattern, Kleenean isDelayed, ParseResult parser) { + setExpr((Expression) expressions[0]); return true; } - + @Override - protected Time[] get(final Event e, final World[] source) { - return get(source, new Getter() { - @Override - public Time get(final World w) { - return new Time((int) w.getTime()); - } - }); + protected Time[] get(Event event, World[] worlds) { + return get(worlds, world -> new Time((int) world.getTime())); } @Override @@ -76,56 +63,62 @@ public Class[] acceptChange(final ChangeMode mode) { switch (mode) { case ADD: case REMOVE: - return CollectionUtils.array(Timespan.class); + // allow time to avoid conversion to timespan, which causes all sorts of headaches + return CollectionUtils.array(Time.class, Timespan.class); case SET: return CollectionUtils.array(Time.class, Timeperiod.class); - case DELETE: - case REMOVE_ALL: - case RESET: default: return null; } } - + @Override - public void change(final Event e, final @Nullable Object[] delta, final ChangeMode mode) { - final World[] worlds = getExpr().getArray(e); - int mod = 1; - switch (mode) { - case SET: - assert delta != null; - final int time = delta[0] instanceof Time ? ((Time) delta[0]).getTicks() : ((Timeperiod) delta[0]).start; - for (final World w : worlds) { - w.setTime(time); - } - break; - case REMOVE: - mod = -1; - //$FALL-THROUGH$ - case ADD: - assert delta != null; - final Timespan ts = (Timespan) delta[0]; - for (final World w : worlds) { - w.setTime(w.getTime() + mod * ts.getTicks()); - } - break; - case DELETE: - case REMOVE_ALL: - case RESET: - assert false; + public void change(Event event, Object @Nullable [] delta, ChangeMode mode) { + if (getExpr() == null || delta == null) + return; + + Object time = delta[0]; + if (time == null) + return; + + World[] worlds = getExpr().getArray(event); + + long ticks = 0; + if (time instanceof Time) { + if (mode != ChangeMode.SET) { + ticks = ((Time) time).getTicks() - TIME_TO_TIMESPAN_OFFSET; + } else { + ticks = ((Time) time).getTicks(); + } + } else if (time instanceof Timespan) { + ticks = ((Timespan) time).getAs(Timespan.TimePeriod.TICK); + } else if (time instanceof Timeperiod) { + ticks = ((Timeperiod) time).start; + } + + for (World world : worlds) { + switch (mode) { + case ADD: + world.setTime(world.getTime() + ticks); + break; + case REMOVE: + world.setTime(world.getTime() - ticks); + break; + case SET: + world.setTime(ticks); + break; + } } } - + @Override public Class