OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationAction API — methods and examples

Action API — methods and examples

actions(), triggers(), conditions(), cooldowns() discover authored definitions. execute() invokes a registered action, testCondition() evaluates a named condition, and cooldownRemaining()/resetCooldown() operate on the player's tracked cooldown.

What methods are available?

  • List<ActionView> actions();
  • List<TriggerView> triggers();
  • List<ConditionView> conditions();
  • List<CooldownView> cooldowns();
  • Optional<ActionView> findAction(String id);
  • Optional<TriggerView> findTrigger(String id);
  • Optional<ConditionView> findCondition(String id);
  • Optional<CooldownView> findCooldown(String id);
  • ActionExecutionResult execute(String id, Player player);
  • ConditionEvaluation testCondition(String id, Player player);
  • long cooldownRemaining(Player player, String id);
  • boolean resetCooldown(Player player, String id);

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.