Package net.neoforged.neoforge.client.event

Class RegisterTextureAtlasesEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterTextureAtlasesEvent

All Implemented Interfaces:

IModBusEvent

public class RegisterTextureAtlasesEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Fired for registering texture atlases to the AtlasManager.

This event fires during startup when the AtlasManager is constructed.

This event is not cancellable.

This event is fired on the mod-specific event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final SequencedMap<Identifier,AtlasManager.AtlasConfig>	atlases

Constructor Summary

Constructors

Constructor	Description
RegisterTextureAtlasesEvent(SequencedMap<Identifier,AtlasManager.AtlasConfig> atlases)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalMetadata(Identifier atlasId, MetadataSectionType<?> metaSectionType)	Add an additional MetadataSectionType to be loaded for the sprites of the given texture atlas.
void	register(AtlasManager.AtlasConfig atlasConfig)	Register a texture atlas with the given configuration

Methods inherited from class java.lang.Object

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

Field Details

atlases

private final SequencedMap<Identifier,AtlasManager.AtlasConfig> atlases

Constructor Details

RegisterTextureAtlasesEvent

@Internal
public RegisterTextureAtlasesEvent(SequencedMap<Identifier,AtlasManager.AtlasConfig> atlases)

Method Details

register

public void register(AtlasManager.AtlasConfig atlasConfig)

Register a texture atlas with the given configuration

Parameters:

atlasConfig - The configuration of the texture atlas

addAdditionalMetadata

public void addAdditionalMetadata(Identifier atlasId,
 MetadataSectionType<?> metaSectionType)

Add an additional MetadataSectionType to be loaded for the sprites of the given texture atlas.

Parameters:

atlasId - The ID of the texture atlas, see AtlasIds for vanilla IDs

metaSectionType - The metadata section type to add