team.unnamed.creative.atlas

Interface Atlas

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed, ResourcePackPart

@ApiStatus.NonExtendable
public interface Atlas
extends ResourcePackPart, net.kyori.adventure.key.Keyed, net.kyori.examination.Examinable

Represents an atlas, atlases are configuration files that control which images are included in texture atlases.

When the game loads all textures used by block and item models, the textures need to be stitched (merged) into a single image, called the "atlas".

Individual textures that are stitched onto the atlas are called "sprites".

Note that, since Minecraft 1.19.3, by default, textures not in "item/" or "block/" directories are no longer automatically recognized and will fail to load.

See the 1.19.3 change-log and the atlas structure in the resource-pack here

Since:

1.0.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Atlas.Builder A mutable builder for Atlas instances.

Field Summary

Fields

Modifier and Type	Field and Description
static net.kyori.adventure.key.Key	ARMOR_TRIMS
static net.kyori.adventure.key.Key	BANNER_PATTERNS
static net.kyori.adventure.key.Key	BEDS
static net.kyori.adventure.key.Key	BLOCKS
static net.kyori.adventure.key.Key	CHESTS
static net.kyori.adventure.key.Key	DECORATED_POT
static net.kyori.adventure.key.Key	GUI Key for the GUI texture atlas.
static net.kyori.adventure.key.Key	MOB_EFFECTS
static net.kyori.adventure.key.Key	PAINTINGS
static net.kyori.adventure.key.Key	PARTICLES
static net.kyori.adventure.key.Key	SHIELD_PATTERNS
static net.kyori.adventure.key.Key	SHULKER_BOXES
static net.kyori.adventure.key.Key	SIGNS

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this atlas instance to the given resource container.
static @NotNull Atlas.Builder	atlas() Creates a new Atlas builder instance.
static @NotNull Atlas	atlas(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.List<AtlasSource> sources) Creates a new Atlas instance.
static @NotNull Atlas.Builder	builder() Deprecated. In favor of atlas()
@NotNull net.kyori.adventure.key.Key	key() Gets the Atlas key, e.g.
static @NotNull Atlas	of(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.List<AtlasSource> sources) Deprecated. in favor of atlas(Key, List)
@Unmodifiable @NotNull java.util.List<AtlasSource>	sources() Gets the list of sources for this Atlas
@NotNull Atlas.Builder	toBuilder() Converts this atlas instance to its builder type, with all the properties already set

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

BLOCKS

static final net.kyori.adventure.key.Key BLOCKS

BANNER_PATTERNS

static final net.kyori.adventure.key.Key BANNER_PATTERNS

BEDS

static final net.kyori.adventure.key.Key BEDS

CHESTS

static final net.kyori.adventure.key.Key CHESTS

SHIELD_PATTERNS

static final net.kyori.adventure.key.Key SHIELD_PATTERNS

SHULKER_BOXES

static final net.kyori.adventure.key.Key SHULKER_BOXES

SIGNS

static final net.kyori.adventure.key.Key SIGNS

MOB_EFFECTS

static final net.kyori.adventure.key.Key MOB_EFFECTS

PAINTINGS

static final net.kyori.adventure.key.Key PAINTINGS

PARTICLES

static final net.kyori.adventure.key.Key PARTICLES

ARMOR_TRIMS

static final net.kyori.adventure.key.Key ARMOR_TRIMS

DECORATED_POT

static final net.kyori.adventure.key.Key DECORATED_POT

GUI

static final net.kyori.adventure.key.Key GUI

Key for the GUI texture atlas.

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

Method Detail

key

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

Gets the Atlas key, e.g. "test:fancy", note that JSON extension is not included

Specified by:

key in interface net.kyori.adventure.key.Keyed

Returns:

The atlas resource location

Since:

1.0.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

sources

@NotNull
@Unmodifiable @NotNull java.util.List<AtlasSource> sources()

Gets the list of sources for this Atlas

Returns:

The atlas sources

Since:

1.0.0

See Also:

AtlasSource

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

toBuilder

@Contract(value="-> new")
 @NotNull
@NotNull Atlas.Builder toBuilder()

Converts this atlas instance to its builder type, with all the properties already set

Returns:

The created builder

Since:

1.0.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this atlas instance to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0

atlas

@NotNull
static @NotNull Atlas atlas(@NotNull
                                      @NotNull net.kyori.adventure.key.Key key,
                                      @NotNull
                                      @NotNull java.util.List<AtlasSource> sources)

Creates a new Atlas instance.

Parameters:

key - The atlas key, doesn't include JSON extension

sources - The list of sources for the atlas

Returns:

The created atlas instance

Since:

1.1.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

atlas

@NotNull
static @NotNull Atlas.Builder atlas()

Creates a new Atlas builder instance.

Returns:

The created builder

Since:

1.1.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Atlas of(@NotNull
                                                                                                     @NotNull net.kyori.adventure.key.Key key,
                                                                                                     @NotNull
                                                                                                     @NotNull java.util.List<AtlasSource> sources)

Deprecated. in favor of atlas(Key, List)

Creates a new Atlas instance.

Parameters:

key - The atlas key, doesn't include JSON extension

sources - The list of sources for the atlas

Returns:

The created atlas instance

Since:

1.0.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Atlas.Builder builder()

Deprecated. In favor of atlas()

Creates a new Atlas builder instance.

Returns:

The created builder

Since:

1.0.0

Since Minecraft:

1.19.3

Since Resource-Pack Format:

12