程序包 net.minecraftforge.common.data

类 ParticleDescriptionProvider

java.lang.Object

net.minecraftforge.common.data.ParticleDescriptionProvider

所有已实现的接口:

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 or sprite set.

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

     // Multiple sprites
     this.spriteSet(ParticleTypes.CLOUD, new ResourceLocation("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 or sprite set consumer.

另请参阅:

• DataProvider
• ParticleDescription

嵌套类概要

从接口继承的嵌套类/接口 net.minecraft.data.DataProvider

DataProvider.Factory<T extends DataProvider>

字段概要

字段

修饰符和类型	字段	说明
protected final Map<ResourceLocation,List<String>>	descriptions
protected final ExistingFileHelper	fileHelper
private final PackOutput.PathProvider	particlesPath

从接口继承的字段 net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, KEY_COMPARATOR, LOGGER

构造器概要

构造器

限定符	构造器	说明
protected	ParticleDescriptionProvider(PackOutput output, ExistingFileHelper fileHelper)	Creates an instance of the data provider.

方法概要

修饰符和类型	方法	说明
protected abstract void	addDescriptions()	Registers the particle descriptions generated by sprite(ParticleType, ResourceLocation) or one of the sprite set methods.
String	getName()
CompletableFuture<?>	run(CachedOutput cache)
protected void	sprite(ParticleType<?> type, ResourceLocation texture)	Creates a new particle description that contains a single texture for the associated ParticleType.
protected void	spriteSet(ParticleType<?> type, Iterable<ResourceLocation> textures)	Creates a new particle description that contains multiple textures for the associated ParticleType.
protected void	spriteSet(ParticleType<?> type, ResourceLocation baseName, int numOfTextures, boolean reverse)	Creates a new particle description that contains multiple textures for the associated ParticleType.
protected void	spriteSet(ParticleType<?> type, ResourceLocation texture, ResourceLocation... textures)	Creates a new particle description that contains multiple textures for the associated ParticleType.

从类继承的方法 java.lang.Object

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

字段详细资料

particlesPath

private final PackOutput.PathProvider particlesPath

fileHelper

@VisibleForTesting
protected final ExistingFileHelper fileHelper

descriptions

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

构造器详细资料

ParticleDescriptionProvider

protected ParticleDescriptionProvider(PackOutput output,
 ExistingFileHelper fileHelper)

Creates an instance of the data provider.

参数:

output - the expected root directory the data generator outputs to

fileHelper - the helper used to validate a texture's existence

方法详细资料

addDescriptions

protected abstract void addDescriptions()

Registers the particle descriptions generated by sprite(ParticleType, ResourceLocation) or one of the sprite set methods.

sprite

protected void sprite(ParticleType<?> type,
 ResourceLocation texture)

Creates a new particle description that contains a single texture for the associated ParticleType.

Particle types with this description should be attached to a particle provider via RegisterParticleProvidersEvent.registerSprite(ParticleType, ParticleProvider.Sprite).

参数:

type - the particle type the textures are applied for

texture - the texture to render for the particle type

抛出:

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,
 ResourceLocation 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, ParticleEngine.SpriteParticleRegistration).

参数:

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

抛出:

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,
 ResourceLocation texture,
 ResourceLocation... 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, ParticleEngine.SpriteParticleRegistration).

参数:

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

抛出:

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<ResourceLocation> 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, ParticleEngine.SpriteParticleRegistration).

参数:

type - the particle type the textures are applied for

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

抛出:

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)

指定者:

run 在接口中 DataProvider

getName

public String getName()

指定者:

getName 在接口中 DataProvider