team.unnamed.creative.overlay

Interface Overlay

All Superinterfaces:

ResourceContainer, ResourcePackPart

@ApiStatus.NonExtendable
public interface Overlay
extends ResourcePackPart, ResourceContainer

Represents a resource-pack overlay. Overlays are sub-packs applied over the "normal" contents of a pack that are applied only if they support the client's pack format.

For example, if the overlay foo is applied, the file overlays/foo/assets/minecraft/textures/bar.png will replace the contents of assets/minecraft/textures/bar.png.

Note that overlays can add and replace files, but not remove them.

Also note that overlays do not have pack metadata or icon.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this overlay to the given resource container, which must be a resource pack.
@NotNull java.lang.String	directory() Gets the overlay's directory name.
static @NotNull Overlay	overlay(@NotNull java.lang.String directory) Creates a new overlay object that will live in the given directory name.

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface team.unnamed.creative.overlay.ResourceContainer

atlas, atlas, atlases, blockState, blockState, blockStates, font, font, font, font, fonts, language, language, languages, merge, model, model, models, part, removeAtlas, removeBlockState, removeFont, removeLanguage, removeModel, removeSound, removeSoundEvent, removeSoundRegistry, removeTexture, removeUnknownFile, sound, sound, sound, soundEvent, soundEvent, soundEvents, soundRegistries, soundRegistry, soundRegistry, sounds, texture, texture, texture, texture, textures, unknownFile, unknownFile, unknownFiles

Method Detail

directory

@NotNull
@NotNull java.lang.String directory()

Gets the overlay's directory name.

Returns:

The overlay directory name.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this overlay to the given resource container, which must be a resource pack.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0

overlay

@NotNull
static @NotNull Overlay overlay(@NotNull @OverlayEntry.Directory
                                          @NotNull java.lang.String directory)

Creates a new overlay object that will live in the given directory name.

Parameters:

directory - The overlay directory name.

Returns:

The created overlay.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18