Package com.blamejared.crafttweaker.api.zencode.scriptrun

Interface IScriptRunInfo

All Known Subinterfaces:
IMutableScriptRunInfo
public interface IScriptRunInfo
Gives information relative to a specific IScriptRun.
Since:
9.1.0

  • Method Details

    • configuration

      ScriptRunConfiguration configuration()
      Obtains the configuration used to execute the script run.
      Returns:
      The configuration used to execute the script run.
      Since:
      9.1.0

    • appliedActions

      List<IAction> appliedActions()
      Gets a list of all IActions that have been applied during this run.

      The returned list is not modifiable and acts as a simple log.

      Returns:
      A list containing all applied actions.
      Since:
      9.1.0

    • invalidActions

      List<IAction> invalidActions()
      Gets a list of all IActions that could not have been applied due to them being invalid.

      The returned list is not modifiable and acts as a simple log.

      Returns:
      A list containing all invalid actions.
      Since:
      9.1.0

    • displayBranding

      boolean displayBranding()
      Indicates whether a branding message should be printed to the logs during the script run.

      The branding message acts as a referral to CraftTweaker's Patreon.

      Returns:
      Whether a branding message should be printed.
      Since:
      9.1.0

    • dumpClasses

      boolean dumpClasses()
      Indicates whether the generated classes should be dumped for debugging purposes.
      Returns:
      Whether the generated classes should be dumped.
      Since:
      9.1.0

    • isFirstRun

      boolean isFirstRun()
      Indicates whether the targeted run will be or has been the first for the targeted loader.
      Returns:
      Whether this was a first run or not.
      Since:
      9.1.0

    • loader

      default IScriptLoader loader()
      Gets the IScriptLoader that will be used to execute this script run.
      Returns:
      The loader used to execute this script run.
      Since:
      9.1.0

    • loadSource

      default IScriptLoadSource loadSource()
      Gets the IScriptLoadSource that is responsible for this script run.
      Returns:
      The load source responsible for this run.
      Since:
      9.1.0