Generic Peripherals and blocks

[SirEndii]

Greetings
Advanced Peripherals has note block integration.
I now wanted to move out of beta for our 1.21.1 version and fix these integrations. Since peripheral providers aren't a thing anymore, I wanted to port everything to generic peripherals.
But I am at a tricky point. Unless with generic peripherals where I can use tile entities to get a world, I can't do that with blocks.
But I need information about the block like the position and the world to do stuff with it, so I am unsure if there is a solution for this or if this is just completely unsupported, and we need to fire our sad note block.

Code in question: https://github.com/IntelligenceModding/AdvancedPeripherals/blob/0aa9fb06baefacaf193976dbcd0ddb1e177654ce/src/main/java/de/srendi/advancedperipherals/common/addons/computercraft/integrations/NoteBlockIntegration.java

[tehgreatdoge]

It seems you just need to register a PeripheralCapability for the block on neoforge, or add to PeripheralLookup on fabric. I'm not sure if this is possible to do with the generic peripheral system, I would assume not?
See: https://tweaked.cc/mc-1.21.x/javadoc/dan200/computercraft/api/peripheral/package-summary.html

[SquidDev]

Yeaaaaah. Block support for generic peripherals is one of the things I want to look at as part of the 1.21.5 changes, as we half need this for #1890. Whether this happens or not ... remains to been seen.

I think the interface I'm probably thinking of right now is something like:

interface BlockPeripheralTarget {
  ServerLevel level();
  BlockPos pos();
  BlockState state();
  @Nullable BlockEntity blockEntity();
  @Nullable Direction side();
}

Then peripherals look something like:

final class NoteBlockPeripheral implements GenericPeripheral {
  @LuaFunction(mainThread = true)
  public void playNote(BlockPeripheralTarget block) {
    // ...
  }
}

However, this requires a way to select what block(s) to apply to this peripheral to. The easiest way to do that is just have a canApply method on GenericPeripheral:

class NoteBlockPeripheral implements GenericPeripheral {
  public boolean canApply(Object target) {
    return target instanceof BlockPeripheralTarget block && block.state().block() == Blocks.NOTE_BLOCK;
  }

  // ...
}

However, I'm a little wary of the performance implications with this with a lot of providers registered. Maybe it's not actually that bad in practice though, something to measure.

---

For now though, as @tehgreatdoge, you can just use capabilities — those do now support blocks. That's mostly why IPeripheralProvider was removed — it's mostly the same as doing event.registerBlock(PeripheralCapability.get(), (level, pos, state, blockEntity, side) -> ..., BuiltinRegistries.BLOCK);. Though in your case, you'd want something like event.registerBlock(PeripheralCapability.get(), (level, pos, state, blockEntity, side) -> new NoteBlockIntegration(level, pos), Blocks.NOTE_BLOCK);.