Class ConditionalModelBuilder

java.lang.Object

net.neoforged.neoforge.client.model.generators.template.CustomLoaderBuilder

net.neoforged.neoforge.client.model.generators.loaders.ConditionalModelBuilder

public final class ConditionalModelBuilder
extends CustomLoaderBuilder

See Also:

• ConditionalModelLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	ConditionalModelBuilder.InlineModel

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ICondition>	conditions
private com.mojang.datafixers.util.Either<Identifier, ConditionalModelBuilder.InlineModel>	fallback
private @Nullable ConditionalModelBuilder.InlineModel	inlineModel

Fields inherited from class CustomLoaderBuilder

allowInlineElements, loaderId, visibility

Constructor Summary

Constructors

Constructor	Description
ConditionalModelBuilder()

Method Summary

Modifier and Type	Method	Description
ConditionalModelBuilder	addCondition(ICondition condition)	Add a loading condition which must be satisfied for this model to be loaded.
protected CustomLoaderBuilder	copyInternal()	Returns a deep-copy of this builder in order to maintain the immutability nature of ModelTemplate.
ConditionalModelBuilder	setFallback(Identifier fallback)	Specify the model to fall back to when any condition fails, as a reference to another file.
ConditionalModelBuilder	setInlineFallback(ModelTemplate template, TextureMapping textures)	Specify the model to fall back to when any condition fails, inlined into this model.
ConditionalModelBuilder	setInlineModel(ModelTemplate template, TextureMapping textures)	Specify the model to use when all conditions succeed, as a nested object.
JsonObject	toJson(JsonObject json)

Methods inherited from class CustomLoaderBuilder

optional, serializeNestedTemplate, visibility

Methods inherited from class Object

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

Field Details

conditions

private final List<ICondition> conditions

inlineModel

private @Nullable ConditionalModelBuilder.InlineModel inlineModel

fallback

private com.mojang.datafixers.util.Either<Identifier, ConditionalModelBuilder.InlineModel> fallback

Constructor Details

ConditionalModelBuilder

public ConditionalModelBuilder()

Method Details

addCondition

public ConditionalModelBuilder addCondition(ICondition condition)

Add a loading condition which must be satisfied for this model to be loaded.

Parameters:

condition - The condition to add

setInlineModel

public ConditionalModelBuilder setInlineModel(ModelTemplate template,
 TextureMapping textures)

Specify the model to use when all conditions succeed, as a nested object.

This is intended to be used when the guarded model uses yet another model loader. Models which do not need another loader should instead specify their elements/textures/etc. on the model template this builder is attached to.

Parameters:

template - The template to generate the model from

textures - The texture mapping to generate the model with

setFallback

public ConditionalModelBuilder setFallback(Identifier fallback)

Specify the model to fall back to when any condition fails, as a reference to another file.

Parameters:

fallback - The fallback model

See Also:

• setInlineFallback(ModelTemplate, TextureMapping)

setInlineFallback

public ConditionalModelBuilder setInlineFallback(ModelTemplate template,
 TextureMapping textures)

Specify the model to fall back to when any condition fails, inlined into this model.

Parameters:

template - The template to generate the fallback model from

textures - The texture mapping to generate the fallback model with

See Also:

• setFallback(Identifier)

copyInternal

protected CustomLoaderBuilder copyInternal()

Description copied from class: CustomLoaderBuilder

Returns a deep-copy of this builder in order to maintain the immutability nature of ModelTemplate.

Specified by:

copyInternal in class CustomLoaderBuilder

toJson

public JsonObject toJson(JsonObject json)

Overrides:

toJson in class CustomLoaderBuilder