OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationHud API — methods and examples

Hud API — methods and examples

Show, hide and toggle an existing HUD by ID for a player. resetPreferences() removes that player's stored HUD preferences. This API controls display; define HUD content in resources/ui.

What methods are available?

  • List<HudView> all();
  • Optional<HudView> find(String id);
  • boolean show(Player player, String id);
  • boolean hide(Player player, String id);
  • boolean toggle(Player player, String id);
  • void resetPreferences(Player player);

These signatures are read directly from the public ObsidrelAPI 1.0 service interface. An Optional result can be empty, boolean results can indicate failure and views are public read-only projections rather than mutable Core objects.

Practical steps

  1. Add ObsidrelAPI as a provided (Maven) or compileOnly (Gradle) dependency. 2. Check Obsidrel is running and fetch ObsidrelProvider.require(1). 3. Call the matching service with an ID that is already loaded. 4. Handle missing values and failures before showing messages to players. 5. Test on a staging server with the exact Core version.

Troubleshooting

If lookup fails, check the resource ID and whether it loaded in Core. If provider lookup fails, confirm the plugin dependency, Core startup and API level. Do not link to private implementation classes; the supported contract is the public me.antzbr.obsidrel.api.* package.

See: API setup · Service catalog.

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.