team.unnamed.creative.model

Interface ElementFace

All Superinterfaces:

net.kyori.examination.Examinable

public interface ElementFace
extends net.kyori.examination.Examinable

Defines the properties of a CubeFace from a Element

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ElementFace.Builder Builder implementation for creating ElementFace instances

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ROTATION
static int	DEFAULT_TINT_INDEX
static float	MINECRAFT_UV_UNIT Deprecated. Should not be exposed, moved to serializer

Method Summary

Modifier and Type	Method and Description
static @NotNull ElementFace.Builder	builder() Deprecated. Use face() instead
@Nullable CubeFace	cullFace() Returns whether a face does not need to be rendered when there is a block touching it in the specified position.
static @NotNull ElementFace.Builder	face() Creates a new element face builder instance.
static @NotNull ElementFace	face(@Nullable TextureUV uv, @NotNull java.lang.String texture, @Nullable CubeFace cullFace, int rotation, int tintIndex) Creates a new ElementFace instance from the provided values
static @NotNull ElementFace	of(@Nullable Vector4Float uv, @NotNull java.lang.String texture, @Nullable CubeFace cullFace, int rotation, int tintIndex) Deprecated. Use face(TextureUV, String, CubeFace, int, int) instead
int	rotation() Returns this face texture rotation, it rotates the texture by the specified number of degrees.
@NotNull java.lang.String	texture() Returns this face's texture in variable form prepended with a "#"
int	tintIndex() Determines whether to tint the texture using a hardcoded tint index.
default @Nullable Vector4Float	uv() Deprecated. Use uv0() instead
@Nullable TextureUV	uv0() Deprecated. Will be renamed to "uv" in 2.0.0

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

MINECRAFT_UV_UNIT

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
static final float MINECRAFT_UV_UNIT

Deprecated. Should not be exposed, moved to serializer

The Minecraft UV unit, UV coordinates in Minecraft actually use a 0-16 scale, so this constant is used to convert from 0-1 to 0-16.

Since:

1.0.0

See Also:

Constant Field Values

DEFAULT_ROTATION

static final int DEFAULT_ROTATION

See Also:

Constant Field Values

DEFAULT_TINT_INDEX

static final int DEFAULT_TINT_INDEX

See Also:

Constant Field Values

Method Detail

face

@NotNull
static @NotNull ElementFace face(@Nullable
                                           @Nullable TextureUV uv,
                                           @NotNull
                                           @NotNull java.lang.String texture,
                                           @Nullable
                                           @Nullable CubeFace cullFace,
                                           int rotation,
                                           int tintIndex)

Creates a new ElementFace instance from the provided values

Parameters:

uv - The texture area to use, will be automatically generated by the client if not set

texture - The texture name

cullFace - The element face cull face

rotation - The face rotation, must be multiple of 90 and be less than 360

tintIndex - The face tint index

Returns:

The recently created ElementFace instance

Since:

1.1.0

face

@NotNull
static @NotNull ElementFace.Builder face()

Creates a new element face builder instance.

Returns:

A new builder instance

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull ElementFace of(@Nullable
                                                                                                           @Nullable Vector4Float uv,
                                                                                                           @NotNull
                                                                                                           @NotNull java.lang.String texture,
                                                                                                           @Nullable
                                                                                                           @Nullable CubeFace cullFace,
                                                                                                           int rotation,
                                                                                                           int tintIndex)

Deprecated. Use face(TextureUV, String, CubeFace, int, int) instead

Creates a new ElementFace instance from the provided values

Parameters:

uv - The texture area to use, will be automatically generated by the client if not set

texture - The texture name

cullFace - The element face cull face

rotation - The face rotation, must be multiple of 90 and be less than 360

tintIndex - The face tint index

Returns:

The recently created ElementFace instance

Since:

1.0.0

builder

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

Deprecated. Use face() instead

Static factory method for creating a new instance of our builder implementation, which eases the creation of ElementFace instances

Returns:

A new builder instance

Since:

1.0.0

uv

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Nullable
default @Nullable Vector4Float uv()

Deprecated. Use uv0() instead

Returns the area of the texture to use according to the scheme [x1, y1, x2, y2]

All components are always between 0 and 1 and then converted to 0-16 (Minecraft UV) when creating the resource pack

If the numbers of x1 and x2 are swapped the texture flips

UV is optional, and if not supplied it automatically generates based on the element's position.

Returns:

The texture area to use

Since:

1.0.0

uv0

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Nullable
@Nullable TextureUV uv0()

Deprecated. Will be renamed to "uv" in 2.0.0

Returns the area of the texture to use.

If the UV is not specified, it will be automatically generated based on the element's position and face.

Returns:

The texture area to use

Since:

1.1.0

texture

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

Returns this face's texture in variable form prepended with a "#"

Returns:

The face texture

Since:

1.0.0

cullFace

@Nullable
@Nullable CubeFace cullFace()

Returns whether a face does not need to be rendered when there is a block touching it in the specified position. It also determines the side of the block to use the light level from for lighting the face

Returns:

The element cull face

Since:

1.0.0

rotation

int rotation()

Returns this face texture rotation, it rotates the texture by the specified number of degrees. Can be 0, 90, 180, or 270.

Rotation does not affect which part of the texture is used. Instead, it amounts to permutation of the selected texture vertexes (selected implicitly, or explicitly though uv)

Returns:

The face texture rotation

Since:

1.0.0

tintIndex

int tintIndex()

Determines whether to tint the texture using a hardcoded tint index.

Returns:

The face tint index

Since:

1.0.0