net.minecraft.server.packs.AbstractPackResources

net.minecraftforge.resource.PathPackResources

All Implemented Interfaces:: AutoCloseable, PackResources, IForgePackResources

public class PathPackResources extends AbstractPackResources

Defines a resource pack from an arbitrary Path.

This is primarily intended to support including optional resource packs inside a mod, such as to have alternative textures to use along with Programmer Art, or optional alternative recipes for compatibility ot to replace vanilla recipes.

Field Summary

Fields

Modifier and Type

Field

Description

private final ResourceCacheManager

cacheManager

private final String

packName

private final Path

source

Fields inherited from class net.minecraft.server.packs.AbstractPackResources
file

Fields inherited from interface net.minecraft.server.packs.PackResources
METADATA_EXTENSION, PACK_META
Constructor Summary

Constructors

Constructor

Description

PathPackResources(String packName, Path source)

Constructs a java.nio.Path-based resource pack.
Method Summary

Modifier and Type

Method

Description

void

close()

String

getName()

Returns the identifying name for the pack.

Set<String>

getNamespaces(PackType type)

private @NotNull Set<String>

getNamespacesFromDisk(PackType type)

protected InputStream

getResource(String name)

InputStream

getResource(PackType type, ResourceLocation location)

Collection<ResourceLocation>

getResources(PackType type, String resourceNamespace, String pathIn, Predicate<ResourceLocation> filter)

Path

getSource()

Returns the source path containing the resource pack.

protected boolean

hasResource(String name)

boolean

hasResource(PackType type, ResourceLocation location)

void

init(PackType packType)

void

initForNamespace(String namespace)

protected Path

resolve(String... paths)

Implement to return a file or folder path for the given set of path components.

String

toString()

Methods inherited from class net.minecraft.server.packs.AbstractPackResources
getMetadataFromStream, getMetadataSection, getRelativePath, getRootResource, logWarning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.extensions.IForgePackResources
isHidden

Field Details
- source
  
  private final Path source
- packName
  
  private final String packName
- cacheManager
  
  private final ResourceCacheManager cacheManager
Constructor Details
- PathPackResources
  
  public PathPackResources(String packName, Path source)
  
  Constructs a java.nio.Path-based resource pack.
  
  Parameters:
  
  packName - the identifying name of the pack. This name should be unique within the pack finder, preferably the name of the file or folder containing the resources.
  
  source - the root path of the pack. This needs to point to the folder that contains "assets" and/or "data", not the asset folder itself!
Method Details
- initForNamespace
  
  public void initForNamespace(String namespace)
- init
  
  public void init(PackType packType)
- getSource
  
  public Path getSource()
  
  Returns the source path containing the resource pack. This is used for error display.
  
  Returns:
  
  the root path of the resources.
- getName
  
  public String getName()
  
  Returns the identifying name for the pack.
  
  Specified by:
  
  getName in interface PackResources
  
  Overrides:
  
  getName in class AbstractPackResources
  
  Returns:
  
  the identifier of the pack.
- resolve
  
  protected Path resolve(String... paths)
  
  Implement to return a file or folder path for the given set of path components.
  
  Parameters:
  
  paths - One or more path strings to resolve. Can include slash-separated paths.
  
  Returns:
  
  the resulting path, which may not exist.
- getResource
  
  protected InputStream getResource(String name) throws IOException
  
  Specified by:
  
  getResource in class AbstractPackResources
  
  Throws:
  
  IOException
- hasResource
  
  protected boolean hasResource(String name)
  
  Specified by:
  
  hasResource in class AbstractPackResources
- getResources
  
  public Collection<ResourceLocation> getResources(PackType type, String resourceNamespace, String pathIn, Predicate<ResourceLocation> filter)
- getNamespaces
  
  public Set<String> getNamespaces(PackType type)
- getNamespacesFromDisk
  
  @NotNull private @NotNull Set<String> getNamespacesFromDisk(PackType type)
- getResource
  
  public InputStream getResource(PackType type, ResourceLocation location) throws IOException
  
  Specified by:
  
  getResource in interface PackResources
  
  Overrides:
  
  getResource in class AbstractPackResources
  
  Throws:
  
  IOException
- hasResource
  
  public boolean hasResource(PackType type, ResourceLocation location)
  
  Specified by:
  
  hasResource in interface PackResources
  
  Overrides:
  
  hasResource in class AbstractPackResources
- close
  
  public void close()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class AbstractPackResources

Class PathPackResources

Field Summary

Fields inherited from class net.minecraft.server.packs.AbstractPackResources

Fields inherited from interface net.minecraft.server.packs.PackResources

Constructor Summary

Method Summary

Methods inherited from class net.minecraft.server.packs.AbstractPackResources

Methods inherited from class java.lang.Object

Methods inherited from interface net.minecraftforge.common.extensions.IForgePackResources

Field Details

source

packName

cacheManager

Constructor Details

PathPackResources

Method Details

initForNamespace

init

getSource

getName

resolve

getResource

hasResource

getResources

getNamespaces

getNamespacesFromDisk

getResource

hasResource

close

toString