Events rehaul

build.gradle.kts

@@ -52,6 +52,9 @@ dependencies {
  testImplementation("org.junit.jupiter:junit-jupiter:5.12.2")
  testImplementation("org.mockbukkit.mockbukkit:mockbukkit-v1.21:4.45.1")
  testImplementation("org.mockito.kotlin:mockito-kotlin:5.4.0")
+
+	// TODO check if needed
+ implementation("com.google.guava:guava:32.0.1-jre")
 }
 
 val targetJavaVersion = 21

src/main/kotlin/dev/znci/rocket/Rocket.kt

@@ -66,7 +66,8 @@ open class Rocket : RocketAddon() {
  this.getCommand("rocket")?.setExecutor(RocketCommand(this))
 
  // Register all events
- EventListener.registerAllEvents()
+ logger.info("Rocket plugin enabled")
+ EventListener.cacheEvents()
 
  // Enable the base Rocket methods and globals
  this.onAddonEnable()
@@ -86,4 +87,5 @@ open class Rocket : RocketAddon() {
  override fun onDisable() {
  logger.info("Rocket plugin disabled")
  }
+
 }

src/main/kotlin/dev/znci/rocket/commands/RocketCommand.kt

@@ -17,6 +17,7 @@ package dev.znci.rocket.commands
 
 import dev.znci.rocket.i18n.LocaleManager
 import dev.znci.rocket.scripting.ScriptManager
+import dev.znci.rocket.scripting.ScriptManager.disableFile
 import dev.znci.rocket.scripting.ScriptManager.scriptsFolder
 import org.bukkit.command.Command
 import org.bukkit.command.CommandSender
@@ -32,7 +33,8 @@ class RocketCommand(private val plugin: JavaPlugin) : TabExecutor {
  }
 
  val action = args[0].lowercase()
- val scriptName = if (!args[1].endsWith(".lua")) "${args[1]}.lua" else args[1]
+ val scriptName = args[1]
+ val rawScriptName = if (!scriptName.endsWith(".lua")) "${scriptName}.lua" else scriptName
 
  if (!scriptsFolder.exists() || !scriptsFolder.isDirectory) {
  sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.scripts_folder_not_found"))
@@ -41,7 +43,7 @@ class RocketCommand(private val plugin: JavaPlugin) : TabExecutor {
 
  when (action) {
  "reload" -> {
- if (scriptName.lowercase() == "config.lua") {
+ if (scriptName.lowercase() == "config") {
  plugin.reloadConfig()
 
  val defaultLocale = plugin.config.getString("locale", "en_GB").toString()
@@ -51,36 +53,49 @@ class RocketCommand(private val plugin: JavaPlugin) : TabExecutor {
 
  sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.config_reloaded"))
  return true
+ } else if (scriptName.lowercase() == "all") {
+ val results = ScriptManager.loadAll()
+ if (results.isNotEmpty()) {
+ results.forEach { error ->
+ sender.sendMessage(LocaleManager.getMessageAsComponent("generic_error", error ?: "Unknown error"))
+ }
+ }
+ return true
  }
 
- val scriptFile = File(scriptsFolder, scriptName)
+ val scriptFile = File(scriptsFolder, rawScriptName)
+
  if (!scriptFile.exists()) {
- sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_not_found", scriptName))
+ sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_not_found", rawScriptName))
  return true
  }
 
- val content = scriptFile.readText()
- val result = ScriptManager.runScript(content)
+ val result = ScriptManager.loadScript(scriptFile)
 
  if (result !== "") {
  sender.sendMessage(LocaleManager.getMessageAsComponent("generic_error", result ?: "Unknown error"))
  } else {
  sender.sendMessage(
  LocaleManager.getMessageAsComponent(
  "rocket_command.script_reloaded",
-scriptName
+rawScriptName
  )
  )
  }
  }
  "disable" -> {
- val scriptFile = File(scriptsFolder, scriptName)
+ val scriptFile = File(scriptsFolder, rawScriptName)
  if (!scriptFile.exists()) {
- sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_not_found", scriptName))
+ sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_not_found", rawScriptName))
  return true
  }
 
- sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_disabled", scriptName))
+ // TODO: Add disabling of file (with '-')
+ // For another PR though
+
+ disableFile(scriptFile)
+
+ sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.script_disabled", rawScriptName))
  }
  else -> {
  sender.sendMessage(LocaleManager.getMessageAsComponent("rocket_command.usage"))
@@ -99,9 +114,11 @@ class RocketCommand(private val plugin: JavaPlugin) : TabExecutor {
  if (args.size == 1) {
  return mutableListOf("reload", "disable")
  } else if (args.size == 2) {
- return if (args[0] == "reload") ScriptManager.getAllScripts().toMutableList()
- else if (args[0] == "disable") ScriptManager.getAllScripts(false).toMutableList()
- else null
+ val list: MutableList<String>? =
+ if (args[0] == "reload") ScriptManager.getAllScripts().toMutableList().also { it.add("config") }
+ else if (args[0] == "disable") ScriptManager.getAllScripts(false).toMutableList().also { it.add("config") }
+ else null
+ return list
  }
  return null
 

src/main/kotlin/dev/znci/rocket/scripting/ScriptManager.kt

@@ -22,6 +22,7 @@ import dev.znci.twine.TwineProperty
 import dev.znci.twine.TwineTable
 import dev.znci.twine.TwineValueBase
 import org.bukkit.event.Event
+import org.luaj.vm2.*
 import java.io.File
 import org.luaj.vm2.Globals
 import org.luaj.vm2.LuaError
@@ -45,11 +46,22 @@ object ScriptManager {
  */
  var scriptsFolder: File = File("")
 
+ /**
+ * A map of loaded scripts associated by file path
+ */
+ val loadedScriptFiles = mutableMapOf<String, MutableList<Function1<TwineTable, Unit>>>()
+
+ /**
+ * A map associating Lua event sections with a class.
+ * This mainly helps with disabling scripts
+ */
+ val eventScript = mutableMapOf<Function1<TwineTable, Unit>, Class<out Event>>()
+
  /**
  * A map of events and their associated Lua handlers.
  * It stores the events triggered in the system and the corresponding Lua functions that handle them.
  */
- val usedEvents = mutableMapOf<Class<out Event>, LuaValue>()
+ val usedEvents = mutableMapOf<Class<out Event>, MutableList<Function1<TwineTable, Unit>>>()
 
  /**
  * A map of enabled commands by their names.
@@ -69,7 +81,6 @@ object ScriptManager {
  *
  * @param folder The folder containing the Lua scripts.
  */
- @Suppress("unused") // TODO: Will be used in the future when custom configuration folders are implemented
  fun setFolder(folder: File) {
  scriptsFolder = folder
  }
@@ -78,12 +89,10 @@ object ScriptManager {
  * Loads all scripts from the `scriptsFolder` directory.
  * This method currently prints the content of the scripts, but is planned for future use when custom folder configurations are implemented.
  */
- @Suppress("unused") // TODO: Is this still required?
  fun loadScripts() {
  scriptsFolder.walkTopDown().forEach { file ->
  if (file.isFile && !file.startsWith("-")) {
- val content = file.readText()
- runScript(content)
+ runScript(file)
  }
  }
  }
@@ -106,21 +115,67 @@ object ScriptManager {
  return list
  }
 
+ /**
+ * Recursively loads all scripts located in the scripts folder
+ * @return A list of error messages where execution failed. The list will be empty if there were no errors
+ */
+ fun loadAll(): List<String?> {
+ val results = mutableListOf<String?>()
+ getAllScripts(false).forEach { script ->
+ val result = loadScript(File("plugins/rocket/scripts/", script))
+ if (result != "")
+ results.add(result)
+ }
+ return results
+ }
+
+ /**
+ * Loads a script based off of a [File] object
+ *
+ * @param scriptFile The script to load
+ * @return An error message if execution fails, or an empty string if the script ran successfully.
+ */
+ fun loadScript(scriptFile: File): String? {
+ if (loadedScriptFiles[scriptFile.absolutePath] != null) {
+ disableFile(scriptFile)
+ }
+ val result = runScript(scriptFile)
+ return result
+ }
+
+ /**
+ * Disables a script based off of a [File] object
+ * @param scriptFile The script to disable
+ */
+ fun disableFile(scriptFile: File) {
+ val functions = loadedScriptFiles[scriptFile.absolutePath]!!
+ for (function in functions) {
+ val eventClass = eventScript[function]!!
+ for (eventCallback in usedEvents[eventClass]?:continue) {
+ if (eventCallback == function) usedEvents.remove(eventClass)
+ }
+ eventScript.remove(function)
+ }
+ }
+
  /**
  * Runs a Lua script provided as a string.
  * The script is executed within the global Lua environment, and any errors are caught and returned as a string message.
  *
- * @param text The Lua script content to execute.
+ * @param scriptFile The Lua script content to execute.
  * @return An error message if execution fails, or an empty string if the script ran successfully.
  */
- fun runScript(text: String): String? {
+ fun runScript(scriptFile: File): String? {
+
+ val content = scriptFile.readText()
+
  try {
  applyGlobals()
-val scriptResult = globals.load(text, "script", globals)
+val scriptResult = globals.load(content, "::${scriptFile.absolutePath}::", globals)
 
  scriptResult.call()
- } catch (e: LuaError) {
- return e.message
+ } catch (error: LuaError) {
+ return error.message
  }
 
  return ""