Package net.minecraftforge.client.model.generators

Class ModelProvider<T extends ModelBuilder<T>>

java.lang.Object

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

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

BlockModelProvider, ItemModelProvider

public abstract class ModelProvider<T extends ModelBuilder<T>>
extends Object
implements DataProvider

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.data.DataProvider

DataProvider.Factory<T extends DataProvider>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLOCK_FOLDER
final ExistingFileHelper	existingFileHelper
protected final Function<ResourceLocation,T>	factory
protected final String	folder
final Map<ResourceLocation,T>	generatedModels
private static final com.google.gson.Gson	GSON
static final String	ITEM_FOLDER
protected static final ExistingFileHelper.ResourceType	MODEL
protected static final ExistingFileHelper.ResourceType	MODEL_WITH_EXTENSION
protected final String	modid
protected final PackOutput	output
protected static final ExistingFileHelper.ResourceType	TEXTURE

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, KEY_COMPARATOR, LOGGER

Constructor Summary

Constructors

Constructor	Description
ModelProvider(PackOutput output, String modid, String folder, BiFunction<ResourceLocation,ExistingFileHelper,T> builderFromModId, ExistingFileHelper existingFileHelper)
ModelProvider(PackOutput output, String modid, String folder, Function<ResourceLocation,T> factory, ExistingFileHelper existingFileHelper)

Method Summary

