team.unnamed.creative.metadata.overlays

Interface OverlayEntry

All Superinterfaces:

net.kyori.examination.Examinable

@ApiStatus.NonExtendable
public interface OverlayEntry
extends net.kyori.examination.Examinable

Represents an overlay entry for the OverlaysMeta part.

An overlay entry tells the client that there is an available overlay for an specific pack format range.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OverlayEntry.Directory Specifies that the annotated string must be a valid directory string for overlay entries.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	directory() Gets the directory name that this overlay uses.
@NotNull PackFormat	formats() Gets the pack formats range that this overlay supports.
static @NotNull OverlayEntry	of(@NotNull PackFormat formats, @NotNull java.lang.String directory) Creates a new OverlayEntry instance with the given pack formats range and directory name.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

formats

@NotNull
@NotNull PackFormat formats()

Gets the pack formats range that this overlay supports.

Returns:

The pack formats.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

directory

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

Gets the directory name that this overlay uses.

Returns:

The directory name.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

of

@NotNull
static @NotNull OverlayEntry of(@NotNull
                                          @NotNull PackFormat formats,
                                          @NotNull @OverlayEntry.Directory
                                          @NotNull java.lang.String directory)

Creates a new OverlayEntry instance with the given pack formats range and directory name.

Parameters:

formats - The pack formats.

directory - The directory name.

Returns:

The overlay entry.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18