Class ParticleDescriptionProvider

java.lang.Object

net.neoforged.neoforge.client.data.ParticleDescriptionProvider

All Implemented Interfaces:

DataProvider

public abstract class ParticleDescriptionProvider
extends Object
implements DataProvider

A data provider for ParticleDescriptions.

To use this provider, extend this class and implement addDescriptions(). Then, register an instance using DataGenerator.addProvider(boolean, Factory) via the GatherDataEvent on the mod event bus.

A description can be added to a ParticleType which uses a sprite set.

@Override
protected void addDescriptions() {
    // Single sprite
    this.sprite(ParticleTypes.DRIPPING_LAVA, Identifier.withDefaultNamespace("drip_hang"));

    // Multiple sprites
    this.spriteSet(ParticleTypes.CLOUD, Identifier.withDefaultNamespace("generic"), 8, true);
}

A particle description holds a list of textures used when rendering the particle to the screen. All registered particle descriptions are stitched together into a texture atlas called TextureAtlas.LOCATION_PARTICLES. A ParticleType whose particle uses the texture atlas, typically via the ParticleRenderType, can then reference the necessary texture during rendering.

Particles with a particle description must have their particle providers attached to a ParticleType as a sprite set consumer.

See Also:

• DataProvider
• ParticleDescription

Nested Class Summary

Nested classes/interfaces inherited from interface DataProvider

DataProvider.Factory<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Identifier, List<String>>	descriptions
private final PackOutput.PathProvider	particlesPath

Fields inherited from interface DataProvider

FIXED_ORDER_FIELDS, INDENT_WIDTH, KEY_COMPARATOR, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParticleDescriptionProvider(PackOutput output)	Creates an instance of the data provider.

Method Summary

Modifier and Type	Method	Description
protected abstract void	addDescriptions()	Registers the particle descriptions generated by one of the sprite set methods.
String	getName()
CompletableFuture<?>	run(CachedOutput cache)
protected void	spriteSet(ParticleType<?> type, Iterable<Identifier> textures)	Creates a new particle description that contains multiple textures for the associated ParticleType.
protected void	spriteSet(ParticleType<?> type, Identifier baseName, int numOfTextures, boolean reverse)	Creates a new particle description that contains multiple textures for the associated ParticleType.
protected void	spriteSet(ParticleType<?> type, Identifier texture, Identifier... textures)	Creates a new particle description that contains multiple textures for the associated ParticleType.

Methods inherited from class Object

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

Field Details

particlesPath

private final PackOutput.PathProvider particlesPath

descriptions

@VisibleForTesting
protected final Map<Identifier, List<String>> descriptions

Constructor Details

ParticleDescriptionProvider

protected ParticleDescriptionProvider(PackOutput output)

Creates an instance of the data provider.

Parameters:

output - the expected root directory the data generator outputs to

Method Details

addDescriptions

protected abstract void addDescriptions()

Registers the particle descriptions generated by one of the sprite set methods.

spriteSet

protected void spriteSet(ParticleType<?> type,
 Identifier baseName,
 int numOfTextures,
 boolean reverse)

Creates a new particle description that contains multiple textures for the associated ParticleType. The textures are generated from a common name and appended with a number representing the state of the animation.

minecraft:generic_0
minecraft:generic_1
minecraft:generic_2
// ...

Particle types with this description should be attached to a particle provider via RegisterParticleProvidersEvent.registerSpriteSet(ParticleType, ParticleResources.SpriteParticleRegistration).

Parameters:

type - the particle type the textures are applied for

baseName - the common name of all the textures

numOfTextures - the number of textures within the set

reverse - when true, the textures will be listed in descending order

Throws:

NullPointerException - if the particle type is not registered

IllegalArgumentException - if a texture does not have an associated PNG file, or the particle type has already been provided

spriteSet

protected void spriteSet(ParticleType<?> type,
 Identifier texture,
 Identifier... textures)

Creates a new particle description that contains multiple textures for the associated ParticleType. The textures are passed as varargs with at least one texture present.

Particle types with this description should be attached to a particle provider via RegisterParticleProvidersEvent.registerSpriteSet(ParticleType, ParticleResources.SpriteParticleRegistration).

Parameters:

type - the particle type the textures are applied for

texture - the first texture in the description

textures - a list of subsequent textures to render for the particle type

Throws:

NullPointerException - if the particle type is not registered

IllegalArgumentException - if a texture does not have an associated PNG file, or the particle type has already been provided

spriteSet

protected void spriteSet(ParticleType<?> type,
 Iterable<Identifier> textures)

Creates a new particle description that contains multiple textures for the associated ParticleType. The textures are passed as an iterable.

Particle types with this description should be attached to a particle provider via RegisterParticleProvidersEvent.registerSpriteSet(ParticleType, ParticleResources.SpriteParticleRegistration).

Parameters:

type - the particle type the textures are applied for

textures - a list of textures to render for the particle type

Throws:

NullPointerException - if the particle type is not registered

IllegalArgumentException - if there are no textures provided, a texture does not have an associated PNG file, or the particle type has already been provided

run

public CompletableFuture<?> run(CachedOutput cache)

Specified by:

run in interface DataProvider

getName

public String getName()

Specified by:

getName in interface DataProvider