Nice documentation of useful methods.

Author: Moderocky

pom.xml

@@ -8,6 +8,7 @@
     <artifactId>byteskript</artifactId>
     <version>1.0.9</version>
     <name>ByteSkript</name>
+    <description>A compiled JVM implementation of the Skript language.</description>
 
     <properties>
         <maven.compiler.source>17</maven.compiler.source>

src/main/java/org/byteskript/skript/lang/syntax/script/LoadScriptEffect.java

@@ -30,7 +30,7 @@
             load script {file} as "skript/myscript"
             load script {code} as "skript/myscript"
                 """
-    } // todo
+    }
 )
 public class LoadScriptEffect extends Effect {
 
@@ -40,11 +40,12 @@ public LoadScriptEffect() {
     }
 
     @ForceExtract
+    @SuppressWarnings("deprecation")
     public static void loadScript(Object object, String name) throws IOException {
         if (object instanceof File file)
-            Skript.currentInstance().compileLoad(file, name);
+            Skript.localInstance().compileLoad(file, name);
         else if (object instanceof String string)
-            Skript.currentInstance()
+            Skript.localInstance()
                 .compileLoad(new ByteArrayInputStream(string.getBytes(StandardCharsets.UTF_8)), name);
     }
 

src/main/java/org/byteskript/skript/lang/syntax/script/UnloadScriptEffect.java

@@ -40,11 +40,11 @@ public UnloadScriptEffect() {
     @ForceExtract
     public static void unloadScript(Object object) throws IOException {
         if (object instanceof Class main)
-            Skript.currentInstance().unloadScript(main);
+            Skript.localInstance().unloadScript(main);
         else if (object instanceof Script script)
-            Skript.currentInstance().unloadScript(script);
+            Skript.localInstance().unloadScript(script);
         else if (object instanceof String name)
-            Skript.currentInstance().unloadScript(Skript.LOADER.findClass(name.replace('/', '.')));
+            Skript.localInstance().unloadScript(Skript.LOADER.findClass(name.replace('/', '.')));
     }
 
 }

src/main/java/org/byteskript/skript/runtime/Script.java

@@ -21,25 +21,33 @@
 import java.lang.reflect.Method;
 import java.util.*;
 
+/**
+ * A handle representation of a script containing its metadata and defined classes.
+ * <p>
+ * This can be used to find insights about a script or find a particular function handle.
+ * <p>
+ * These should not be stored - they can be arbitrarily graveyarded without any notification
+ * by the unloader, in which case this will become a dead spot in memory.
+ */
 public final class Script {
     private final File sourceFile;
     private final Class<?>[] classes;
     private final String name;
     private final Map<String, Member> functions;
-    private final List<Member> events;
     private final Collection<SourceData> data;
     private final Structure[] members;
+    private final Skript skript;
 
-    public Script(Skript skript, File sourceFile, Class<?>... classes) {
+    Script(Skript skript, File sourceFile, Class<?>... classes) {
         this(true, skript, sourceFile, classes);
     }
 
-    public Script(boolean init, Skript skript, File sourceFile, Class<?>... classes) {
+    Script(boolean init, Skript skript, File sourceFile, Class<?>... classes) {
+        this.skript = skript;
         this.sourceFile = sourceFile;
         this.classes = classes;
         this.name = mainClass().getName();
         this.functions = new HashMap<>();
-        this.events = new ArrayList<>();
         this.data = new ArrayList<>();
         final List<Structure> structures = new ArrayList<>();
         for (final Class<?> type : classes) {
@@ -59,20 +67,19 @@ public Script(boolean init, Skript skript, File sourceFile, Class<?>... classes)
             } else if (method.isAnnotationPresent(EventData.class)) {
                 final EventData event = method.getAnnotation(EventData.class);
                 final Member member = new Member(this, method, event.async());
-                this.events.add(member);
                 skript.registerEventHandler((Class<? extends Event>) skript.getClass(event.event()), new InvokingScriptRunner(mainClass(), member));
             }
         }
         this.members = structures.toArray(new Structure[0]);
         if (init) {
-            verify();
-            load(skript);
+            this.verify();
+            this.load(skript);
         }
     }
 
     void verify() {
-        forceLoad(mainClass());
-        for (Map.Entry<String, Member> entry : functions.entrySet()) {
+        this.forceLoad(mainClass());
+        for (final Map.Entry<String, Member> entry : functions.entrySet()) {
             final Member value = entry.getValue();
             final String name = entry.getKey();
             try {
@@ -88,34 +95,81 @@ void load(Skript skript) {
         skript.runEvent(new Load(this));
     }
 
+    /**
+     * The simple name of the main class for this script.
+     * This will be something in the format `script`
+     *
+     * @return the simple name
+     */
     public String getSimpleName() {
         return mainClass().getSimpleName();
     }
 
+    /**
+     * The path of the main class for this script.
+     * This will be something in the format `skript.path.to.script`
+     *
+     * @return the path
+     */
     public String getPath() {
         return mainClass().getName();
     }
 
+    /**
+     * Gets the main class of this script, which root-level members occupy.
+     * Custom types and other members may be moved to other classes, depending on the compiler used.
+     * This should not be stored - it will prevent the script unloading safely.
+     *
+     * @return the main class
+     */
     public Class<? extends CompiledScript> mainClass() {
         return (Class<? extends CompiledScript>) classes[0];
     }
 
+    /**
+     * Whether this script has a known source file.
+     *
+     * @return the source file
+     */
     public boolean hasSourceFile() {
         return sourceFile != null && sourceFile.exists() && sourceFile.isFile();
     }
 
+    /**
+     * Returns a handle for the function with this name.
+     * Multiple functions may have the same name, this will return an arbitrary one.
+     *
+     * @param name the function name
+     * @return the function
+     */
     public Member getFunction(String name) {
         return functions.get(name);
     }
 
+    /**
+     * Finds source data annotations for members in this script.
+     *
+     * @return member data
+     */
     public Collection<SourceData> getMemberData() {
         return data;
     }
 
+    /**
+     * Returns the known source file for this script.
+     *
+     * @return potentially null source file
+     */
     public File sourceFile() {
         return sourceFile;
     }
 
+    /**
+     * Returns the known classes for this script.
+     * This will include the main class and any custom types, etc.
+     *
+     * @return the classes
+     */
     public Class<?>[] classes() {
         return classes;
     }
@@ -126,6 +180,11 @@ public String toString() {
             "name=" + name + ']';
     }
 
+    /**
+     * Returns the structures for all members, used for data collection.
+     *
+     * @return all found structures
+     */
     public Structure[] getMembers() {
         return members;
     }
@@ -137,5 +196,12 @@ private void forceLoad(Class<?> cls) {
         }
     }
 
-    
+    /**
+     * Returns the Skript runtime that created this script.
+     *
+     * @return the runtime
+     */
+    public Skript skriptInstance() {
+        return skript;
+    }
 }