Class TrimmedArmorModel

java.lang.Object

net.neoforged.neoforge.client.model.item.TrimmedArmorModel

All Implemented Interfaces:

ItemModel

public class TrimmedArmorModel
extends Object
implements ItemModel

A dynamic model that applies an armor trim texture on top of an existing model when the trim component exists.

NOTE: If multiple mods add a trim material with the same path, only the one that gets loaded last will have its proper colors.

Example: if mod A and mod B register a "tin" trim material, and mod B loads after A, mod B's material will be the one used.

Mod A's ingot will still work just fine as a trim material, it will just look like whatever mod B defined for theirs!

All this means is that if another mod is registering the same material(s) as you and uses this system, your trim colors may not look exactly how you want them to.

This issue can be avoided by making your material path more unique. We would encourage you to prefix your material with your mod id or something along those lines.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TrimmedArmorModel.Unbaked

Nested classes/interfaces inherited from interface ItemModel

ItemModel.BakingContext

Field Summary

Fields

Modifier and Type	Field	Description
private final ItemModel.BakingContext	bakingContext
private final ItemModel	baseModel
private final Identifier	baseTrimTexture
private static final ModelDebugName	DEBUG_NAME
private final it.unimi.dsi.fastutil.objects.Object2ObjectMap<String, ItemModel>	itemsWithTrims
private final ItemTransforms	itemTransforms
private final Matrix4fc	transformation
private static final ModelState	TRIM_STATE
private static final Transformation	TRIM_TRANSFORM

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TrimmedArmorModel(ItemModel baseModel, Identifier baseTrimTexture, ItemModel.BakingContext bakingContext, Matrix4fc transformation)

Method Summary

Modifier and Type	Method	Description
private ItemModel	createTrimLayer(String suffix)
void	update(ItemStackRenderState state, ItemStack stack, ItemModelResolver resolver, ItemDisplayContext context, @Nullable ClientLevel level, @Nullable ItemOwner owner, int seed)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TRIM_TRANSFORM

private static final Transformation TRIM_TRANSFORM

DEBUG_NAME

private static final ModelDebugName DEBUG_NAME

TRIM_STATE

private static final ModelState TRIM_STATE

itemsWithTrims

private final it.unimi.dsi.fastutil.objects.Object2ObjectMap<String, ItemModel> itemsWithTrims

baseModel

private final ItemModel baseModel

baseTrimTexture

private final Identifier baseTrimTexture

bakingContext

private final ItemModel.BakingContext bakingContext

transformation

private final Matrix4fc transformation

itemTransforms

private final ItemTransforms itemTransforms

Constructor Details

TrimmedArmorModel

private TrimmedArmorModel(ItemModel baseModel,
 Identifier baseTrimTexture,
 ItemModel.BakingContext bakingContext,
 Matrix4fc transformation)

Method Details

update

public void update(ItemStackRenderState state,
 ItemStack stack,
 ItemModelResolver resolver,
 ItemDisplayContext context,
 @Nullable ClientLevel level,
 @Nullable ItemOwner owner,
 int seed)

Specified by:

update in interface ItemModel

createTrimLayer

private ItemModel createTrimLayer(String suffix)