Package net.minecraft.modding.api.game.client.resources

Class PathResourcePack

java.lang.Object

net.minecraft.modding.api.game.client.resources.ResourcePack

net.minecraft.modding.api.game.client.resources.PathResourcePack

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class PathResourcePack
extends ResourcePack

Field Summary

Fields

Modifier and Type	Field	Description
static ResourceLocation	DESCRIPTION
static ResourceLocation	THUMBNAIL

Constructor Summary

Constructors

Constructor	Description
PathResourcePack(java.nio.file.Path rootPath)
PathResourcePack(java.nio.file.Path rootPath, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
java.util.stream.Stream<Resource>	findResources(@Nullable java.lang.String namespace, java.lang.String directory, java.lang.String extension)	Finds all Resources that match the given query.
java.lang.String	getDescription()
java.lang.String	getName()
java.util.Optional<Resource>	getResource(ResourceLocation location)	Returns a Resource that exists at the given location.
java.util.stream.Stream<Resource>	getResources(java.lang.String path)	Returns all Resources that are at the given path, regardless of namespace.
java.util.stream.Stream<Resource>	getResources(ResourceLocation location)	Returns all Resources that match the given location.
java.nio.file.Path	getRootPath()
byte @Nullable []	getThumbnail()
boolean	isLegacyTexturePack()	Signals whether callers should search for assets in legacy locations.

Methods inherited from class net.minecraft.modding.api.game.client.resources.ResourcePack

close

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DESCRIPTION

public static final ResourceLocation DESCRIPTION

THUMBNAIL

public static final ResourceLocation THUMBNAIL

Constructor Detail

PathResourcePack

public PathResourcePack(java.nio.file.Path rootPath)

PathResourcePack

public PathResourcePack(java.nio.file.Path rootPath,
                        java.lang.String name)

Method Detail

getRootPath

public java.nio.file.Path getRootPath()

getName

public java.lang.String getName()

Specified by:

getName in class ResourcePack

getDescription

public java.lang.String getDescription()

Overrides:

getDescription in class ResourcePack

getThumbnail

public byte @Nullable [] getThumbnail()

Overrides:

getThumbnail in class ResourcePack

isLegacyTexturePack

public boolean isLegacyTexturePack()

Description copied from class: ResourcePack

Signals whether callers should search for assets in legacy locations.

Overrides:

isLegacyTexturePack in class ResourcePack

Returns:

If this ResourcePack represents a legacy texture pack format.

getResources

public java.util.stream.Stream<Resource> getResources(ResourceLocation location)

Description copied from class: ResourcePack

Returns all Resources that match the given location. An empty namespace will search outside the assets/ dir. This may return multiple resources in the case of a MultiResourcePack.

Overrides:

getResources in class ResourcePack

Parameters:

location - The exact location of the resources.

Returns:

A stream that iterates over the Resources.

getResource

public java.util.Optional<Resource> getResource(ResourceLocation location)

Description copied from class: ResourcePack

Returns a Resource that exists at the given location. An empty namespace will search outside the assets/ dir.

Specified by:

getResource in class ResourcePack

Parameters:

location - The exact location of the resource.

Returns:

A present optional if the resource exists, Optional.empty() otherwise.

getResources

public java.util.stream.Stream<Resource> getResources(java.lang.String path)

Description copied from class: ResourcePack

Returns all Resources that are at the given path, regardless of namespace. This includes the empty namespace only if ResourcePack.isLegacyTexturePack() returns true.

Specified by:

getResources in class ResourcePack

Parameters:

path - The path to search at. All namespaces will be checked.

Returns:

A stream that iterates over the Resources.

findResources

public java.util.stream.Stream<Resource> findResources(@Nullable
                                                       @Nullable java.lang.String namespace,
                                                       java.lang.String directory,
                                                       java.lang.String extension)

Description copied from class: ResourcePack

Finds all Resources that match the given query. Unlike ResourcePack.getResources(ResourceLocation), this will only return the first occurrence of a resource in the case of a MultiResourcePack.

Specified by:

findResources in class ResourcePack

Parameters:

namespace - null to search all namespaces. A specific namespace to search otherwise.

directory - The directory to search through. End with /** to search recursively.

extension - The extension to require files to end with. Should be prefixed with a dot (e.g. ".json"). Use "" to ignore file extension.

Returns:

A stream that iterates over all the found Resources.