Jobs Reborn

https://github.com/zrips/jobs
Admin
Jobs Reborn is a Minecraft plugin that enhances the gaming experience by allowing players to choose...
Tokens:19,730
Snippets:202
Trust Score:8.3
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Handle JobsScheduleStartEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsScheduleStartEvent, which is called when the schedule starts. Logs an info message if the schedule is started.

```java
@EventHandler
public void onJobsScheduleStart(JobsScheduleStartEvent ev) {
    if (e.getSchedule().isStarted()) {
        Bukkit.getLogger().log(Level.INFO, "The scheduler has started.");
    }
}
```

--------------------------------

### Set Jobs permissions with LuckPerms

Source: https://github.com/zrips/jobs/blob/master/README.md

Example LuckPerms commands to set the default group's jobs.use and jobs.max.1 permissions, and the donator group's jobs.max.2 permission.

```text
lp group default permission set jobs.use true
lp group default permission set jobs.max.1 true
lp group donator permission set jobs.max.2 true
```

--------------------------------

### Get unmodifiable jobs list

Source: https://github.com/zrips/jobs/wiki/API

Gets an unmodifiable list of all jobs.

```java
Jobs.getJobs();
```

--------------------------------

### Get player's job progression list

Source: https://github.com/zrips/jobs/wiki/API

Gets the player's job progression list (unmodifiable) and iterates over it. Checks for null before accessing the list.

```java
JobsPlayer jobsPlayer = Jobs.getPlayerManager().getJobsPlayer(player);

if (jobsPlayer != null) {
    List<JobProgression> jobs = jobsPlayer.getJobProgression();

    for (JobProgression prog : jobs) {
      // Do your stuff here
    }
}
```

--------------------------------

### Jobs.getJobs()

Source: https://github.com/zrips/jobs/wiki/API

Gets an unmodifiable list of all jobs.

```APIDOC
## Jobs.getJobs()

### Description
Gets an unmodifiable jobs list.

### Syntax
```java
Jobs.getJobs();
```

### Parameters
None.

### Returns
- **List<Job>** - An unmodifiable list of all jobs.
```

--------------------------------

### JobsScheduleStartEvent (cancellable)

Source: https://github.com/zrips/jobs/wiki/API

Called when a schedule starts. Can be cancelled to prevent the schedule from starting.

```APIDOC
## JobsScheduleStartEvent

### Description
The event is called when started the schedule. This event is cancellable.

### Event Handler
```java
@EventHandler
public void onJobsScheduleStart(JobsScheduleStartEvent ev) {
    if (e.getSchedule().isStarted()) {
        Bukkit.getLogger().log(Level.INFO, "The scheduler has started.");
    }
}
```

### Event Properties
- **getSchedule()** - Returns the schedule object that started, with `isStarted()` method.

### Cancellable
This event can be cancelled using `event.setCancelled(true)`.
```

--------------------------------

### JobsPlayer.getJobProgression()

Source: https://github.com/zrips/jobs/wiki/API

Gets an unmodifiable list of job progressions for the player.

```APIDOC
## JobsPlayer.getJobProgression()

### Description
Gets the player's job progression list (unmodifiable).

### Syntax
```java
List<JobProgression> jobs = jobsPlayer.getJobProgression();
```

### Parameters
None.

### Returns
- **List<JobProgression>** - An unmodifiable list of job progressions.
```

--------------------------------

### Get JobsPlayer object

Source: https://github.com/zrips/jobs/wiki/API

Gets the JobsPlayer object for a player. This method can return null if the player is not cached in memory.

```java
JobsPlayer jobsPlayer = Jobs.getPlayerManager().getJobsPlayer(player);
```

--------------------------------

### Jobs.getPlayerManager().getJobsPlayer(player)

Source: https://github.com/zrips/jobs/wiki/API

Gets the JobsPlayer object for a given player. Returns null if the player is not cached.

```APIDOC
## Jobs.getPlayerManager().getJobsPlayer(player)

### Description
Gets the player's information object (JobsPlayer). Returns null if the player is not cached into memory.

### Syntax
```java
JobsPlayer jobsPlayer = Jobs.getPlayerManager().getJobsPlayer(player);
```

### Parameters
- **player** (Player) - The player to get information for.

### Returns
- **JobsPlayer** - The player's information object, or null if not cached.
```

--------------------------------

### Basic player permissions for Jobs-Reborn

Source: https://github.com/zrips/jobs/blob/master/README.md

Basic permission nodes for players to use the Jobs-Reborn plugin, including browsing, joining, leaving, and viewing stats, plus world-specific payment permissions. Requires a permission manager.

```text
jobs.command.browse
jobs.command.info
jobs.command.join
jobs.command.leave
jobs.command.stats
jobs.command.top
jobs.join.*
jobs.max.3
jobs.use
jobs.world.world_overworld
jobs.world.world_theend
jobs.world.world_thenether
```

--------------------------------

### Add Jobs API with Gradle

Source: https://github.com/zrips/jobs/blob/master/README.md

Gradle configuration to add the Jobs API via Jitpack. Use the implementation configuration for the dependency.

```gradle
repositories {
    maven { 
        url 'https://jitpack.io' 
    }
}
dependencies {
    implementation 'com.github.Zrips:Jobs:v5.2.6.2'
}
```

--------------------------------

### Add Jobs API with Maven

Source: https://github.com/zrips/jobs/blob/master/README.md

Maven configuration to add the Jobs API via Jitpack. Use the provided scope for the dependency.

```xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.Zrips</groupId>
        <artifactId>Jobs</artifactId>
        <version>v5.2.6.2</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

--------------------------------

### Handle JobsExpGainEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsExpGainEvent, which is called when a player gains experience from a job. Sends a message to the player with the amount of experience gained and the job name.

```java
@EventHandler
public void onJobsExpGain(JobsExpGainEvent event) {
    event.getPlayer().sendMessage("You got " + event.getExp() + " amount exp in job " + event.getJob().getName());
}
```

--------------------------------

### Handle JobsPrePaymentEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsPrePaymentEvent, which is fired before the payment calculation process begins. Cancels the event to prevent income, and sends messages to the player.

```java
@EventHandler
public void onJobsPrePayment(JobsPrePaymentEvent e) {
    e.getPlayer().sendMessage("Payment event is cancelled in " + e.getJob().getName() + " job!");
    e.getPlayer().sendMessage("You not get any income for doing actions.");
    e.setCancelled(true);
}
```

--------------------------------

### Handle JobsLevelUpEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsLevelUpEvent, which is called when a player levels up in a job. Sends a message to the player confirming the level up.

```java
@EventHandler
public void onJobsLevelUp(JobsLevelUpEvent event) {
    event.getPlayer().getPlayer().sendMessage("You have leveled up in " + event.getJob().getName() + " job!");
}
```

--------------------------------

### JobsExpGainEvent (cancellable)

Source: https://github.com/zrips/jobs/wiki/API

Called when a player gains experience from a job. Can be cancelled to prevent experience gain.

```APIDOC
## JobsExpGainEvent

### Description
The event is called when a player gain exp from job. This event is cancellable.

### Event Handler
```java
@EventHandler
public void onJobsExpGain(JobsExpGainEvent event) {
    event.getPlayer().sendMessage("You got " + event.getExp() + " amount exp in job " + event.getJob().getName());
}
```

### Event Properties
- **getPlayer()** - Returns the player who gained experience.
- **getExp()** - Returns the amount of experience gained.
- **getJob()** - Returns the job from which experience was gained.

### Cancellable
This event can be cancelled using `event.setCancelled(true)`.
```

--------------------------------

### Handle JobsPaymentEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsPaymentEvent, which is called when calculating the payment. Sends a message to the player with the amount of money received.

```java
@EventHandler
public void onJobsPayment(JobsPaymentEvent event) {
    event.getPlayer().sendMessage("You got " + event.get(CurrencyType.MONEY) + " money!");
}
```

--------------------------------

### Handle JobsJoinEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsJoinEvent, which is called when a player joins a specified job. Sends a message to the player confirming the join.

```java
@EventHandler
public void onJobsJoin(JobsJoinEvent event) {
    event.getPlayer().getPlayer().sendMessage("You have joined to " + event.getJob().getName() + " job!");
}
```

--------------------------------

### JobsPrePaymentEvent (cancellable)

Source: https://github.com/zrips/jobs/wiki/API

Fired before the payment calculation process begins. Can be cancelled to prevent payment processing.

```APIDOC
## JobsPrePaymentEvent

### Description
Event fired, before the payment calculation process should beginning. This event is cancellable.

### Event Handler
```java
@EventHandler
public void onJobsPrePayment(JobsPrePaymentEvent e) {
    e.getPlayer().sendMessage("Payment event is cancelled in " + e.getJob().getName() + " job!");
    e.getPlayer().sendMessage("You not get any income for doing actions.");
    e.setCancelled(true);
}
```

### Event Properties
- **getPlayer()** - Returns the player involved in the payment.
- **getJob()** - Returns the job for which the payment is about to be calculated.

### Cancellable
This event can be cancelled using `event.setCancelled(true)`.
```

--------------------------------

### Handle JobsScheduleStopEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsScheduleStopEvent, which is called when the schedule stops. Logs an info message if the schedule is stopped.

```java
@EventHandler
public void onJobsScheduleStop(JobsScheduleStopEvent ev) {
    if (e.getSchedule().isStoped()) {
        Bukkit.getLogger().log(Level.INFO, "The scheduler has stopped.");
    }
}
```

--------------------------------

### JobsLevelUpEvent (cancellable)

Source: https://github.com/zrips/jobs/wiki/API

Called when a player levels up in a job. Can be cancelled to prevent level up.

```APIDOC
## JobsLevelUpEvent

### Description
The event is called when a player leveled up in that job. This event is cancellable.

### Event Handler
```java
@EventHandler
public void onJobsLevelUp(JobsLevelUpEvent event) {
    event.getPlayer().getPlayer().sendMessage("You have leveled up in " + event.getJob().getName() + " job!");
}
```

### Event Properties
- **getPlayer()** - Returns the player who leveled up.
- **getJob()** - Returns the job in which the player leveled up.

### Cancellable
This event can be cancelled using `event.setCancelled(true)`.
```

--------------------------------

### Handle JobsChunkChangeEvent

Source: https://github.com/zrips/jobs/wiki/API

Handles the JobsChunkChangeEvent, which is called when the chunk has changed. Sends a message to the player with the new chunk information.

```java
@EventHandler
public void onJobsChunkChange(JobsChunkChangeEvent event) {
    event.getPlayer().sendMessage("The new chunk is: " + event.getNewChunk());
}
```

--------------------------------

### JobsJoinEvent (cancellable)

Source: https://github.com/zrips/jobs/wiki/API

Called when a player joins a specified job. Can be cancelled to prevent joining.

```APIDOC
## JobsJoinEvent

### Description
The event is called when a player join to a specified job. This event is cancellable.

### Event Handler
```java
@EventHandler
public void onJobsJoin(JobsJoinEvent event) {
    event.getPlayer().getPlayer().sendMessage("You have joined to " + event.getJob().getName() + " job!");
}
```

### Event Properties
- **getPlayer()** - Returns the player who joined.
- **getJob()** - Returns the job that the player joined.

### Cancellable
This event can be cancelled using `event.setCancelled(true)`.
```
Tokens:
Raw