team.unnamed.creative.atlas

Interface PalettedPermutationsAtlasSource

All Superinterfaces:

AtlasSource, net.kyori.examination.Examinable

@ApiStatus.NonExtendable
public interface PalettedPermutationsAtlasSource
extends AtlasSource

A type of AtlasSource used to dynamically generate new textures in memory based on a set of color palettes.

Since:

1.0.0

Since Minecraft:

1.19.4

Since Resource-Pack Format:

13

Method Summary

Modifier and Type	Method and Description
@NotNull net.kyori.adventure.key.Key	paletteKey() Gets the key of a color palette key file.
@NotNull @Unmodifiable java.util.Map<java.lang.String,net.kyori.adventure.key.Key>	permutations() Gets the map of permutations from suffix to a key of a color palette file.
@NotNull @Unmodifiable java.util.List<net.kyori.adventure.key.Key>	textures() Gets the list of keys of the base textures.

Methods inherited from interface team.unnamed.creative.atlas.AtlasSource

directory, filter, palettedPermutations, single, single, unstitch, unstitch

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

textures

@NotNull
@NotNull @Unmodifiable java.util.List<net.kyori.adventure.key.Key> textures()

Gets the list of keys of the base textures. These textures will be used to generate variants of them that have been modified by color palettes.

Returns:

The list of base textures.

Since:

1.0.0

Since Minecraft:

1.19.4

Since Resource-Pack Format:

13

paletteKey

@NotNull
@NotNull net.kyori.adventure.key.Key paletteKey()

Gets the key of a color palette key file. This is used to define the set of key pixel colors to swap out with the color palettes defined.

Returns:

The key of the color palette key file.

Since:

1.0.0

Since Minecraft:

1.19.4

Since Resource-Pack Format:

13

permutations

@NotNull
@NotNull @Unmodifiable java.util.Map<java.lang.String,net.kyori.adventure.key.Key> permutations()

Gets the map of permutations from suffix to a key of a color palette file.

The suffix is prepended to the key of the output variant textures, with a _ character separating the suffix and the base texture name.

The number of pixels in each color palette must be the same as that of the paletteKey() defined for this source. Pixels are compared by RGB value. The alpha channel is ignored for key matching, but in the resulting texture the alpha channel is multiplied with the color palette's alpha channel. Pixels that do not match the paletteKey() are copied over to the resulting texture as-is.

Returns:

The map of permutations from suffix to a key of a color palette file.

Since:

1.0.0

Since Minecraft:

1.19.4

Since Resource-Pack Format:

13