Modifier and Type	Method	Description
T	button(String name, ResourceLocation texture)
T	buttonInventory(String name, ResourceLocation texture)
T	buttonPressed(String name, ResourceLocation texture)
T	carpet(String name, ResourceLocation wool)
protected void	clear()
T	crop(String name, ResourceLocation crop)
T	cross(String name, ResourceLocation cross)
T	cube(String name, ResourceLocation down, ResourceLocation up, ResourceLocation north, ResourceLocation south, ResourceLocation east, ResourceLocation west)
T	cubeAll(String name, ResourceLocation texture)
T	cubeBottomTop(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	cubeColumn(String name, ResourceLocation side, ResourceLocation end)
T	cubeColumnHorizontal(String name, ResourceLocation side, ResourceLocation end)
T	cubeTop(String name, ResourceLocation side, ResourceLocation top)
private T	door(String name, String model, ResourceLocation bottom, ResourceLocation top)
T	doorBottomLeft(String name, ResourceLocation bottom, ResourceLocation top)
T	doorBottomLeftOpen(String name, ResourceLocation bottom, ResourceLocation top)
T	doorBottomRight(String name, ResourceLocation bottom, ResourceLocation top)
T	doorBottomRightOpen(String name, ResourceLocation bottom, ResourceLocation top)
T	doorTopLeft(String name, ResourceLocation bottom, ResourceLocation top)
T	doorTopLeftOpen(String name, ResourceLocation bottom, ResourceLocation top)
T	doorTopRight(String name, ResourceLocation bottom, ResourceLocation top)
T	doorTopRightOpen(String name, ResourceLocation bottom, ResourceLocation top)
private ResourceLocation	extendWithFolder(ResourceLocation rl)
T	fenceGate(String name, ResourceLocation texture)
T	fenceGateOpen(String name, ResourceLocation texture)
T	fenceGateWall(String name, ResourceLocation texture)
T	fenceGateWallOpen(String name, ResourceLocation texture)
T	fenceInventory(String name, ResourceLocation texture)
T	fencePost(String name, ResourceLocation texture)
T	fenceSide(String name, ResourceLocation texture)
protected CompletableFuture<?>	generateAll(CachedOutput cache)
T	getBuilder(String path)
ModelFile.ExistingModelFile	getExistingFile(ResourceLocation path)
protected Path	getPath(T model)
ResourceLocation	mcLoc(String name)
ResourceLocation	modLoc(String name)
T	nested()	Returns a model builder that's not directly saved to disk. Meant for use in custom model loaders..
T	orientable(String name, ResourceLocation side, ResourceLocation front, ResourceLocation top)
T	orientableVertical(String name, ResourceLocation side, ResourceLocation front)
T	orientableWithBottom(String name, ResourceLocation side, ResourceLocation front, ResourceLocation bottom, ResourceLocation top)
private T	pane(String name, String parent, ResourceLocation pane, ResourceLocation edge)
T	paneNoSide(String name, ResourceLocation pane)
T	paneNoSideAlt(String name, ResourceLocation pane)
T	panePost(String name, ResourceLocation pane, ResourceLocation edge)
T	paneSide(String name, ResourceLocation pane, ResourceLocation edge)
T	paneSideAlt(String name, ResourceLocation pane, ResourceLocation edge)
T	pressurePlate(String name, ResourceLocation texture)
T	pressurePlateDown(String name, ResourceLocation texture)
protected abstract void	registerModels()
CompletableFuture<?>	run(CachedOutput cache)
private T	sideBottomTop(String name, String parent, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	sign(String name, ResourceLocation texture)
private T	singleTexture(String name, String parent, String textureKey, ResourceLocation texture)
private T	singleTexture(String name, String parent, ResourceLocation texture)
T	singleTexture(String name, ResourceLocation parent, String textureKey, ResourceLocation texture)
T	singleTexture(String name, ResourceLocation parent, ResourceLocation texture)
T	slab(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	slabTop(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	stairs(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	stairsInner(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	stairsOuter(String name, ResourceLocation side, ResourceLocation bottom, ResourceLocation top)
T	torch(String name, ResourceLocation torch)
T	torchWall(String name, ResourceLocation torch)
T	trapdoorBottom(String name, ResourceLocation texture)
T	trapdoorOpen(String name, ResourceLocation texture)
T	trapdoorOrientableBottom(String name, ResourceLocation texture)
T	trapdoorOrientableOpen(String name, ResourceLocation texture)
T	trapdoorOrientableTop(String name, ResourceLocation texture)
T	trapdoorTop(String name, ResourceLocation texture)
T	wallInventory(String name, ResourceLocation wall)
T	wallPost(String name, ResourceLocation wall)
T	wallSide(String name, ResourceLocation wall)
T	wallSideTall(String name, ResourceLocation wall)
T	withExistingParent(String name, String parent)
T	withExistingParent(String name, ResourceLocation parent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.data.DataProvider

getName

Field Details

BLOCK_FOLDER

public static final String BLOCK_FOLDER

See Also:

• Constant Field Values

ITEM_FOLDER

public static final String ITEM_FOLDER

See Also:

• Constant Field Values

TEXTURE

protected static final ExistingFileHelper.ResourceType TEXTURE

MODEL

protected static final ExistingFileHelper.ResourceType MODEL

MODEL_WITH_EXTENSION

protected static final ExistingFileHelper.ResourceType MODEL_WITH_EXTENSION

GSON

private static final com.google.gson.Gson GSON

output

protected final PackOutput output

modid

protected final String modid

folder

protected final String folder

factory

protected final Function<ResourceLocation,T extends ModelBuilder<T>> factory

generatedModels

@VisibleForTesting
public final Map<ResourceLocation,T extends ModelBuilder<T>> generatedModels

existingFileHelper

@VisibleForTesting
public final ExistingFileHelper existingFileHelper

Constructor Details

ModelProvider

public ModelProvider(PackOutput output,
 String modid,
 String folder,
 Function<ResourceLocation,T> factory,
 ExistingFileHelper existingFileHelper)

ModelProvider

public ModelProvider(PackOutput output,
 String modid,
 String folder,
 BiFunction<ResourceLocation,ExistingFileHelper,T> builderFromModId,
 ExistingFileHelper existingFileHelper)

Method Details

registerModels

protected abstract void registerModels()

getBuilder

public T getBuilder(String path)

extendWithFolder

private ResourceLocation extendWithFolder(ResourceLocation rl)

modLoc

public ResourceLocation modLoc(String name)

mcLoc

public ResourceLocation mcLoc(String name)

withExistingParent

public T withExistingParent(String name,
 String parent)

withExistingParent

public T withExistingParent(String name,
 ResourceLocation parent)

cube

public T cube(String name,
 ResourceLocation down,
 ResourceLocation up,
 ResourceLocation north,
 ResourceLocation south,
 ResourceLocation east,
 ResourceLocation west)

singleTexture

private T singleTexture(String name,
 String parent,
 ResourceLocation texture)

singleTexture

public T singleTexture(String name,
 ResourceLocation parent,
 ResourceLocation texture)

singleTexture

private T singleTexture(String name,
 String parent,
 String textureKey,
 ResourceLocation texture)

singleTexture

public T singleTexture(String name,
 ResourceLocation parent,
 String textureKey,
 ResourceLocation texture)

cubeAll

public T cubeAll(String name,
 ResourceLocation texture)

cubeTop

public T cubeTop(String name,
 ResourceLocation side,
 ResourceLocation top)

sideBottomTop

private T sideBottomTop(String name,
 String parent,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

cubeBottomTop

public T cubeBottomTop(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

cubeColumn

public T cubeColumn(String name,
 ResourceLocation side,
 ResourceLocation end)

cubeColumnHorizontal

public T cubeColumnHorizontal(String name,
 ResourceLocation side,
 ResourceLocation end)

orientableVertical

public T orientableVertical(String name,
 ResourceLocation side,
 ResourceLocation front)

orientableWithBottom

public T orientableWithBottom(String name,
 ResourceLocation side,
 ResourceLocation front,
 ResourceLocation bottom,
 ResourceLocation top)

orientable

public T orientable(String name,
 ResourceLocation side,
 ResourceLocation front,
 ResourceLocation top)

crop

public T crop(String name,
 ResourceLocation crop)

cross

public T cross(String name,
 ResourceLocation cross)

stairs

public T stairs(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

stairsOuter

public T stairsOuter(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

stairsInner

public T stairsInner(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

slab

public T slab(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

slabTop

public T slabTop(String name,
 ResourceLocation side,
 ResourceLocation bottom,
 ResourceLocation top)

button

public T button(String name,
 ResourceLocation texture)

buttonPressed

public T buttonPressed(String name,
 ResourceLocation texture)

buttonInventory

public T buttonInventory(String name,
 ResourceLocation texture)

pressurePlate

public T pressurePlate(String name,
 ResourceLocation texture)

pressurePlateDown

public T pressurePlateDown(String name,
 ResourceLocation texture)

sign

public T sign(String name,
 ResourceLocation texture)

fencePost

public T fencePost(String name,
 ResourceLocation texture)

fenceSide

public T fenceSide(String name,
 ResourceLocation texture)

fenceInventory

public T fenceInventory(String name,
 ResourceLocation texture)

fenceGate

public T fenceGate(String name,
 ResourceLocation texture)

fenceGateOpen

public T fenceGateOpen(String name,
 ResourceLocation texture)

fenceGateWall

public T fenceGateWall(String name,
 ResourceLocation texture)

fenceGateWallOpen

public T fenceGateWallOpen(String name,
 ResourceLocation texture)

wallPost

public T wallPost(String name,
 ResourceLocation wall)

wallSide

public T wallSide(String name,
 ResourceLocation wall)

wallSideTall

public T wallSideTall(String name,
 ResourceLocation wall)

wallInventory

public T wallInventory(String name,
 ResourceLocation wall)

pane

private T pane(String name,
 String parent,
 ResourceLocation pane,
 ResourceLocation edge)

panePost

public T panePost(String name,
 ResourceLocation pane,
 ResourceLocation edge)

paneSide

public T paneSide(String name,
 ResourceLocation pane,
 ResourceLocation edge)

paneSideAlt

public T paneSideAlt(String name,
 ResourceLocation pane,
 ResourceLocation edge)

paneNoSide

public T paneNoSide(String name,
 ResourceLocation pane)

paneNoSideAlt

public T paneNoSideAlt(String name,
 ResourceLocation pane)

door

private T door(String name,
 String model,
 ResourceLocation bottom,
 ResourceLocation top)

doorBottomLeft

public T doorBottomLeft(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorBottomLeftOpen

public T doorBottomLeftOpen(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorBottomRight

public T doorBottomRight(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorBottomRightOpen

public T doorBottomRightOpen(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorTopLeft

public T doorTopLeft(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorTopLeftOpen

public T doorTopLeftOpen(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorTopRight

public T doorTopRight(String name,
 ResourceLocation bottom,
 ResourceLocation top)

doorTopRightOpen

public T doorTopRightOpen(String name,
 ResourceLocation bottom,
 ResourceLocation top)

trapdoorBottom

public T trapdoorBottom(String name,
 ResourceLocation texture)

trapdoorTop

public T trapdoorTop(String name,
 ResourceLocation texture)

trapdoorOpen

public T trapdoorOpen(String name,
 ResourceLocation texture)

trapdoorOrientableBottom

public T trapdoorOrientableBottom(String name,
 ResourceLocation texture)

trapdoorOrientableTop

public T trapdoorOrientableTop(String name,
 ResourceLocation texture)

trapdoorOrientableOpen

public T trapdoorOrientableOpen(String name,
 ResourceLocation texture)

torch

public T torch(String name,
 ResourceLocation torch)

torchWall

public T torchWall(String name,
 ResourceLocation torch)

carpet

public T carpet(String name,
 ResourceLocation wool)

nested

public T nested()

Returns a model builder that's not directly saved to disk. Meant for use in custom model loaders..

Returns:

a model builder that's not directly saved to disk. Meant for use in custom model loaders.

getExistingFile

public ModelFile.ExistingModelFile getExistingFile(ResourceLocation path)

clear

protected void clear()

run

public CompletableFuture<?> run(CachedOutput cache)

Specified by:

run in interface DataProvider

generateAll

protected CompletableFuture<?> generateAll(CachedOutput cache)

getPath

protected Path getPath(T model)