team.unnamed.creative.model

Interface Model

All Superinterfaces:

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

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

Represents a Minecraft block/item model.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Model.Builder
static class	Model.GuiLight Enum of possible "gui_light" property values

Field Summary

Fields

Modifier and Type	Field and Description
static net.kyori.adventure.key.Key	BUILT_IN_ENTITY A Model can be set to extend this key to load a model from an entity file.
static net.kyori.adventure.key.Key	BUILT_IN_GENERATED
static boolean	DEFAULT_AMBIENT_OCCLUSION
static net.kyori.adventure.key.Key	ITEM_GENERATED A Model can be set to extend this key to use a model that is created out of the specified icon
static net.kyori.adventure.key.Key	ITEM_HANDHELD

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this model to the given resource container.
boolean	ambientOcclusion() Returns the boolean that determines whether to use ambient occlusion or not for this block
static @NotNull Model.Builder	builder() Deprecated.
@NotNull @Unmodifiable java.util.Map<ItemTransform.Type,ItemTransform>	display() Returns a map of the different places where the model can be displayed
@NotNull @Unmodifiable java.util.List<Element>	elements() Returns an unmodifiable list containing all the model elements, which can only have cubic forms
@Nullable Model.GuiLight	guiLight() Returns the way how the item is rendered, can be "side" or "front"
@NotNull net.kyori.adventure.key.Key	key()
static @NotNull Model.Builder	model()
@NotNull java.util.List<ItemOverride>	overrides() Returns a list of item overrides, item overrides determine cases in which a different model should be used based on item tags
@Nullable net.kyori.adventure.key.Key	parent() Returns the parent model of this model object
@NotNull ModelTextures	textures() Returns this model textures
default @NotNull Model.Builder	toBuilder() Converts this model object to a Model.Builder with all the model-properties in this object.

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

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

ITEM_GENERATED

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

A Model can be set to extend this key to use a model that is created out of the specified icon

Since:

1.0.0

ITEM_HANDHELD

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

BUILT_IN_ENTITY

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

A Model can be set to extend this key to load a model from an entity file. As you cannot specify the entity, this does not work for all items (only for chests, ender chests, mob heads, shields, banners and tridents)

Since:

1.0.0

BUILT_IN_GENERATED

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

DEFAULT_AMBIENT_OCCLUSION

static final boolean DEFAULT_AMBIENT_OCCLUSION

See Also:

Constant Field Values

Method Detail

model

@Contract(value="-> new")
 @NotNull
static @NotNull Model.Builder model()

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="-> new")
 @NotNull
static @NotNull Model.Builder builder()

Deprecated.

key

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

Specified by:

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

parent

@Nullable
@Nullable net.kyori.adventure.key.Key parent()

Returns the parent model of this model object

Returns:

The parent model location

Since:

1.0.0

ambientOcclusion

boolean ambientOcclusion()

Returns the boolean that determines whether to use ambient occlusion or not for this block

Returns:

True to use ambient occlusion

Since:

1.0.0

display

@NotNull
@NotNull @Unmodifiable java.util.Map<ItemTransform.Type,ItemTransform> display()

Returns a map of the different places where the model can be displayed

Returns:

An unmodifiable map of displays

Since:

1.0.0

textures

@NotNull
@NotNull ModelTextures textures()

Returns this model textures

Returns:

This model textures

Since:

1.0.0

guiLight

@Nullable
@Nullable Model.GuiLight guiLight()

Returns the way how the item is rendered, can be "side" or "front"

If set to "side", the model is rendered like a block. If set to "front", model is shaded like a flat item

Returns:

Value that determines how to render this item

Since:

1.0.0

elements

@NotNull
@NotNull @Unmodifiable java.util.List<Element> elements()

Returns an unmodifiable list containing all the model elements, which can only have cubic forms

Returns:

The model elements

Since:

1.0.0

overrides

@NotNull
@NotNull java.util.List<ItemOverride> overrides()

Returns a list of item overrides, item overrides determine cases in which a different model should be used based on item tags

All cases are evaluated in order from top to bottom and last predicate that matches overrides. However, overrides are ignored if it has been already overridden once, for example this avoids recursion on overriding to the same model

Returns:

This item model overrides

Since:

1.0.0

toBuilder

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

Converts this model object to a Model.Builder with all the model-properties in this object.

Returns:

The builder

Since:

1.3.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this model to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0