Block manager

About manager

Custom block manager is similar to custom items manager so for more info read About manager

Access the manager

Managers.getCustomBlockManager();
// or
CustomBlockManager.getManager();

Get registered custom block

CustomBlockManager manager = CustomBlockManager.getManager();

manager.customBlock("ID").ifPresent(block -> {
    // CODE
});
// OR
CustomBlock block = manager.customBlock("ID").orElse(null);

Get all registered blocks

CustomBlockManager manager = CustomBlockManager.getManager();
List<CustomBlock> blocks = manager.registeredCustomBlocks();

Register a block

CustomBlockManager manager = CustomBlockManager.getManager();
manager.register(new MyBlock());

Removing a custom block at position

CustomBlockManager manager = CustomBlockManager.getManager();
manager.removeAt(Block or Location);
// or | and
manager.removeAt(Block or Location, force?);

In the second method we see argument "force". Force means that this block will be deleted without notification AKA destroyRequest event will not fire for this instance of block.

Get a block at location

CustomBlockManager manager = CustomBlockManager.getManager();
manager.placedAt(Location).ifPresent((runtime) -> {
    // code
});
// OR
CustomBlockRuntime runtime = manager.placedAt(Location).orElse(null);

Get all blocks

CustomBlockManager manager = CustomBlockManager.getManager();
List<CustomBlockRuntime> blocks = manager.allBlocksPlaced();

All block placed by someone

This operation is may be slow since this method need to search through all blocks.

CustomBlockManager manager = CustomBlockManager.getManager();
List<CustomBlockRuntime> blocks = manager.allBlocksPlaced(Player.getUniqueId());

All block placed in area

This operation may be slow since this method need to search through all blocks.

CustomBlockManager manager = CustomBlockManager.getManager();
List<CustomBlockRuntime> blocks = manager.allBlockPlaced(Location 1, Location 2);

Place a block

CustomBlockManager manager = CustomBlockManager.getManager();
PlaceBlockOptions options = PlaceBlockOptions.builder()
    .block(CustomBlock) // REQUIRED
    .location(Location) // REQUIRED
    .owner(UUID) // Optional
    .replace(Boolean) // Optional
    .build();
manager.placeBlock(options).ifPresent((runtime) -> {
    // code
});
// OR
CustomBlockRuntime placedBlock = manager.placeBlock(options).orElse(null);