Package net.neoforged.neoforge.client.data

Class SpriteSourceProvider

java.lang.Object

net.neoforged.neoforge.common.data.JsonCodecProvider<List<Optional<WithConditions<SpriteSource>>>>

net.neoforged.neoforge.client.data.SpriteSourceProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

NeoForgeSpriteSourceProvider

public abstract class SpriteSourceProvider
extends JsonCodecProvider<List<Optional<WithConditions<SpriteSource>>>>

Data provider for atlas configuration files.
An atlas configuration is bound to a specific texture atlas such as the minecraft:blocks atlas and allows adding additional textures to the atlas by adding SpriteSources to the configuration.

See SpriteSources for the available sources and the constants in AtlasIds for the atlases used in vanilla Minecraft

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	SpriteSourceProvider.SourceList

Nested classes/interfaces inherited from interface net.minecraft.data.DataProvider

DataProvider.Factory<T extends DataProvider>

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<Identifier,SpriteSourceProvider.SourceList>	atlases
private static final com.mojang.serialization.Codec<List<Optional<WithConditions<SpriteSource>>>>	CODEC

Fields inherited from class net.neoforged.neoforge.common.data.JsonCodecProvider

codec, conditions, directory, lookupProvider, modid, pathProvider

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, INDENT_WIDTH, KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
SpriteSourceProvider(PackOutput output, CompletableFuture<HolderLookup.Provider> lookupProvider, String modId)

Method Summary

Modifier and Type	Method	Description
protected final SpriteSourceProvider.SourceList	atlas(Identifier id)	Get or create a SpriteSourceProvider.SourceList for the given atlas

Methods inherited from class net.neoforged.neoforge.common.data.JsonCodecProvider

conditionally, gather, getName, run, unconditional

Methods inherited from class java.lang.Object

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

Field Details

CODEC

private static final com.mojang.serialization.Codec<List<Optional<WithConditions<SpriteSource>>>> CODEC

atlases

private final Map<Identifier,SpriteSourceProvider.SourceList> atlases

Constructor Details

SpriteSourceProvider

public SpriteSourceProvider(PackOutput output,
 CompletableFuture<HolderLookup.Provider> lookupProvider,
 String modId)

Method Details

atlas

protected final SpriteSourceProvider.SourceList atlas(Identifier id)

Get or create a SpriteSourceProvider.SourceList for the given atlas

Parameters:

id - The texture atlas the sources should be added to, see constants at the top for the format and the vanilla atlases

Returns:

an existing SourceList for the given atlas or a new one if not present yet