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

Class ExtendedModelTemplateBuilder

java.lang.Object

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

public class ExtendedModelTemplateBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Nullable Boolean	ambientOcclusion
(package private) @Nullable CustomLoaderBuilder	customLoader
(package private) final List<ElementBuilder>	elements
(package private) UnbakedModel.GuiLight	guiLight
(package private) Optional<ResourceLocation>	parent
(package private) @Nullable ResourceLocation	renderType
(package private) final Set<TextureSlot>	requiredSlots
(package private) final RootTransformsBuilder	rootTransforms
(package private) Optional<String>	suffix
(package private) final Map<ItemDisplayContext,TransformVecBuilder>	transforms

Constructor Summary

Constructors

Constructor	Description
ExtendedModelTemplateBuilder()

Method Summary

Modifier and Type	Method	Description
ExtendedModelTemplateBuilder	ambientOcclusion(boolean ambientOcclusion)	Sets whether or not this model should apply ambient occlusion.
ExtendedModelTemplate	build()	Finalizes this builder into a compiled ModelTemplate.
static ExtendedModelTemplateBuilder	builder()
<L extends CustomLoaderBuilder> ExtendedModelTemplateBuilder	customLoader(Supplier<L> customLoaderFactory, Consumer<L> action)	Use a custom loader instead of the vanilla elements.
ExtendedModelTemplateBuilder	element(int index, Consumer<ElementBuilder> action)	Get an existing element builder
ExtendedModelTemplateBuilder	element(Consumer<ElementBuilder> action)	Creates a new element for this model while also allowing mutation.
int	getElementCount()	Returns the number of elements in this model builder.
ExtendedModelTemplateBuilder	guiLight(UnbakedModel.GuiLight light)	Sets the gui light style for this model.
static ExtendedModelTemplateBuilder	of(ModelTemplate template)
ExtendedModelTemplateBuilder	parent(ResourceLocation parent)	Parent model which this template will inherit its properties from.
ExtendedModelTemplateBuilder	renderType(String renderType)	Set the render type for this model.
ExtendedModelTemplateBuilder	renderType(ResourceLocation renderType)	Set the render type for this model.
ExtendedModelTemplateBuilder	requiredTextureSlot(TextureSlot slot)	Marks the given slot as required, meaning that it must be specified in the given texture mappings.
ExtendedModelTemplateBuilder	rootTransforms(Consumer<RootTransformsBuilder> action)	Modifies the transformation applied right before item display transformations and rotations specified in block states.
ExtendedModelTemplateBuilder	suffix(String suffix)	Suffix appended onto the models file path.
ExtendedModelTemplateBuilder	transform(ItemDisplayContext type, Consumer<TransformVecBuilder> action)	Begin building a new transform for the given perspective.

Methods inherited from class java.lang.Object

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

Field Details

parent

Optional<ResourceLocation> parent

suffix

Optional<String> suffix

requiredSlots

final Set<TextureSlot> requiredSlots

transforms

final Map<ItemDisplayContext,TransformVecBuilder> transforms

elements

final List<ElementBuilder> elements

customLoader

@Nullable
@Nullable CustomLoaderBuilder customLoader

rootTransforms

final RootTransformsBuilder rootTransforms

renderType

@Nullable
@Nullable ResourceLocation renderType

ambientOcclusion

@Nullable
@Nullable Boolean ambientOcclusion

guiLight

@Nullable
UnbakedModel.GuiLight guiLight

Constructor Details

ExtendedModelTemplateBuilder

public ExtendedModelTemplateBuilder()

Method Details

of

public static ExtendedModelTemplateBuilder of(ModelTemplate template)

builder

public static ExtendedModelTemplateBuilder builder()

parent

public ExtendedModelTemplateBuilder parent(ResourceLocation parent)

Parent model which this template will inherit its properties from.

suffix

public ExtendedModelTemplateBuilder suffix(String suffix)

Suffix appended onto the models file path.

requiredTextureSlot

public ExtendedModelTemplateBuilder requiredTextureSlot(TextureSlot slot)

Marks the given slot as required, meaning that it must be specified in the given texture mappings.

renderType

public ExtendedModelTemplateBuilder renderType(String renderType)

Set the render type for this model.

Parameters:

renderType - the render type. Must be registered via RegisterNamedRenderTypesEvent

Returns:

this builder

Throws:

NullPointerException - if renderType is null

renderType

public ExtendedModelTemplateBuilder renderType(ResourceLocation renderType)

Set the render type for this model.

Parameters:

renderType - the render type. Must be registered via RegisterNamedRenderTypesEvent

Returns:

this builder

Throws:

NullPointerException - if renderType is null

transform

public ExtendedModelTemplateBuilder transform(ItemDisplayContext type,
 Consumer<TransformVecBuilder> action)

Begin building a new transform for the given perspective.

Parameters:

type - the perspective to create or return the builder for

Returns:

the builder for the given perspective

Throws:

NullPointerException - if type is null

ambientOcclusion

public ExtendedModelTemplateBuilder ambientOcclusion(boolean ambientOcclusion)

Sets whether or not this model should apply ambient occlusion.

guiLight

public ExtendedModelTemplateBuilder guiLight(UnbakedModel.GuiLight light)

Sets the gui light style for this model.

• UnbakedModel.GuiLight.FRONT for head on light, commonly used for items.
• UnbakedModel.GuiLight.SIDE for the model to be side lit, commonly used for blocks.

element

public ExtendedModelTemplateBuilder element(Consumer<ElementBuilder> action)

Creates a new element for this model while also allowing mutation.

Throws:

IllegalStateException - if customLoader does not allow inline elements.

element

public ExtendedModelTemplateBuilder element(int index,
 Consumer<ElementBuilder> action)

Get an existing element builder

Parameters:

index - the index of the existing element builder

Returns:

the element builder

Throws:

IndexOutOfBoundsException - if index is out of bounds

getElementCount

public int getElementCount()

Returns the number of elements in this model builder.

Returns:

the number of elements in this model builder

customLoader

public <L extends CustomLoaderBuilder>
ExtendedModelTemplateBuilder customLoader(Supplier<L> customLoaderFactory,
 Consumer<L> action)

Use a custom loader instead of the vanilla elements.

Parameters:

customLoaderFactory - function that returns the custom loader to set, given this

Returns:

the custom loader builder

rootTransforms

public ExtendedModelTemplateBuilder rootTransforms(Consumer<RootTransformsBuilder> action)

Modifies the transformation applied right before item display transformations and rotations specified in block states.

build

public ExtendedModelTemplate build()

Finalizes this builder into a compiled ModelTemplate.