changes

Author: AnxeloK

README.md

@@ -0,0 +1,34 @@
+# Skript-PK
+
+A Skript addon designed to seamlessly integrate **ProjectKorra** abilities and mechanics into Skript. This plugin enables server administrators to interact with ProjectKorra's bending system through Skript syntax, allowing for custom scripting of bending-related actions, presets, and player management.
+
+---
+
+## Overview
+
+This addon acts as a bridge between Skript and ProjectKorra, providing syntax to:
+- Manage bending abilities and player presets.
+- Toggle bending mechanics for players.
+- Retrieve bending-related data for use in scripts.
+
+Designed for simplicity, it empowers server owners to create unique bending experiences without direct plugin modification.
+
+---
+
+## Installation
+
+1. Ensure **[Skript](https://github.com/SkriptLang/Skript)** and **[ProjectKorra](https://github.com/ProjectKorra/ProjectKorra/)** are installed.
+2. Place `Skript-PK.jar` into your server's `plugins/` folder.
+3. Restart the server.
+
+---
+
+## Requirements
+- Minecraft 1.15+
+- Skript 2.10.1+
+- ProjectKorra (Core) 1.11.1+
+
+---
+
+
+**Developer:** AnxeloK

pom.xml

@@ -43,7 +43,7 @@
             <version>2.10.1</version>
             <scope>provided</scope>
         </dependency>
-        <!-- ProjectKorra -->
+        <!-- ProjectKorra API-->
         <dependency>
             <groupId>com.projectkorra</groupId>
             <artifactId>projectkorra</artifactId>

src/me/anxelok/Main.java

@@ -12,11 +12,13 @@ public class Main extends JavaPlugin {
     public void onEnable() {
         getLogger().info("[Skript-PK] Enabling Skript-PK...");
 
+        // check if Skript is installed
         if (getServer().getPluginManager().getPlugin("Skript") == null) {
             getLogger().severe("[Skript-PK] ERROR: Skript not found! Disabling plugin.");
             getServer().getPluginManager().disablePlugin(this);
             return;
         }
+        // check if ProjectKorra is installed
         if (getServer().getPluginManager().getPlugin("ProjectKorra") == null) {
             getLogger().severe("[Skript-PK] ERROR: ProjectKorra not found! Disabling plugin.");
             getServer().getPluginManager().disablePlugin(this);
@@ -25,12 +27,12 @@ public void onEnable() {
 
         getLogger().info("[Skript-PK] Registering ability structure...");
 
-        // Register all Skript syntax via the Skript addon system.
+        // register skript syntax
         getLogger().info("[Skript-PK] Registering Skript syntax...");
         SkriptAddon addon = Skript.registerAddon(this);
 
         try {
-            // Load all classes within the "me.anxelok.syntax" package and its subpackages.
+            // load syntax classes
             addon.loadClasses("me.anxelok.syntax");
         } catch (IOException error) {
             error.printStackTrace();

src/me/anxelok/syntax/effects/EffBindUnbindAbility.java

@@ -30,31 +30,30 @@ public class EffBindUnbindAbility extends Effect {
     private Expression<String> abilityExpr;
     private Expression<Player> playerExpr;
     private Expression<Integer> slotExpr;
-    private boolean isBind; // true if bind, false if unbind by slot
-    private boolean unbindByName; // true if unbind by name
+    private boolean isBind; // true for bind, false for unbind by slot
+    private boolean unbindByName; // true for unbind by name
 
     static {
         Skript.registerEffect(EffBindUnbindAbility.class,
-                "bind %string% to current slot of %player%",
-                "unbind ability from [slot] %integer% of %player%",
-                "unbind ability %string% of %player%");
+                "bind %string% to (slot %integer%|current slot) of %player%",
+                "unbind ability (from slot %integer%|current slot|%string%) of %player%");
     }
 
     @Override
     @SuppressWarnings("unchecked")
     public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
         if (matchedPattern == 0) {
-            // Bind syntax: "bind %string% to current slot of %player%"
+            // bind ability to current slot
             abilityExpr = (Expression<String>) exprs[0];
             playerExpr = (Expression<Player>) exprs[1];
             isBind = true;
         } else if (matchedPattern == 1) {
-            // Unbind by slot: "unbind ability from [slot] %integer% of %player%"
+            // unbind by slot
             slotExpr = (Expression<Integer>) exprs[0];
             playerExpr = (Expression<Player>) exprs[1];
             isBind = false;
         } else {
-            // Unbind by name: "unbind ability %string% of %player%"
+            // unbind by ability name
             abilityExpr = (Expression<String>) exprs[0];
             playerExpr = (Expression<Player>) exprs[1];
             unbindByName = true;
@@ -76,24 +75,42 @@ protected void execute(Event e) {
         }
 
         if (isBind) {
+            // bind ability to specific slot or current slot
             String ability = abilityExpr.getSingle(e);
             if (ability == null) return;
-            int currentSlot = player.getInventory().getHeldItemSlot();
-            abilities.put(currentSlot, ability);
-            bPlayer.setAbilities((HashMap<Integer, String>) abilities);  // Cast to HashMap
+
+            Integer slot;
+            if (slotExpr != null) {
+                slot = slotExpr.getSingle(e); // Use specific slot
+            } else {
+                slot = player.getInventory().getHeldItemSlot(); // Use current slot
+            }
+
+            if (slot == null) return;
+            abilities.put(slot, ability);
+            bPlayer.setAbilities((HashMap<Integer, String>) abilities);
         } else if (unbindByName) {
+            // unbind ability by name
             String ability = abilityExpr.getSingle(e);
             if (ability == null) return;
             abilities.entrySet().removeIf(entry -> entry.getValue().equalsIgnoreCase(ability));
-            bPlayer.setAbilities((HashMap<Integer, String>) abilities);  // Cast to HashMap
+            bPlayer.setAbilities((HashMap<Integer, String>) abilities);
         } else {
-            Integer slot = slotExpr.getSingle(e);
+            // unbind by slot number or current slot
+            Integer slot;
+            if (slotExpr != null) {
+                slot = slotExpr.getSingle(e); // Use specific slot
+            } else {
+                slot = player.getInventory().getHeldItemSlot(); // Use current slot
+            }
+
             if (slot == null) return;
             abilities.remove(slot);
-            bPlayer.setAbilities((HashMap<Integer, String>) abilities);  // Cast to HashMap
+            bPlayer.setAbilities((HashMap<Integer, String>) abilities);
         }
     }
 
+
     @Override
     public String toString(@Nullable Event e, boolean debug) {
         if (isBind) {

src/me/anxelok/syntax/effects/EffPresetManagement.java

@@ -39,8 +39,8 @@ public class EffPresetManagement extends Effect {
     private Expression<String> presetNameExpr;
     private Expression<String> abilityExpr;
     private Expression<Integer> slotExpr;
-    private Expression<String> playerExpr; // For player-specific presets
-    private Expression<String> newPresetNameExpr; // For renaming presets
+    private Expression<String> playerExpr; // for player presets
+    private Expression<String> newPresetNameExpr; // for renaming
     private boolean isCreatePreset;
     private boolean isChangeSlot;
     private boolean isCreatePlayerPreset;
@@ -106,38 +106,38 @@ protected void execute(Event e) {
             String[] abilities = abilityExpr.getAll(e);
             if (presetName == null || abilities == null) return;
 
-            // Create a map of abilities for the global preset
+            // create map of abilities for global preset
             Map<Integer, String> presetMap = new HashMap<>();
             for (int i = 0; i < abilities.length; i++) {
-                presetMap.put(i + 1, abilities[i]); // Slot numbers start from 1
+                presetMap.put(i + 1, abilities[i]); // ability slots start at 1
             }
 
-            // Save the global preset in externalPresets (global storage)
+            // store global preset
             Preset.externalPresets.put(presetName, new ArrayList<>(Arrays.asList(abilities)));
         } else if (isCreatePlayerPreset) {
             String presetName = presetNameExpr.getSingle(e);
             String playerName = playerExpr.getSingle(e);
             String[] abilities = abilityExpr.getAll(e);
             if (presetName == null || playerName == null || abilities == null) return;
 
-            // Create the player-specific preset
+            // create player preset
             Player player = Bukkit.getPlayer(playerName);
             if (player != null) {
                 Map<Integer, String> playerPresetMap = new HashMap<>();
                 for (int i = 0; i < abilities.length; i++) {
                     playerPresetMap.put(i + 1, abilities[i]);
                 }
 
-                // Use HashMap directly to match the constructor
+                // create player preset object and store it
                 Preset playerPreset = new Preset(player.getUniqueId(), presetName, new HashMap<>(playerPresetMap));
-                Preset.presets.put(player.getUniqueId(), Arrays.asList(playerPreset)); // Store player preset
+                Preset.presets.put(player.getUniqueId(), Arrays.asList(playerPreset));
             }
         } else if (isCreatePresetFromAnother) {
             String presetName = presetNameExpr.getSingle(e);
             String existingPresetName = abilityExpr.getSingle(e);
             if (presetName == null || existingPresetName == null) return;
 
-            // Copy abilities from the existing preset and create a new one
+            // copy abilities from existing preset
             ArrayList<String> existingAbilities = Preset.externalPresets.get(existingPresetName);
             if (existingAbilities != null) {
                 Preset.externalPresets.put(presetName, existingAbilities);
@@ -148,7 +148,7 @@ protected void execute(Event e) {
             String ability = abilityExpr.getSingle(e);
             if (slot == null || presetName == null || ability == null) return;
 
-            // Update the ability in the corresponding slot for the preset (global or player)
+            // update slot ability for global or player preset
             if (playerExpr != null) {
                 String playerName = playerExpr.getSingle(e);
                 Player player = Bukkit.getPlayer(playerName);
@@ -162,26 +162,26 @@ protected void execute(Event e) {
                 ArrayList<String> presetAbilities = Preset.externalPresets.get(presetName);
                 if (presetAbilities != null && slot >= 1 && slot <= presetAbilities.size()) {
                     presetAbilities.set(slot - 1, ability);
-                    Preset.externalPresets.put(presetName, presetAbilities); // Update the global preset
+                    Preset.externalPresets.put(presetName, presetAbilities); // update global preset
                 }
             }
         } else if (isRenamePreset) {
             String oldPresetName = presetNameExpr.getSingle(e);
             String newPresetName = newPresetNameExpr.getSingle(e);
             if (oldPresetName == null || newPresetName == null) return;
 
-            // Rename the preset in global storage
+            // rename preset in global storage
             ArrayList<String> abilities = Preset.externalPresets.get(oldPresetName);
             if (abilities != null) {
                 Preset.externalPresets.put(newPresetName, abilities);
-                Preset.externalPresets.remove(oldPresetName); // Remove old name
+                Preset.externalPresets.remove(oldPresetName); // remove old name
             }
         } else if (isDeletePreset) {
             String presetName = presetNameExpr.getSingle(e);
             String playerName = playerExpr != null ? playerExpr.getSingle(e) : null;
             if (presetName == null) return;
 
-            // Delete the preset from global storage or player-specific presets
+            // delete preset from global or player-specific storage
             if (playerName != null) {
                 Player player = Bukkit.getPlayer(playerName);
                 if (player != null) {
@@ -194,7 +194,7 @@ protected void execute(Event e) {
     }
 
     private ArrayList<String> getPlayerPresetAbilities(UUID playerUUID, String presetName) {
-        // Get the player-specific preset abilities
+        // get player preset abilities
         for (Preset preset : Preset.presets.get(playerUUID)) {
             if (preset.getName().equals(presetName)) {
                 return new ArrayList<>(preset.getAbilities().values());

src/me/anxelok/syntax/effects/EffToggleBending.java

@@ -21,9 +21,10 @@
 @Since("1.0")
 public class EffToggleBending extends Effect {
     private Expression<Player> playerExpr;
-    private String mode; // "toggle", "on", "off"
+    private String mode; // toggle, on, off
 
     static {
+        // register the effect with Skript
         Skript.registerEffect(EffToggleBending.class,
                 "toggle %player%'s bending",
                 "toggle %player%'s bending to on",
@@ -51,6 +52,7 @@ protected void execute(Event e) {
         BendingPlayer bPlayer = BendingPlayer.getBendingPlayer(player);
         if (bPlayer == null) return;
 
+        // toggle, on, or off
         switch (mode) {
             case "toggle":
                 bPlayer.toggleBending();
@@ -66,6 +68,7 @@ protected void execute(Event e) {
 
     @Override
     public String toString(@Nullable Event e, boolean debug) {
+        // return effect string
         return "toggle " + playerExpr.toString(e, debug) + "'s bending" +
                 (mode.equals("toggle") ? "" : " to " + mode);
     }

src/me/anxelok/syntax/expressions/ExprBendingAbilities.java

@@ -20,7 +20,7 @@
 public class ExprBendingAbilities extends SimpleExpression<String> {
 
     private ch.njol.skript.lang.Expression<Player> playerExpr;
-    private static final int MAX_SLOTS = 9; // Maximum number of ability slots
+    private static final int MAX_SLOTS = 9; // max ability slots
 
     static {
         Skript.registerExpression(ExprBendingAbilities.class, String.class,
@@ -38,28 +38,25 @@ public boolean init(ch.njol.skript.lang.Expression<?>[] exprs, int matchedPatter
     @Override
     protected String[] get(Event e) {
         Player player = playerExpr.getSingle(e);
-        if (player == null) return new String[0];
+        if (player == null) return new String[0];  // no player
         BendingPlayer bPlayer = BendingPlayer.getBendingPlayer(player);
-        if (bPlayer == null) return new String[0];
+        if (bPlayer == null) return new String[0];  // no bending player
 
-        // Get the abilities map (slot -> ability name)
+        // get abilities from slots
         java.util.Map<Integer, String> abilities = bPlayer.getAbilities();
 
-        // Create an array with a fixed length of MAX_SLOTS.
+        // create output array
         String[] output = new String[MAX_SLOTS];
         for (int slot = 1; slot <= MAX_SLOTS; slot++) {
-            if (abilities != null && abilities.containsKey(slot)) {
-                output[slot - 1] = abilities.get(slot);
-            } else {
-                output[slot - 1] = ""; // or you could use "none" as a placeholder
-            }
+            // fill slots with abilities or empty
+            output[slot - 1] = abilities != null && abilities.containsKey(slot) ? abilities.get(slot) : "";
         }
         return output;
     }
 
     @Override
     public boolean isSingle() {
-        return false;  // We return a list of abilities (one for each slot).
+        return false;  // return list
     }
 
     @Override

src/me/anxelok/syntax/expressions/ExprBendingStatus.java

@@ -21,7 +21,7 @@
 public class ExprBendingStatus extends SimpleExpression<Boolean> {
 
     private Expression<Player> playerExpr;
-    private boolean checkStatus;  // true to check if bending is on, false to check if bending is off
+    private boolean checkStatus;  // true for on, false for off
 
     static {
         Skript.registerExpression(ExprBendingStatus.class, Boolean.class, ExpressionType.SIMPLE,
@@ -38,18 +38,18 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
     @Override
     public Boolean[] get(Event e) {
         Player player = playerExpr.getSingle(e);
-        if (player == null) return new Boolean[0];  // Return empty array if no player found
+        if (player == null) return new Boolean[0];  // no player
 
         BendingPlayer bPlayer = BendingPlayer.getBendingPlayer(player);
-        if (bPlayer == null) return new Boolean[0];  // Return empty array if no BendingPlayer is found
+        if (bPlayer == null) return new Boolean[0];  // no bending player
 
-        // Return whether bending is enabled or not
+        // check if bending is on
         return new Boolean[] { bPlayer.isToggled() };
     }
 
     @Override
     public boolean isSingle() {
-        return true;  // We return a single boolean (whether bending is on or off)
+        return true;  // returns one value
     }
 
     @Override