net.minecraftforge.client.model

Interface IModel<T extends IModel<T>>

All Known Subinterfaces:

IUnbakedModel

All Known Implementing Classes:

ItemLayerModel, ModelBlock, ModelDynBucket, ModelFluid, MultiLayerModel, MultiModel, Multipart, OBJModel, VariantList

public interface IModel<T extends IModel<T>>

Method Summary

Modifier and Type	Method and Description
IBakedModel	bake(java.util.function.Function<ResourceLocation,IUnbakedModel> modelGetter, java.util.function.Function<ResourceLocation,TextureAtlasSprite> spriteGetter, IModelState state, boolean uvlock, VertexFormat format)
default java.util.Optional<? extends IClip>	getClip(java.lang.String name)
default IModelState	getDefaultState()
default T	gui3d(boolean value)
default T	process(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> customData) Allows the model to process custom data from the variant definition.
default T	retexture(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> textures) Applies new textures to the model.
default T	smoothLighting(boolean value)

Method Detail

bake

@Nullable
IBakedModel bake(java.util.function.Function<ResourceLocation,IUnbakedModel> modelGetter,
                           java.util.function.Function<ResourceLocation,TextureAtlasSprite> spriteGetter,
                           IModelState state,
                           boolean uvlock,
                           VertexFormat format)

getDefaultState

default IModelState getDefaultState()

getClip

default java.util.Optional<? extends IClip> getClip(java.lang.String name)

process

default T process(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> customData)

Allows the model to process custom data from the variant definition. If unknown data is encountered it should be skipped.

Returns:

a new model, with data applied.

smoothLighting

default T smoothLighting(boolean value)

gui3d

default T gui3d(boolean value)

retexture

default T retexture(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> textures)

Applies new textures to the model. The returned model should be independent of the accessed one, as a model should be able to be retextured multiple times producing a separate model each time. The input map MAY map to an empty string "" which should be used to indicate the texture was removed. Handling of that is up to the model itself. Such as using default, missing texture, or removing vertices. The input should be considered a DIFF of the old textures, not a replacement as it may not contain everything.

Parameters:

textures - New

Returns:

Model with textures applied.