net.minecraftforge.common.data.JsonCodecProvider<List<SpriteSource>>

net.minecraftforge.common.data.SpriteSourceProvider

All Implemented Interfaces:: DataProvider

Direct Known Subclasses:: ForgeSpriteSourceProvider

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 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<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.minecraftforge.common.data.JsonCodecProvider
codec, conditions, directory, dynamicOps, entries, existingFileHelper, modid, output, packType

Fields inherited from interface net.minecraft.data.DataProvider
FIXED_ORDER_FIELDS, KEY_COMPARATOR
Constructor Summary

Constructors

Constructor

Description

SpriteSourceProvider(PackOutput output, ExistingFileHelper fileHelper, String modid)
Method Summary

Modifier and Type

Method

Description

protected abstract void

addSources()

protected final SpriteSourceProvider.SourceList

atlas(ResourceLocation atlas)

Get or create a SpriteSourceProvider.SourceList for the given atlas

protected final void

gather(BiConsumer<ResourceLocation,List<SpriteSource>> consumer)

Methods inherited from class net.minecraftforge.common.data.JsonCodecProvider
getName, run, setConditions

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, ExistingFileHelper fileHelper, String modid)
Method Details
- gather
  
  protected final void gather(BiConsumer<ResourceLocation,List<SpriteSource>> consumer)
  
  Overrides:
  
  gather in class JsonCodecProvider<List<SpriteSource>>
- addSources
  
  protected abstract void addSources()
- atlas
  
  protected final SpriteSourceProvider.SourceList atlas(ResourceLocation atlas)
  
  Get or create a SpriteSourceProvider.SourceList for the given atlas
  
  Parameters:
  
  atlas - 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

Class SpriteSourceProvider

Nested Class Summary

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

Field Summary

Fields inherited from class net.minecraftforge.common.data.JsonCodecProvider

Fields inherited from interface net.minecraft.data.DataProvider

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.common.data.JsonCodecProvider

Methods inherited from class java.lang.Object

Field Details

BLOCKS_ATLAS

BANNER_PATTERNS_ATLAS

BEDS_ATLAS

CHESTS_ATLAS

SHIELD_PATTERNS_ATLAS

SHULKER_BOXES_ATLAS

SIGNS_ATLAS

MOB_EFFECTS_ATLAS

PAINTINGS_ATLAS

PARTICLES_ATLAS

atlases

Constructor Details

SpriteSourceProvider

Method Details

gather

addSources

atlas