Implemented a deprecated actions system...

just so i could fix an inconsistency with TEXT_SUBTEXT...

Author: XTerPL

src/main/java/io/github/techstreet/dfscript/screen/script/ScriptAddActionScreen.java

@@ -45,6 +45,7 @@ public ScriptAddActionScreen(Script script, int insertIndex, ScriptActionCategor
 
         for (ScriptActionType type : ScriptActionType.values()) {
             if (type.getCategory() != category) continue;
+            if (type.isDeprecated()) continue;
 
             CItem item = new CItem(x, y, type.getIcon());
             item.setClickListener((btn) -> {

src/main/java/io/github/techstreet/dfscript/screen/script/ScriptEditScreen.java

@@ -57,8 +57,11 @@ public ScriptEditScreen(Script script) {
                     @Override
                     public void render(MatrixStack stack, int mouseX, int mouseY, float tickDelta) {
                         Rectangle b = getBounds();
+
                         if (b.contains(mouseX, mouseY)) {
-                            DrawableHelper.fill(stack, b.x, b.y, b.x + b.width, b.y + b.height, 0x33000000);
+                            int color = 0x33000000;
+
+                            DrawableHelper.fill(stack, b.x, b.y, b.x + b.width, b.y + b.height, color);
                         }
                     }
 
@@ -123,7 +126,21 @@ public Rectangle getBounds() {
                     public void render(MatrixStack stack, int mouseX, int mouseY, float tickDelta) {
                         Rectangle b = getBounds();
                         if (b.contains(mouseX, mouseY)) {
-                            DrawableHelper.fill(stack, b.x, b.y, b.x + b.width, b.y + b.height, 0x33000000);
+                            int color = 0x33000000;
+
+                            if(sa.getType().isDeprecated())
+                            {
+                                color = 0x80FF0000;
+                            }
+
+                            DrawableHelper.fill(stack, b.x, b.y, b.x + b.width, b.y + b.height, color);
+                        }
+                        else
+                        {
+                            if(sa.getType().isDeprecated())
+                            {
+                                DrawableHelper.fill(stack, b.x, b.y, b.x + b.width, b.y + b.height, 0x33FF0000);
+                            }
                         }
                     }
 

src/main/java/io/github/techstreet/dfscript/script/Script.java

@@ -28,7 +28,7 @@
 import org.apache.logging.log4j.Logger;
 
 public class Script {
-    public static int scriptVersion = 2;
+    public static int scriptVersion = 3;
 
     private String name;
     private String owner;
@@ -245,6 +245,19 @@ public ScriptContext getContext() {
         return context;
     }
 
+    public void replaceAction(ScriptActionType oldAction, ScriptActionType newAction) {
+        for(int i = 0; i < parts.size(); i++)
+        {
+            if(parts.get(i) instanceof ScriptAction)
+            {
+                if(((ScriptAction) parts.get(i)).getType() == oldAction)
+                {
+                    parts.set(i, ((ScriptAction) parts.get(i)).setType(newAction));
+                }
+            }
+        }
+    }
+
     public static class Serializer implements JsonSerializer<Script>, JsonDeserializer<Script> {
         @Override
         public Script deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {

src/main/java/io/github/techstreet/dfscript/script/ScriptMigrator.java

@@ -1,6 +1,7 @@
 package io.github.techstreet.dfscript.script;
 
 import io.github.techstreet.dfscript.DFScript;
+import io.github.techstreet.dfscript.script.action.ScriptActionType;
 
 public class ScriptMigrator {
     public static void migrate(Script script) {
@@ -17,6 +18,11 @@ public static void migrate(Script script) {
             script.setVersion(2);
         }
 
+        if (script.getVersion() == 2) {
+            script.replaceAction(ScriptActionType.TEXT_SUBTEXT, ScriptActionType.TEXT_SUBTEXT_V1);
+            script.setVersion(3);
+        }
+
         if (previousVer != script.getVersion()) {
             ScriptManager.LOGGER.info("Migrated script '" + script.getName() + "' from version " + previousVer + " to version " + script.getVersion() + "!");
             ScriptManager.getInstance().saveScript(script);

src/main/java/io/github/techstreet/dfscript/script/action/ScriptAction.java

@@ -20,14 +20,20 @@
 
 public class ScriptAction implements ScriptPart {
 
-    private final ScriptActionType type;
+    private ScriptActionType type;
     private final List<ScriptArgument> arguments;
 
     public ScriptAction(ScriptActionType type, List<ScriptArgument> arguments) {
         this.type = type;
         this.arguments = arguments;
     }
 
+    public ScriptAction setType(ScriptActionType newType) {
+        type = newType;
+
+        return this;
+    }
+
     public void invoke(Event event, ScriptContext context, Consumer<ScriptScopeVariables> inner, ScriptTask task, Script script) {
         type.run(new ScriptActionContext(
             context, arguments, event, inner, task, new HashMap<>(), script

src/main/java/io/github/techstreet/dfscript/script/action/ScriptActionType.java

@@ -1218,12 +1218,29 @@ public enum ScriptActionType {
         .arg("Last Index",ScriptActionArgumentType.NUMBER)
         .action(ctx -> {
             String text = ctx.value("Text").asText();
-            int start = (int)ctx.value("First Index").asNumber()+1;
+            int start = (int)ctx.value("First Index").asNumber()-1;
             int end = (int)ctx.value("Last Index").asNumber();
             String result = text.substring(start, end);
             ctx.context().setVariable(ctx.variable("Result").name(), new ScriptTextValue(result));
         })),
 
+    TEXT_SUBTEXT_V1(builder -> builder.name("Get Subtext OLD")
+            .description("Gets a piece of text within another text.")
+            .icon(Items.KNOWLEDGE_BOOK)
+            .category(ScriptActionCategory.TEXTS)
+            .arg("Result",ScriptActionArgumentType.VARIABLE)
+            .arg("Text",ScriptActionArgumentType.TEXT)
+            .arg("First Index",ScriptActionArgumentType.NUMBER)
+            .arg("Last Index",ScriptActionArgumentType.NUMBER)
+            .deprecate(TEXT_SUBTEXT)
+            .action(ctx -> {
+                String text = ctx.value("Text").asText();
+                int start = (int)ctx.value("First Index").asNumber()+1;
+                int end = (int)ctx.value("Last Index").asNumber();
+                String result = text.substring(start, end);
+                ctx.context().setVariable(ctx.variable("Result").name(), new ScriptTextValue(result));
+            })),
+
     TEXT_LENGTH(builder -> builder.name("Get Text Length")
         .description("Get the length of a text value.")
         .icon(Items.BOOKSHELF)
@@ -1755,19 +1772,35 @@ public enum ScriptActionType {
     private ScriptActionCategory category = ScriptActionCategory.MISC;
     private List<String> description = new ArrayList();
     private ScriptGroup group = ScriptGroup.ACTION;
+
+    private ScriptActionType deprecated = null; //if deprecated == null, the action is not deprecated
     private final List<ScriptActionArgument> arguments = new ArrayList<>();
     ScriptActionType(Consumer<ScriptActionType> builder) {
         description.add("No description provided.");
         builder.accept(this);
     }
     public ItemStack getIcon() {
         ItemStack item = new ItemStack(icon);
+
         item.setCustomName(Text.literal(name)
             .fillStyle(Style.EMPTY
                 .withColor(Formatting.WHITE)
                 .withItalic(false)));
 
         NbtList lore = new NbtList();
+
+        if(isDeprecated())
+        {
+            lore.add(NbtString.of(Text.Serializer.toJson(Text.literal("This action is deprecated!")
+                    .fillStyle(Style.EMPTY
+                            .withColor(Formatting.RED)
+                            .withItalic(false)))));
+            lore.add(NbtString.of(Text.Serializer.toJson(Text.literal("Use '" + deprecated.getName() + "'")
+                    .fillStyle(Style.EMPTY
+                            .withColor(Formatting.RED)
+                            .withItalic(false)))));
+        }
+
         for (String descriptionLine: description) {
             lore.add(NbtString.of(Text.Serializer.toJson(Text.literal(descriptionLine)
                 .fillStyle(Style.EMPTY
@@ -1796,6 +1829,10 @@ public String getName() {
         return name;
     }
 
+    public boolean isDeprecated() {
+        return deprecated != null;
+    }
+
     public boolean hasChildren() {
         return hasChildren;
     }
@@ -1869,6 +1906,12 @@ public ScriptActionType arg(String name, ScriptActionArgumentType type) {
         });
     }
 
+    public ScriptActionType deprecate(ScriptActionType newScriptActionType) {
+        deprecated = newScriptActionType;
+
+        return this;
+    }
+
     public void run(ScriptActionContext ctx) {
         List<List<ScriptActionArgument>> possibilities = new ArrayList<>();