team.unnamed.creative.blockstate

Class Variant

java.lang.Object

team.unnamed.creative.blockstate.Variant

All Implemented Interfaces:

net.kyori.examination.Examinable

public class Variant
extends java.lang.Object
implements net.kyori.examination.Examinable

Represents a block state variant, applies a different model for a block state

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Variant.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_UV_LOCK
static int	DEFAULT_WEIGHT
static int	DEFAULT_X_ROTATION
static int	DEFAULT_Y_ROTATION

Method Summary

Modifier and Type	Method and Description
static Variant.Builder	builder()
boolean	equals(java.lang.Object o)
@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
int	hashCode()
net.kyori.adventure.key.Key	model() Returns the Key instance which specifies the new model location (resource location)
java.lang.String	toString()
boolean	uvLock() Can be true or false (default).
int	weight() Sets the probability of the model for being used in the game, defaults to 1 (=100%).
int	x() Returns the rotation of the model on the x-axis in increments of 90 degrees
int	y() Returns the rotation of the model on the y-axis in increments of 90 degrees

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Field Detail

DEFAULT_X_ROTATION

public static final int DEFAULT_X_ROTATION

See Also:

Constant Field Values

DEFAULT_Y_ROTATION

public static final int DEFAULT_Y_ROTATION

See Also:

Constant Field Values

DEFAULT_UV_LOCK

public static final boolean DEFAULT_UV_LOCK

See Also:

Constant Field Values

DEFAULT_WEIGHT

public static final int DEFAULT_WEIGHT

See Also:

Constant Field Values

Method Detail

model

public net.kyori.adventure.key.Key model()

Returns the Key instance which specifies the new model location (resource location)

Returns:

The model resource location

x

public int x()

Returns the rotation of the model on the x-axis in increments of 90 degrees

Returns:

The model rotation in the X axis

y

public int y()

Returns the rotation of the model on the y-axis in increments of 90 degrees

Returns:

The model rotation in the Y axis

uvLock

public boolean uvLock()

Can be true or false (default). Locks the rotation of the texture of a block, if set to true. This way the texture does not rotate with the block when using the x and y-tags above

Returns:

True if the model texture is locked

weight

public int weight()

Sets the probability of the model for being used in the game, defaults to 1 (=100%).

If more than one model is used for the same variant, the probability is calculated by dividing the individual model's weight by the sum of the weights of all models

Returns:

This state variant weight

examinableProperties

@NotNull
public @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

builder

public static Variant.Builder builder()