Developer API

ExcellentJobs provides a robust and easy-to-use API for developers looking to integrate their plugins with it.

Replace {VERSION} with the latest version shown on the badge below:

Repository:

<repository>
  <id>nightexpress-releases</id>
  <url>https://repo.nightexpressdev.com/releases</url>
</repository>

Dependency:

<dependency>
  <groupId>su.nightexpress.excellentjobs</groupId>
  <artifactId>ExcellentJobs</artifactId>
  <version>{VERSION}</version>
  <scope>provided</scope>
</dependency>

Repository:

maven { url = 'https://repo.nightexpressdev.com/releases' }

Dependency:

compileOnly("su.nightexpress.excellentjobs:ExcellentJobs:{VERSION}")

Events

The following events are available:

  • GrindRewardEvent Cancellable - Called when a player is entitled to a reward for completing objectives.
  • GrindRewardProceedEvent Cancellable - Called before giving a reward to a player (after all calculations).
  • JobJoinEvent Cancellable - Called when a player is about to join a job.
  • JobLeaveEvent Cancellable - Called when a player is about to leave a job.
  • JobLevelDownEvent - Called when a player loses a job level.
  • JobLevelUpEvent - Called when a player levels up a job.
  • JobMenuDefineLayoutEvent - Called when the Jobs GUI determines which items should be in this menu.
  • StatsLoadTrackersEvent - Called when the Stats module loads trackers.

API Usage

Plugin API layer will be available soon!