Package net.minecraftforge.client.model.generators

Class ModelBuilder<T extends ModelBuilder<T>>

java.lang.Object

net.minecraftforge.client.model.generators.ModelFile

net.minecraftforge.client.model.generators.ModelBuilder<T>

Type Parameters:

T - Self type, for simpler chaining of methods.

Direct Known Subclasses:

BlockModelBuilder, ItemModelBuilder

public class ModelBuilder<T extends ModelBuilder<T>>
extends ModelFile

General purpose model builder, contains all the commonalities between item and block models.

See Also:

• ModelProvider
• BlockModelBuilder
• ItemModelBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ModelBuilder.ElementBuilder
static enum	ModelBuilder.FaceRotation
class	ModelBuilder.RootTransformsBuilder
class	ModelBuilder.TransformsBuilder

Nested classes/interfaces inherited from class net.minecraftforge.client.model.generators.ModelFile

ModelFile.ExistingModelFile, ModelFile.UncheckedModelFile

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	ambientOcclusion
protected CustomLoaderBuilder<T>	customLoader
protected final List<ModelBuilder<T>.ElementBuilder>	elements
protected final ExistingFileHelper	existingFileHelper
protected BlockModel.GuiLight	guiLight
protected @Nullable ModelFile	parent
protected String	renderType
private final ModelBuilder<T>.RootTransformsBuilder	rootTransforms
protected final Map<String,String>	textures
protected final ModelBuilder<T>.TransformsBuilder	transforms

Fields inherited from class net.minecraftforge.client.model.generators.ModelFile

location

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModelBuilder(ResourceLocation outputLocation, ExistingFileHelper existingFileHelper)

Method Summary

Modifier and Type	Method	Description
T	ao(boolean ao)
<L extends CustomLoaderBuilder<T>> L	customLoader(BiFunction<T,ExistingFileHelper,L> customLoaderFactory)	Use a custom loader instead of the vanilla elements.
ModelBuilder<T>.ElementBuilder	element()
ModelBuilder<T>.ElementBuilder	element(int index)	Get an existing element builder
protected boolean	exists()
int	getElementCount()	Returns the number of elements in this model builder.
T	guiLight(BlockModel.GuiLight light)
T	parent(ModelFile parent)	Set the parent model for the current model.
T	renderType(String renderType)	Set the render type for this model.
T	renderType(ResourceLocation renderType)	Set the render type for this model.
ModelBuilder<T>.RootTransformsBuilder	rootTransforms()
private T	self()
private Number	serializeFloat(float f)
private String	serializeLocOrKey(String tex)
private com.google.gson.JsonArray	serializeVector3f(org.joml.Vector3f vec)
T	texture(String key, String texture)	Set the texture for a given dictionary key.
T	texture(String key, ResourceLocation texture)	Set the texture for a given dictionary key.
com.google.gson.JsonObject	toJson()
ModelBuilder<T>.TransformsBuilder	transforms()

Methods inherited from class net.minecraftforge.client.model.generators.ModelFile

assertExistence, getLocation, getUncheckedLocation

Methods inherited from class java.lang.Object

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

Field Details

parent

@Nullable
protected @Nullable ModelFile parent

textures

protected final Map<String,String> textures

transforms

protected final ModelBuilder<T extends ModelBuilder<T>>.TransformsBuilder transforms

existingFileHelper

protected final ExistingFileHelper existingFileHelper

renderType

protected String renderType

ambientOcclusion

protected boolean ambientOcclusion

guiLight

protected BlockModel.GuiLight guiLight

elements

protected final List<ModelBuilder<T extends ModelBuilder<T>>.ElementBuilder> elements

customLoader

protected CustomLoaderBuilder<T extends ModelBuilder<T>> customLoader

rootTransforms

private final ModelBuilder<T extends ModelBuilder<T>>.RootTransformsBuilder rootTransforms

Constructor Details

ModelBuilder

protected ModelBuilder(ResourceLocation outputLocation,
 ExistingFileHelper existingFileHelper)

Method Details

self

private T self()

exists

protected boolean exists()

Specified by:

exists in class ModelFile

parent

public T parent(ModelFile parent)

Set the parent model for the current model.

Parameters:

parent - the parent model

Returns:

this builder

Throws:

NullPointerException - if parent is null

IllegalStateException - if parent does not exist

texture

public T texture(String key,
 String texture)

Set the texture for a given dictionary key.

Parameters:

key - the texture key

texture - the texture, can be another key e.g. "#all"

Returns:

this builder

Throws:

NullPointerException - if key is null

NullPointerException - if texture is null

IllegalStateException - if texture is not a key (does not start with '#') and does not exist in any known resource pack

texture

public T texture(String key,
 ResourceLocation texture)

Set the texture for a given dictionary key.

Parameters:

key - the texture key

texture - the texture

Returns:

this builder

Throws:

NullPointerException - if key is null

NullPointerException - if texture is null

IllegalStateException - if texture is not a key (does not start with '#') and does not exist in any known resource pack

renderType

public T 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 T 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

transforms

public ModelBuilder<T>.TransformsBuilder transforms()

ao

public T ao(boolean ao)

guiLight

public T guiLight(BlockModel.GuiLight light)

element

public ModelBuilder<T>.ElementBuilder element()

element

public ModelBuilder<T>.ElementBuilder element(int index)

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<T>> L customLoader(BiFunction<T,ExistingFileHelper,L> customLoaderFactory)

Use a custom loader instead of the vanilla elements.

Parameters:

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

Returns:

the custom loader builder

rootTransforms

public ModelBuilder<T>.RootTransformsBuilder rootTransforms()

toJson

@VisibleForTesting
public com.google.gson.JsonObject toJson()

serializeLocOrKey

private String serializeLocOrKey(String tex)

serializeVector3f

private com.google.gson.JsonArray serializeVector3f(org.joml.Vector3f vec)

serializeFloat

private Number serializeFloat(float f)