Package net.fabricmc.fabric.api.client.particle.v1

Interface FabricSpriteProvider

All Superinterfaces:
net.minecraft.client.particle.SpriteProvider
public interface FabricSpriteProvider extends net.minecraft.client.particle.SpriteProvider
FabricSpriteProvider. It does the same thing as vanilla's SpriteProvider, but in a way that's accessible to mods, and that exposes the atlas as well.

Custom sprites registered using ParticleFactoryRegistry have the options to supply a particle factory which will recieve an instance of this interface containing the sprites set loaded for their particle from the active resourcepacks.

See Also:
ParticleFactoryRegistry.register(ParticleType, ParticleFactory), ParticleFactoryRegistry.PendingParticleFactory

  • Method Summary

    Modifier and Type
    Method
    Description
    net.minecraft.client.texture.SpriteAtlasTexture
    getAtlas()
    Returns the entire particles texture atlas.
    List<net.minecraft.client.texture.Sprite>
    getSprites()
    Gets the list of all sprites available for this particle to use.

    Methods inherited from interface net.minecraft.client.particle.SpriteProvider

    getSprite, getSprite

  • Method Details

    • getAtlas

      net.minecraft.client.texture.SpriteAtlasTexture getAtlas()
      Returns the entire particles texture atlas.

    • getSprites

      List<net.minecraft.client.texture.Sprite> getSprites()
      Gets the list of all sprites available for this particle to use. This is defined in your resourcepack.