Package net.neoforged.neoforge.client.extensions

Interface IBakedModelExtension

All Known Subinterfaces:

BakedModel, IDynamicBakedModel

All Known Implementing Classes:

DelegateBakedModel, EmptyModel.Baked, MultiPartBakedModel, SimpleBakedModel, UnbakedCompositeModel.Baked, WeightedBakedModel

public interface IBakedModelExtension

Extension interface for BakedModel.

Method Summary

Modifier and Type	Method	Description
default void	applyTransform(ItemDisplayContext transformType, PoseStack poseStack, boolean applyLeftHandTransform)	Applies a transform for the given invalid reference ItemTransforms.TransformType and applyLeftHandTransform, and returns the model to be rendered.
default ModelData	getModelData(BlockAndTintGetter level, BlockPos pos, BlockState state, ModelData modelData)
default TextureAtlasSprite	getParticleIcon(ModelData data)
default List<BakedQuad>	getQuads(@Nullable BlockState state, @Nullable Direction side, RandomSource rand, ModelData data, @Nullable RenderType renderType)	A null RenderType is used for the breaking overlay as well as non-standard rendering, so models should return all their quads.
default List<BakedModel>	getRenderPasses(ItemStack itemStack)	Deprecated, for removal: This API element is subject to removal in a future version. Please migrate to ItemModels, or if this is not possible contact us at NeoForge.
default RenderType	getRenderType(ItemStack itemStack)	Gets the render type to use when drawing this item.
default ChunkRenderTypeSet	getRenderTypes(BlockState state, RandomSource rand, ModelData data)	Gets the set of render types to use when drawing this block in the level.
private BakedModel	self()
default TriState	useAmbientOcclusion(BlockState state, ModelData data, RenderType renderType)	Controls the AO behavior for all quads of this model.

Method Details

self

private BakedModel self()

getQuads

default List<BakedQuad> getQuads(@Nullable
 @Nullable BlockState state,
 @Nullable
 @Nullable Direction side,
 RandomSource rand,
 ModelData data,
 @Nullable
 @Nullable RenderType renderType)

A null RenderType is used for the breaking overlay as well as non-standard rendering, so models should return all their quads.

useAmbientOcclusion

default TriState useAmbientOcclusion(BlockState state,
 ModelData data,
 RenderType renderType)

Controls the AO behavior for all quads of this model. The default behavior is to use AO unless the block emits light, TriState.TRUE and TriState.FALSE force AO to be enabled and disabled respectively, regardless of the block emitting light or not. BakedQuad.hasAmbientOcclusion() can be used to disable AO for a specific quad even if this method says otherwise.

This method cannot force AO if the global smooth lighting video setting is disabled.

Parameters:

state - the block state this model is being rendered for

data - the model data used to render this model

renderType - the render type the model is being rendered with

Returns:

TriState.TRUE to force-enable AO, TriState.FALSE to force-disable AO or TriState.DEFAULT to use vanilla AO behavior

applyTransform

default void applyTransform(ItemDisplayContext transformType,
 PoseStack poseStack,
 boolean applyLeftHandTransform)

Applies a transform for the given

invalid reference

ItemTransforms.TransformType

and applyLeftHandTransform, and returns the model to be rendered.

getModelData

default ModelData getModelData(BlockAndTintGetter level,
 BlockPos pos,
 BlockState state,
 ModelData modelData)

getParticleIcon

default TextureAtlasSprite getParticleIcon(ModelData data)

getRenderTypes

default ChunkRenderTypeSet getRenderTypes(BlockState state,
 RandomSource rand,
 ModelData data)

Gets the set of render types to use when drawing this block in the level. Supported types are those returned by RenderType.chunkBufferLayers().

By default, defers query to ItemBlockRenderTypes.

getRenderType

default RenderType getRenderType(ItemStack itemStack)

Gets the render type to use when drawing this item. All render types using the DefaultVertexFormat.NEW_ENTITY format are supported.

This method will only be called on the models returned by getRenderPasses(ItemStack).

By default, defers query to ItemBlockRenderTypes.

See Also:

• getRenderPasses(ItemStack)

getRenderPasses

@Deprecated(forRemoval=true,
            since="1.21.4")
default List<BakedModel> getRenderPasses(ItemStack itemStack)

Deprecated, for removal: This API element is subject to removal in a future version.

Please migrate to ItemModels, or if this is not possible contact us at NeoForge.

Gets an ordered list of baked models used to render this model as an item. Each of those models' render type will be queried via getRenderType(ItemStack).

By default, returns the model itself.

See Also:

• getRenderType(ItemStack)