team.unnamed.creative

Interface ResourcePack

All Superinterfaces:

ResourceContainer

@ApiStatus.NonExtendable
public interface ResourcePack
extends ResourceContainer

Represents a Minecraft: Java Edition resource-pack, it is only a memory representation and needs to be serialized/compiled to a BuiltResourcePack if you want to send it

This interface is very useful during the stage of resource collection, where you need to add all the resources inside the resource-pack

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static @NotNull ResourcePack	create() Deprecated. Use resourcePack() instead
default @Nullable java.lang.String	description()
default void	editMetadata(@NotNull java.util.function.Consumer<Metadata.Builder> editFunction)
default @Nullable FilterMeta	filterMeta()
default void	filterMeta(@NotNull FilterMeta filterMeta)
default int	format() Deprecated. Use formats() instead
default @Nullable PackFormat	formats() Returns the pack format range that this resource-pack supports.
@Nullable Writable	icon() Returns the resource-pack icon in PNG format
void	icon(@Nullable Writable icon) Sets the resource-pack icon in PNG format
default @Nullable LanguageMeta	languageMeta()
default void	languageMeta(@NotNull LanguageMeta languageMeta)
@NotNull Metadata	metadata() Returns the metadata of this resource pack, may be empty, but it is never null
void	metadata(@NotNull Metadata metadata) Sets the metadata for this resource pack, may be empty, but not null
void	overlay(@NotNull Overlay overlay) Adds or sets an overlay to this resource-pack.
@Nullable Overlay	overlay(@NotNull java.lang.String directory) Gets the overlay with the given directory name.
@NotNull java.util.Collection<Overlay>	overlays() Gets all the overlays in this resource-pack.
default @Nullable OverlaysMeta	overlaysMeta() Gets the overlay meta specified in the resource-pack metadata.
default void	overlaysMeta(@NotNull OverlaysMeta overlaysMeta) Sets the overlay meta specified in the resource-pack metadata.
default @Nullable PackMeta	packMeta()
default void	packMeta(int format, @NotNull net.kyori.adventure.text.Component description) Sets the resource-pack metadata, which specifies the pack supported format and its description.
default void	packMeta(int format, @NotNull java.lang.String description)
default void	packMeta(@NotNull PackFormat format, @NotNull net.kyori.adventure.text.Component description) Sets the resource-pack metadata, which specifies the pack supported format(s) and its description.
default void	packMeta(@NotNull PackMeta packMeta)
static @NotNull ResourcePack	resourcePack() Creates a new, empty resource-pack instance.

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

resourcePack

@NotNull
static @NotNull ResourcePack resourcePack()

Creates a new, empty resource-pack instance.

Returns:

A new resource-pack instance

Since:

1.1.0

create

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull ResourcePack create()

Deprecated. Use resourcePack() instead

Creates a new, empty resource-pack instance.

Returns:

A new resource-pack instance

Since:

1.0.0

icon

@Nullable
@Nullable Writable icon()

Returns the resource-pack icon in PNG format

Returns:

The resource-pack icon

Since:

1.0.0

icon

void icon(@Nullable
          @Nullable Writable icon)

Sets the resource-pack icon in PNG format

Parameters:

icon - The resource-pack icon

Since:

1.0.0

metadata

@NotNull
@NotNull Metadata metadata()

Returns the metadata of this resource pack, may be empty, but it is never null

Returns:

The resource-pack metadata

Since:

1.0.0

metadata

void metadata(@NotNull
              @NotNull Metadata metadata)

Sets the metadata for this resource pack, may be empty, but not null

Parameters:

metadata - The resource-pack metadata

Since:

1.0.0

editMetadata

default void editMetadata(@NotNull
                          @NotNull java.util.function.Consumer<Metadata.Builder> editFunction)

packMeta

@Nullable
default @Nullable PackMeta packMeta()

packMeta

default void packMeta(@NotNull
                      @NotNull PackMeta packMeta)

packMeta

default void packMeta(int format,
                      @NotNull
                      @NotNull java.lang.String description)

packMeta

default void packMeta(@NotNull
                      @NotNull PackFormat format,
                      @NotNull
                      @NotNull net.kyori.adventure.text.Component description)

Sets the resource-pack metadata, which specifies the pack supported format(s) and its description.

Parameters:

format - The supported pack format(s).

description - The pack description.

Since:

1.1.0

packMeta

default void packMeta(int format,
                      @NotNull
                      @NotNull net.kyori.adventure.text.Component description)

Sets the resource-pack metadata, which specifies the pack supported format and its description.

Parameters:

format - The supported pack format.

description - The pack description.

Since:

1.1.0

format

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
default int format()

Deprecated. Use formats() instead

Returns the pack format that this resource-pack uses.

Returns:

The pack format

Since:

1.0.0

formats

@Nullable
default @Nullable PackFormat formats()

Returns the pack format range that this resource-pack supports.

Returns:

The pack format range, null if not specified

Since:

1.1.0

description

@Nullable
default @Nullable java.lang.String description()

languageMeta

@Nullable
default @Nullable LanguageMeta languageMeta()

languageMeta

default void languageMeta(@NotNull
                          @NotNull LanguageMeta languageMeta)

filterMeta

@Nullable
default @Nullable FilterMeta filterMeta()

filterMeta

default void filterMeta(@NotNull
                        @NotNull FilterMeta filterMeta)

overlaysMeta

@Nullable
default @Nullable OverlaysMeta overlaysMeta()

Gets the overlay meta specified in the resource-pack metadata.

Returns:

The overlays meta, null if not set.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

overlaysMeta

default void overlaysMeta(@NotNull
                          @NotNull OverlaysMeta overlaysMeta)

Sets the overlay meta specified in the resource-pack metadata.

Parameters:

overlaysMeta - The overlays meta.

Since:

1.1.0, 1.20.2

Since Resource-Pack Format:

18

overlay

void overlay(@NotNull
             @NotNull Overlay overlay)

Adds or sets an overlay to this resource-pack.

Parameters:

overlay - The overlay to add or set.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

overlay

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

Gets the overlay with the given directory name.

Parameters:

directory - The overlay directory name.

Returns:

The overlay, null if not found.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

overlays

@NotNull
@NotNull java.util.Collection<Overlay> overlays()

Gets all the overlays in this resource-pack.

Returns:

The overlays.

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18