net.minecraftforge.client.extensions

Interface IForgeTextureAtlasSprite

All Known Implementing Classes:

MissingTextureSprite, TextureAtlasSprite

public interface IForgeTextureAtlasSprite

Method Summary

Modifier and Type	Method and Description
default java.util.Collection<ResourceLocation>	getDependencies()
default boolean	hasCustomLoader(IResourceManager manager, ResourceLocation location) The result of this function determines is the below 'load' function is called, and the default vanilla loading code is bypassed completely.
default boolean	load(IResourceManager manager, ResourceLocation location, java.util.function.Function<ResourceLocation,TextureAtlasSprite> textureGetter) Load the specified resource as this sprite's data.

Method Detail

hasCustomLoader

default boolean hasCustomLoader(IResourceManager manager,
                                ResourceLocation location)

The result of this function determines is the below 'load' function is called, and the default vanilla loading code is bypassed completely.

Parameters:

manager - Main resource manager

location - File resource location

Returns:

True to use your own custom load code and bypass vanilla loading.

load

default boolean load(IResourceManager manager,
                     ResourceLocation location,
                     java.util.function.Function<ResourceLocation,TextureAtlasSprite> textureGetter)

Load the specified resource as this sprite's data. Returning false from this function will prevent this icon from being stitched onto the master texture.

Parameters:

manager - Main resource manager

location - File resource location

textureGetter - accessor for dependencies. All of them will be loaded before this one

Returns:

False to prevent this Icon from being stitched

getDependencies

default java.util.Collection<ResourceLocation> getDependencies()

Returns:

all textures that should be loaded before this texture.