Package net.fabricmc.fabric.api.client.model.loading.v1

Class ModelModifier

java.lang.Object

net.fabricmc.fabric.api.client.model.loading.v1.ModelModifier

public final class ModelModifier
extends Object

Contains interfaces for the events that can be used to modify models at different points in the loading and baking process.

Example use cases:

• Overriding the model for a particular block state - check if the given block state matches the desired block state. If so, return your desired model, otherwise return the given model.
• Wrapping a model to override certain behaviors - simply return a new model instance and delegate calls to the original model as needed.

Phases are used to ensure that modifications occur in a reasonable order, e.g. wrapping occurs after overrides, and separate phases are provided for mods that wrap their own models and mods that need to wrap models of other mods or wrap models arbitrarily.

Any event may be invoked concurrently with other invocations of the same event or other events, subject to reasonable constraints. For example, a block/item model and its dependencies must be loaded before the block/item model is baked.

These callbacks are invoked for every single model that is loaded or baked, so implementations should be as efficient as possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModelModifier.AfterBakeBlock
static interface	ModelModifier.AfterBakeItem
static interface	ModelModifier.BeforeBakeBlock
static interface	ModelModifier.BeforeBakeItem
static interface	ModelModifier.OnLoad
static interface	ModelModifier.OnLoadBlock

Field Summary

Fields

Modifier and Type	Field	Description
static final Identifier	DEFAULT_PHASE	Recommended phase to use for transformations that need to happen before wrapping, but after model overrides.
static final Identifier	OVERRIDE_PHASE	Recommended phase to use when overriding models, e.g.
static final Identifier	WRAP_LAST_PHASE	Recommended phase to use when wrapping models with transformations that want to happen last, e.g.
static final Identifier	WRAP_PHASE	Recommended phase to use when wrapping models.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

OVERRIDE_PHASE

public static final Identifier OVERRIDE_PHASE

Recommended phase to use when overriding models, e.g. replacing a model with another model.

DEFAULT_PHASE

public static final Identifier DEFAULT_PHASE

Recommended phase to use for transformations that need to happen before wrapping, but after model overrides.

WRAP_PHASE

public static final Identifier WRAP_PHASE

Recommended phase to use when wrapping models.

WRAP_LAST_PHASE

public static final Identifier WRAP_LAST_PHASE

Recommended phase to use when wrapping models with transformations that want to happen last, e.g. for connected textures or other similar visual effects that should be the final processing step.