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

Record Class ScriptRunConfiguration

java.lang.Object
java.lang.Record
com.blamejared.crafttweaker.api.zencode.scriptrun.ScriptRunConfiguration
Record Components:
loader - The IScriptLoader that will be used to execute the run.
loadSource - The IScriptLoadSource responsible for creating the run.
runKind - The kind of run that will be executed.
public record ScriptRunConfiguration(IScriptLoader loader, IScriptLoadSource loadSource, ScriptRunConfiguration.RunKind runKind) extends Record
Holds information relative to the configuration for a specific IScriptRun.
Since:
9.1.0

  • Constructor Details

    • ScriptRunConfiguration

      public ScriptRunConfiguration(String loader, net.minecraft.resources.ResourceLocation loadSource, ScriptRunConfiguration.RunKind runKind)
      Creates a ScriptRunConfiguration with the given info, performing lookups if necessary.
      Parameters:
      loader - The name of the loader that will be used to execute the run.
      loadSource - The ResourceLocation identifying the load source responsible for creating the run.
      runKind - The kind of run that will be executed.
      Throws:
      IllegalArgumentException - If the loader or the load source are not registered.
      Since:
      9.1.0

    • ScriptRunConfiguration

      public ScriptRunConfiguration(IScriptLoader loader, IScriptLoadSource loadSource, ScriptRunConfiguration.RunKind runKind)
      Creates an instance of a ScriptRunConfiguration record class.
      Parameters:
      loader - the value for the loader record component
      loadSource - the value for the loadSource record component
      runKind - the value for the runKind record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • loader

      public IScriptLoader loader()
      Returns the value of the loader record component.
      Returns:
      the value of the loader record component

    • loadSource

      public IScriptLoadSource loadSource()
      Returns the value of the loadSource record component.
      Returns:
      the value of the loadSource record component

    • runKind

      public ScriptRunConfiguration.RunKind runKind()
      Returns the value of the runKind record component.
      Returns:
      the value of the runKind record component