Package net.neoforged.neoforge.common.data

Class SpriteSourceProvider

java.lang.Object

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

net.neoforged.neoforge.common.data.SpriteSourceProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

NeoForgeSpriteSourceProvider

public abstract class SpriteSourceProvider
extends JsonCodecProvider<List<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 this class for the atlases used in vanilla Minecraft

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	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<ResourceLocation,SpriteSourceProvider.SourceList>	atlases
protected static final ResourceLocation	BANNER_PATTERNS_ATLAS
protected static final ResourceLocation	BEDS_ATLAS
protected static final ResourceLocation	BLOCKS_ATLAS
protected static final ResourceLocation	CHESTS_ATLAS
protected static final ResourceLocation	MOB_EFFECTS_ATLAS
protected static final ResourceLocation	PAINTINGS_ATLAS
protected static final ResourceLocation	PARTICLES_ATLAS
protected static final ResourceLocation	SHIELD_PATTERNS_ATLAS
protected static final ResourceLocation	SHULKER_BOXES_ATLAS
protected static final ResourceLocation	SIGNS_ATLAS

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

codec, conditions, directory, existingFileHelper, lookupProvider, modid, pathProvider, resourceType

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, KEY_COMPARATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected final SpriteSourceProvider.SourceList	atlas(ResourceLocation 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

BLOCKS_ATLAS

protected static final ResourceLocation BLOCKS_ATLAS

BANNER_PATTERNS_ATLAS

protected static final ResourceLocation BANNER_PATTERNS_ATLAS

BEDS_ATLAS

protected static final ResourceLocation BEDS_ATLAS

CHESTS_ATLAS

protected static final ResourceLocation CHESTS_ATLAS

SHIELD_PATTERNS_ATLAS

protected static final ResourceLocation SHIELD_PATTERNS_ATLAS

SHULKER_BOXES_ATLAS

protected static final ResourceLocation SHULKER_BOXES_ATLAS

SIGNS_ATLAS

protected static final ResourceLocation SIGNS_ATLAS

MOB_EFFECTS_ATLAS

protected static final ResourceLocation MOB_EFFECTS_ATLAS

PAINTINGS_ATLAS

protected static final ResourceLocation PAINTINGS_ATLAS

PARTICLES_ATLAS

protected static final ResourceLocation PARTICLES_ATLAS

atlases

private final Map<ResourceLocation,SpriteSourceProvider.SourceList> atlases

Constructor Details

SpriteSourceProvider

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

Method Details

atlas

protected final SpriteSourceProvider.SourceList atlas(ResourceLocation 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