Package net.neoforged.neoforge.client.event

Class RegisterSpriteDefaultMetadataSectionTypesEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterSpriteDefaultMetadataSectionTypesEvent

All Implemented Interfaces:

IModBusEvent

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

Fired to allow mods to register their own default metadata section types for use during sprite loading. This event is fired once on startup, before the initial resource reload.

It is important to note that this event only affects texture atlases using SpriteLoader.DEFAULT_METADATA_SECTIONS, which includes:

• all vanilla atlases in ModelManager.VANILLA_ATLASES;
• modded atlases using RegisterMaterialAtlasesEvent;
• vanilla and modded atlases using TextureAtlasHolder(TextureManager, ResourceLocation, ResourceLocation); and
• those using SpriteLoader.loadAndStitch(ResourceManager, ResourceLocation, int, Executor) directly.

Atlases using the TextureAtlasHolder(TextureManager, ResourceLocation, ResourceLocation, Set) constructor, such as GuiSpriteManager, or SpriteLoader.loadAndStitch(ResourceManager, ResourceLocation, int, Executor, Collection) instead override this list and should instead specify any additional metadata section types in the last parameter, or, if they desire to use the default collection in addition to their own, lazily compute a merged collection.

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 Set<MetadataSectionType<?>>	defaultTypes

Constructor Summary

Constructors

Constructor	Description
RegisterSpriteDefaultMetadataSectionTypesEvent(Set<MetadataSectionType<?>> defaultTypes)

Method Summary

Modifier and Type	Method	Description
void	register(MetadataSectionType<?> sectionType)

Methods inherited from class java.lang.Object

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

Field Details

defaultTypes

private final Set<MetadataSectionType<?>> defaultTypes

Constructor Details

RegisterSpriteDefaultMetadataSectionTypesEvent

@Internal
public RegisterSpriteDefaultMetadataSectionTypesEvent(Set<MetadataSectionType<?>> defaultTypes)

Method Details

register

public void register(MetadataSectionType<?> sectionType)