Class DelegateBlockStateModel

java.lang.Object

net.neoforged.neoforge.client.model.DelegateBlockStateModel

All Implemented Interfaces:

BlockStateModel, BlockStateModelExtension

public abstract class DelegateBlockStateModel
extends Object
implements BlockStateModel

A BlockStateModel that delegates all calls to another BlockStateModel.

There is one exception: the BlockStateModelExtension.createGeometryKey(BlockAndTintGetter, BlockPos, BlockState, RandomSource) method, which is not delegated. The default implementation of this method returns null, meaning that the geometry of the delegate model cannot be cached using the key.

Nested Class Summary

Nested classes/interfaces inherited from interface BlockStateModel

BlockStateModel.SimpleCachedUnbakedRoot, BlockStateModel.Unbaked, BlockStateModel.UnbakedRoot

Field Summary

Fields

Modifier and Type	Field	Description
protected final BlockStateModel	delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegateBlockStateModel(BlockStateModel delegate)

Method Summary

Modifier and Type	Method	Description
void	collectParts(RandomSource random, List<BlockModelPart> parts)	Deprecated.
void	collectParts(BlockAndTintGetter level, BlockPos pos, BlockState state, RandomSource random, List<BlockModelPart> parts)	Collects the parts of the model that should be rendered.
boolean	hasTranslucency()	Deprecated.
boolean	hasTranslucency(BlockAndTintGetter level, BlockPos pos, BlockState state)	Returns whether this model contains any translucent quads.
Material.Baked	particleMaterial()	Deprecated.
Material.Baked	particleMaterial(BlockAndTintGetter level, BlockPos pos, BlockState state)	Returns the particle icon.

Methods inherited from class Object

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

Methods inherited from interface BlockStateModel

collectParts

Methods inherited from interface BlockStateModelExtension

collectParts, createGeometryKey

Field Details

delegate

protected final BlockStateModel delegate

Constructor Details

DelegateBlockStateModel

protected DelegateBlockStateModel(BlockStateModel delegate)

Method Details

collectParts

@Deprecated
public void collectParts(RandomSource random,
 List<BlockModelPart> parts)

Deprecated.

Specified by:

collectParts in interface BlockStateModel

collectParts

public void collectParts(BlockAndTintGetter level,
 BlockPos pos,
 BlockState state,
 RandomSource random,
 List<BlockModelPart> parts)

Description copied from interface: BlockStateModelExtension

Collects the parts of the model that should be rendered.

Typically called on a meshing worker thread, with a snapshot of world state. To access block entity data, use IBlockGetterExtension.getModelData(BlockPos) on the passed level. Avoid accessing or manipulating the block entities directly as they are not thread safe. Other world state is safe to access.

The parameters passed to this method might not be what the model expects. For example, the model data might be missing or coming from a different/outdated block entity, the block state in the level might be different from the one passed in, and so on... The model should handle these cases gracefully and return the best model it can (e.g. by returning a completely unconnected model, in the case of connected textures).

Calling IBlockStateExtension.getAppearance(BlockAndTintGetter, BlockPos, Direction, BlockState, BlockPos) before accessing the block state is recommended.

Specified by:

collectParts in interface BlockStateModelExtension

Parameters:

level - a level to query block entity data or other world state

pos - the position of the block being rendered

state - the state of the block being rendered

random - a random source for random model variations

parts - the list that should receive all parts to be rendered

particleMaterial

@Deprecated
public Material.Baked particleMaterial()

Deprecated.

Specified by:

particleMaterial in interface BlockStateModel

particleMaterial

public Material.Baked particleMaterial(BlockAndTintGetter level,
 BlockPos pos,
 BlockState state)

Description copied from interface: BlockStateModelExtension

Returns the particle icon.

Block entity data can be accessed using IBlockGetterExtension.getModelData(BlockPos).

Specified by:

particleMaterial in interface BlockStateModelExtension

hasTranslucency

@Deprecated
public boolean hasTranslucency()

Deprecated.

Specified by:

hasTranslucency in interface BlockStateModel

hasTranslucency

public boolean hasTranslucency(BlockAndTintGetter level,
 BlockPos pos,
 BlockState state)

Description copied from interface: BlockStateModelExtension

Returns whether this model contains any translucent quads.

Specified by:

hasTranslucency in interface BlockStateModelExtension

Parameters:

level - a level to query block entity data or other world state

pos - the position of the block being rendered

state - the state of the block being rendered