team.unnamed.creative.texture

Interface Texture

All Superinterfaces:

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

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

Represents a Minecraft texture (PNG image) in the resource pack, textures are an essential part of the game graphics

Textures determine the colors/skin of every block, item, mob, font, etc. in the game

The dimensions of the texture must be square, or the height must be a multiple of the width (for animated textures only, see AnimationMeta)

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Texture.Builder A builder for texture instances.

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this texture to the given resource container.
static @NotNull Texture.Builder	builder() Deprecated. Use texture() instead, it's better for static imports
@NotNull Writable	data() Returns the texture's PNG image data, as a Writable object, never null
default @NotNull Texture	data(@NotNull Writable data) Returns an updated texture with the given data.
@NotNull net.kyori.adventure.key.Key	key() Returns this texture's key (location), a key contains the texture namespace and path, so that the full texture path is formatted like assets/<namespace>/textures/<path>
default @NotNull Texture	key(@NotNull net.kyori.adventure.key.Key key) Returns an updated texture with the given key.
@NotNull Metadata	meta() Returns the metadata object for this texture, contains some extra information for the texture
default @NotNull Texture	meta(@NotNull Metadata meta) Returns an updated texture with the given metadata.
static @NotNull Texture	of(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Deprecated. Use texture(Key, Writable) instead, it's better for static imports
static @NotNull Texture	of(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data, @NotNull Metadata meta) Deprecated. Use texture(Key, Writable) instead, it's better for static imports
static @NotNull Texture.Builder	texture() Creates a new builder for textures.
static @NotNull Texture	texture(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Creates a texture.
static @NotNull Texture	texture(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data, @NotNull Metadata meta) Creates a texture.
default @NotNull Texture.Builder	toBuilder() Returns a new texture builder with all properties from this texture.

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

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

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

hasMetadata

Method Detail

texture

@NotNull
static @NotNull Texture texture(@NotNull
                                          @NotNull net.kyori.adventure.key.Key key,
                                          @NotNull
                                          @NotNull Writable data)

Creates a texture.

Parameters:

key - The texture key

data - The texture data

Returns:

The created texture

Since:

1.1.0

texture

@NotNull
static @NotNull Texture texture(@NotNull
                                          @NotNull net.kyori.adventure.key.Key key,
                                          @NotNull
                                          @NotNull Writable data,
                                          @NotNull
                                          @NotNull Metadata meta)

Creates a texture.

Parameters:

key - The texture key

data - The texture data

meta - The texture metadata

Returns:

The created texture

Since:

1.1.0

texture

@NotNull
static @NotNull Texture.Builder texture()

Creates a new builder for textures.

Returns:

The created builder

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Texture of(@NotNull
                                                                                                       @NotNull net.kyori.adventure.key.Key key,
                                                                                                       @NotNull
                                                                                                       @NotNull Writable data)

Deprecated. Use texture(Key, Writable) instead, it's better for static imports

Creates a texture.

Parameters:

key - The texture key

data - The texture data

Returns:

The created texture

Since:

1.0.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Texture of(@NotNull
                                                                                                       @NotNull net.kyori.adventure.key.Key key,
                                                                                                       @NotNull
                                                                                                       @NotNull Writable data,
                                                                                                       @NotNull
                                                                                                       @NotNull Metadata meta)

Deprecated. Use texture(Key, Writable) instead, it's better for static imports

Creates a texture.

Parameters:

key - The texture key

data - The texture data

meta - The texture metadata

Returns:

The created texture

Since:

1.0.0

builder

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

Deprecated. Use texture() instead, it's better for static imports

Creates a new builder for textures.

Returns:

The created builder

Since:

1.0.0

key

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

Returns this texture's key (location), a key contains the texture namespace and path, so that the full texture path is formatted like assets/<namespace>/textures/<path>

Example key for a texture:

   Key key = Key.key("minecraft", "block/allium.png");
 

Note that the key value must have the file full path, this means that the key value must also contain the file extension, if any.

Specified by:

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

Returns:

The texture key

Since:

1.0.0

key

@Contract(value="_ -> new",
          pure=true)
 @NotNull
default @NotNull Texture key(@NotNull
                                                                                           @NotNull net.kyori.adventure.key.Key key)

Returns an updated texture with the given key.

Parameters:

key - The texture key

Returns:

The new texture

Since:

1.1.0

data

@NotNull
@NotNull Writable data()

Returns the texture's PNG image data, as a Writable object, never null

Returns:

The PNG image data

Since:

1.0.0

data

@Contract(value="_ -> new",
          pure=true)
 @NotNull
default @NotNull Texture data(@NotNull
                                                                                            @NotNull Writable data)

Returns an updated texture with the given data.

Parameters:

data - The texture data

Returns:

The new texture

Since:

1.1.0

meta

@NotNull
@NotNull Metadata meta()

Returns the metadata object for this texture, contains some extra information for the texture

Default Minecraft client only supports AnimationMeta, VillagerMeta and TextureMeta

Specified by:

meta in interface Metadatable

Returns:

The metadata container

Since:

1.0.0

meta

@Contract(value="_ -> new",
          pure=true)
 @NotNull
default @NotNull Texture meta(@NotNull
                                                                                            @NotNull Metadata meta)

Returns an updated texture with the given metadata.

Specified by:

meta in interface Metadatable

Parameters:

meta - The new metadata

Returns:

The new texture

Since:

1.0.0

toBuilder

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

Returns a new texture builder with all properties from this texture.

Returns:

The created builder

Since:

1.0.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this texture to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0