Interface ScriptedPlugin

  • All Known Implementing Classes:
    DefaultScriptedPlugin

    public interface ScriptedPlugin
    This interface is implemented by plug-ins that operate by executing scripts.
    Author:
    Chris Jennings
    • Method Detail

      • getScriptFile

        java.lang.String getScriptFile()
        Return the name of the script file the plug-in executes; this might not be an actual path depending on the script's origin.
        Returns:
        the script's file identifier
      • getScriptMonkey

        ScriptMonkey getScriptMonkey()
        Returns the ScriptMonkey for the script being run by the plug-in. This encapsulates the script's execution context. If the plug-in creates contexts dynamically as it runs scripts, the plug-in may return null if it is not currently executing a script.
        Returns:
        the monkey for this plug-in's script