Record Class NamespacedDirectoryLister

java.lang.Object
java.lang.Record
net.neoforged.neoforge.client.textures.NamespacedDirectoryLister
All Implemented Interfaces:
SpriteSource

public record NamespacedDirectoryLister(String namespace, String sourcePath, String idPrefix) extends Record implements SpriteSource
Namespace-aware version of DirectoryLister. This version should be preferred when several textures from high-traffic directories should be stitched to an atlas without adding assets from other mods that should not be stitched to this atlas
  • Field Details

    • namespace

      private final String namespace
      The field for the namespace record component.
    • sourcePath

      private final String sourcePath
      The field for the sourcePath record component.
    • idPrefix

      private final String idPrefix
      The field for the idPrefix record component.
    • CODEC

      private static final com.mojang.serialization.MapCodec<NamespacedDirectoryLister> CODEC
    • ID

      public static final ResourceLocation ID
    • TYPE

      public static final SpriteSourceType TYPE
  • Constructor Details

    • NamespacedDirectoryLister

      public NamespacedDirectoryLister(String namespace, String sourcePath, String idPrefix)
      Creates an instance of a NamespacedDirectoryLister record class.
      Parameters:
      namespace - the value for the namespace record component
      sourcePath - the value for the sourcePath record component
      idPrefix - the value for the idPrefix record component
  • Method Details

    • run

      public void run(ResourceManager resourceManager, SpriteSource.Output output)
      Specified by:
      run in interface SpriteSource
    • type

      public SpriteSourceType type()
      Specified by:
      type in interface SpriteSource
    • 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.
    • namespace

      public String namespace()
      Returns the value of the namespace record component.
      Returns:
      the value of the namespace record component
    • sourcePath

      public String sourcePath()
      Returns the value of the sourcePath record component.
      Returns:
      the value of the sourcePath record component
    • idPrefix

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