Record Class ScriptSource

java.lang.Object
java.lang.Record
de.luckymcdev.foundryengine.script.common.definition.ScriptSource
Record Components:
className - the file name without extension, also the expected entrypoint class name
path - the real (symlink-resolved) path, guaranteed to be inside the bundle's script root
env - the environment directory the file lives in
public record ScriptSource(String className, Path path, ScriptEnv env) extends Record
One script file of a bundle.

  • Constructor Details

    • ScriptSource

      public ScriptSource(String className, Path path, ScriptEnv env)
      Creates an instance of a ScriptSource record class.
      Parameters:
      className - the value for the className record component
      path - the value for the path record component
      env - the value for the env 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.

    • className

      public String className()
      Returns the value of the className record component.
      Returns:
      the value of the className record component

    • path

      public Path path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • env

      public ScriptEnv env()
      Returns the value of the env record component.
      Returns:
      the value of the env record component