OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationEvents Reference

Events Reference

Obsidrel-Skript registers 23 Bukkit-backed event patterns. Their base syntax is on obsidrel <event name>:. All types have a registered Player conversion for Skript, but some individual events do not have an online player, for example an entity spawned without a player source. Do not assume that event-player always exists.

The Cancelable column reflects the Obsidrel public event classes implementing Bukkit's Cancellable interface. It does not guarantee that cancelling every event is supported by every external plugin or that every event has been independently runtime-tested.

All 23 events

Event syntaxCancelableobsidrel event id returns
on obsidrel action execute:YesAction ID
on obsidrel animation finish:NoDefinition ID
on obsidrel armor equip:NoArmor item ID
on obsidrel armor unequip:NoArmor item ID
on obsidrel armor set bonus:NoArmor set ID
on obsidrel block place:YesBlock definition ID
on obsidrel block break:YesBlock definition ID
on obsidrel cosmetic equip:YesCosmetic ID
on obsidrel cosmetic unequip:NoCosmetic ID
on obsidrel entity spawn:NoEntity definition ID
on obsidrel entity interact:YesEntity definition ID
on obsidrel entity death:NoEntity definition ID
on obsidrel furniture place:YesFurniture definition ID
on obsidrel furniture interact:YesFurniture definition ID
on obsidrel furniture break:YesFurniture definition ID
on obsidrel furniture seat:YesFurniture definition ID
on obsidrel item break:YesItem definition ID
on obsidrel item damage:YesItem definition ID
on obsidrel item use:YesItem definition ID
on obsidrel loot roll:YesLoot table ID
on obsidrel player data change:NoData key
on obsidrel state change:NoDefinition ID
on obsidrel trigger fire:YesTrigger ID

Read a custom resource ID

skript
on obsidrel furniture interact:
    send "Furniture: %obsidrel event id%" to event-player

This was tested with a player-initiated furniture interaction. For event types without a guaranteed player, avoid blindly sending to event-player; inspect whether the event has a valid online actor in your application.

Cancel a custom block operation

skript
on obsidrel block break:
    if obsidrel event id is "obsidrel:ruby_block":
        cancel event
        send "This block is protected." to event-player

This pattern was validated: the custom block remained in the world when the event was cancelled with a suitable tool.

Notes

  • obsidrel event id changes meaning by event type: e.g. block definition ID vs. Player Data key.
  • Skript event cancellation works only on cancellable underlying public events (see the table).
  • Only representative events (furniture interaction, block placement and block breaking) were individually exercised in the initial 1.0.0 validation. The other patterns are registered but need scenario-specific tests.
  • These are Obsidrel events, not general Bukkit on break or on interact handlers.
Was this article helpful?Loading ratings…

Help us improve Obsidrel documentation. One vote per account and article. Discord AI feedback can also contribute when the answer cites this article.