team.unnamed.creative.metadata.pack

Interface PackMeta

All Superinterfaces:

net.kyori.examination.Examinable, MetadataPart

@ApiStatus.NonExtendable
public interface PackMeta
extends MetadataPart

Class representing the "pack" section of the pack.mcmeta file for Minecraft Resource Packs

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	description() Returns the pack description.
@NotNull net.kyori.adventure.text.Component	description0() Deprecated. This method will be renamed to description() and the description() method that returns a string will be removed in release 2.0.0
int	format() Deprecated. Use formats() instead
@NotNull PackFormat	formats() Returns the supported pack formats.
static @NotNull PackMeta	of(int format, @NotNull net.kyori.adventure.text.Component description) Creates a new PackMeta instance from the given values.
static PackMeta	of(int format, java.lang.String description) Creates a new PackMeta instance from the given values
static @NotNull PackMeta	of(@NotNull PackFormat format, @NotNull net.kyori.adventure.text.Component description) Creates a new PackMeta instance from the given values.

Methods inherited from interface team.unnamed.creative.metadata.MetadataPart

type

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

format

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

Deprecated. Use formats() instead

Returns the pack version. If this number does not match the current required number, the resource pack displays an error and requires additional confirmation to load the pack

There are format versions assigned to specific Minecraft client versions, e.g.: 7 for Minecraft 1.17 and 1.17.1, 8 for Minecraft 1.18 and 1.18.1

Returns:

The resource pack format number

Since:

1.0.0

formats

@NotNull
@NotNull PackFormat formats()

Returns the supported pack formats. The pack format specifies how the resource-pack is structured and which features it uses.

There are format versions assigned to specific Minecraft client versions, e.g.: 7 for Minecraft 1.17(.1), 8 for Minecraft 1.18(.1), and so on.

Returns:

The resource pack formats

Since:

1.1.0

description

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

Returns the pack description. Text shown below the pack name in the resource pack menu. The text is shown on two lines. If the text is too long it is truncated

Returns:

The resource-pack description

Since:

1.0.0

description0

@ApiStatus.Internal
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Deprecated
 @NotNull
@NotNull net.kyori.adventure.text.Component description0()

Deprecated. This method will be renamed to description() and the description() method that returns a string will be removed in release 2.0.0

Returns the pack description. Text shown below the pack name in the resource pack menu. The text is shown on two lines. If the text is too long, it is truncated.

Returns:

The resource-pack description

Since:

1.1.0

of

static PackMeta of(int format,
                   java.lang.String description)

Creates a new PackMeta instance from the given values

Parameters:

format - The pack format

description - The pack description

Returns:

A new PackMeta instance

Since:

1.0.0

of

@NotNull
static @NotNull PackMeta of(@NotNull
                                      @NotNull PackFormat format,
                                      @NotNull
                                      @NotNull net.kyori.adventure.text.Component description)

Creates a new PackMeta instance from the given values.

Parameters:

format - The pack format

description - The pack description

Returns:

A new PackMeta instance

Since:

1.1.0

of

@NotNull
static @NotNull PackMeta of(int format,
                                      @NotNull
                                      @NotNull net.kyori.adventure.text.Component description)

Creates a new PackMeta instance from the given values.

Parameters:

format - The pack format

description - The pack description

Returns:

A new PackMeta instance

Since:

1.1.0