Package net.neoforged.neoforge.event

Class BlockEntityTypeAddBlocksEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.BlockEntityTypeAddBlocksEvent

All Implemented Interfaces:

IModBusEvent

public class BlockEntityTypeAddBlocksEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Allows injecting new blocks into a block entity's BlockEntityType.validBlocks field in a safe manner. The class of the newly injected block should share the highest common class that all existing blocks in the targeted validBlocks has. Please use this event instead of manipulating BlockEntityType directly.

Example: If the valid blocks list has StandingSignBlock entry and WallSignBlock entry, the common class is SignBlock, the given block must be a SignBlock or have SignBlock as a parent class in its hierarchy. Example:

public static void onBlockEntityValidBlocks(BlockEntityTypeAddBlocksEvent event) {
    event.modify(BlockEntityType.SIGN, MODDED_SIGN_BLOCK.get());
}

Field Summary

Fields

Modifier and Type	Field	Description
private final Function<BlockEntityType<?>,? extends Class<?>>	memoizedCommonSuperClass

Constructor Summary

Constructors

Constructor	Description
BlockEntityTypeAddBlocksEvent()

Method Summary

Modifier and Type	Method	Description
private void	addValidBlock(Block block, @Nullable Class<?> baseClass, Set<Block> currentValidBlocks)
private static Class<?>	findClosestCommonSuper(Class<?> superClass, Class<?> childClass)
private @Nullable Class<?>	getCommonSuperClassForExistingValidBlocks(Set<Block> validBlocks)
void	modify(BiPredicate<ResourceKey<BlockEntityType<?>>,BlockEntityType<?>> blockEntityTypeToMatch, Block... blocksToAdd)	Will add the given blocks to the matching BlockEntityType's set of valid blocks.
void	modify(ResourceKey<BlockEntityType<?>> blockEntityTypeKey, Block... blocksToAdd)	Will add the given blocks to the BlockEntityType's set of valid blocks.
void	modify(BlockEntityType<?> blockEntityType, Block... blocksToAdd)	Will add the given blocks to the provided BlockEntityType's set of valid blocks.

Methods inherited from class java.lang.Object

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

Field Details

memoizedCommonSuperClass

private final Function<BlockEntityType<?>,? extends Class<?>> memoizedCommonSuperClass

Constructor Details

BlockEntityTypeAddBlocksEvent

public BlockEntityTypeAddBlocksEvent()

Method Details

modify

public void modify(BlockEntityType<?> blockEntityType,
 Block... blocksToAdd)

Will add the given blocks to the provided BlockEntityType's set of valid blocks.

modify

public void modify(ResourceKey<BlockEntityType<?>> blockEntityTypeKey,
 Block... blocksToAdd)

Will add the given blocks to the BlockEntityType's set of valid blocks.

modify

public void modify(BiPredicate<ResourceKey<BlockEntityType<?>>,BlockEntityType<?>> blockEntityTypeToMatch,
 Block... blocksToAdd)

Will add the given blocks to the matching BlockEntityType's set of valid blocks.

addValidBlock

private void addValidBlock(Block block,
 @Nullable
 @Nullable Class<?> baseClass,
 Set<Block> currentValidBlocks)

getCommonSuperClassForExistingValidBlocks

@Nullable
private @Nullable Class<?> getCommonSuperClassForExistingValidBlocks(Set<Block> validBlocks)

findClosestCommonSuper

private static Class<?> findClosestCommonSuper(Class<?> superClass,
 Class<?> childClass)