BitAspire Wiki
XenoTokensXenoTokens

Event Catalog

How XenoTokens uses the shared Event Catalog.

XenoTokens uses the shared Event Catalog as the event-expression layer behind currency earning rules. This page explains how XTK applies the shared catalog inside each currency.

Canonical event list

For the full event reference, aliases, and shared argument catalog, start with the shared Event Catalog.

Where XTK uses events

XTK areaWhy it matters
currencies/<id>/events.ymlDefines how a specific currency is earned
Per-currency reward flowReuses the same event language while rolling currency amounts instead of EXP

How XTK rewards matching events

PatternXTK behavior
Direct events like KILL_MOB or BREAK_BLOCKMatching expressions roll amount once per valid occurrence.
EXCESSIVE events like SMELT, DROP_ITEM, and PICKUP_ITEM[count] is treated as the payout threshold, and partial-excessive: true allows proportional leftovers.
Batched NO_ARGS events like MOVE, JUMP, SNEAK, SPRINT, or SWIMXTK batches hits and multiplies the rolled amount by the number of hits paid on that interval.
TIMED_EXP[count]XTK rolls the configured amount once every count seconds.

Reward gating in XTK

  • apply.on-creative blocks or allows rewards while the player is in creative mode.
  • apply.permission adds a plugin-level permission gate before the reward is paid.
  • Expression filters such as TIMED_EXP[300]:PERMISSION=group.vip still work through the shared event engine.

XTK-oriented examples

  • KILL_MOB:TYPE_EXACT=ZOMBIE
  • SMELT[16]:ITEM=IRON_INGOT
  • MOVE[60]
  • TIMED_EXP[300]:PERMISSION=group.vip

Next reading

  1. Configure earning rules in events.yml.
  2. Pair those rewards with Currencies and Ranges and Shop System.
  3. Keep shared syntax changes aligned with the shared Event Catalog.

Last updated on

On this page