team.unnamed.creative.metadata.pack

Interface PackFormat

All Superinterfaces:

net.kyori.examination.Examinable

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

Represents the format or version of a resource-pack.

Since Minecraft 1.20.2 (pack format 18), resource-packs can also describe a range for pack formats that this pack supports.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
int	format() Returns the pack format.
static @NotNull PackFormat	format(int format) Create a pack format that supports only a single pack format, specified by the format parameter.
static @NotNull PackFormat	format(int format, int min, int max) Create a pack format that supports a range of formats specified by the min and max parameters.
boolean	isInRange(int format) Determines whether the given format is in the range of this pack format.
boolean	isSingle() Determines whether this pack format is a single format and not a range of formats.
int	max() Returns the maximum supported pack format.
int	min() Returns the minimum supported pack format.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

format

int format()

Returns the pack format.

This value is still required for older versions to be able to read the resource-pack.

The value is between min and max values.

Returns:

The pack format.

Since:

1.1.0

min

int min()

Returns the minimum supported pack format. (Inclusive)

Returns:

The minimum supported pack format (Inclusive)

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

max

int max()

Returns the maximum supported pack format. (Inclusive)

Returns:

The maximum supported pack format (Inclusive)

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

isSingle

boolean isSingle()

Determines whether this pack format is a single format and not a range of formats.

Returns:

True if format, min and max are equal.

Since:

1.1.0

isInRange

boolean isInRange(int format)

Determines whether the given format is in the range of this pack format.

Parameters:

format - The format to check.

Returns:

True if the format is in the range.

Since:

1.1.0

format

@NotNull
static @NotNull PackFormat format(int format)

Create a pack format that supports only a single pack format, specified by the format parameter.

Parameters:

format - The pack format

Returns:

The created pack format

Since:

1.1.0

format

@NotNull
static @NotNull PackFormat format(int format,
                                            int min,
                                            int max)

Create a pack format that supports a range of formats specified by the min and max parameters.

Note: since this range information is ignored by old versions of the game, they will always see a "normal", single-version pack, without any extended compatibility. The single-version for this pack is specified by the format parameter.

Also note that the given format must be in the bounds of the provided range.

Parameters:

format - The pack format (for older versions)

min - The minimum supported pack format (INCLUSIVE)

max - The maximum supported pack format (INCLUSIVE)

Returns:

The created pack format

Since:

1.1.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18