# Options

## Base

Base information about the map.

{% hint style="warning" %}
Do not change the identifier! It can cause issues.
{% endhint %}

```yaml
Base:
  Identifier: 8b2d5e6a-7a98-4cf9-af33-927db2de003f
  Name: Welcome #Name of the map, supports UTF-8 characters.
  State: ACCESSIBLE
  CreatedDate: '2025-10-05T20:26:54.651899'
```

#### Available states:

* `MAINTENANCE` - Map is in maintenance mode. No one can join.
* `ACCESSIBLE` - Map is accessible.
* `LOCKED_BY_ADMINISTRATOR` - Map is locked by an administrator.

## Management

Transferring ownership to another player.

Invite contributors to help the author with the management of the map. Contributors have restricted access based on authorized actions by the author.

```yaml
Management:
  Author:
    UUID: e2c593d6-f250-4e63-a26e-417650d0e77a #UUID of the owner of the map.
  Contributor:
    39b1f5c2-3d9f-4d31-a219-2cf28f878ee0: #UUID of the contributor.
      AuthorizedActionList:
        - SET_UP
```

#### Available Actions:

* `MAINTENANCE__ENABLE` - Ability to enable maintenance mode
* `MAINTENANCE__DISABLE` - Ability to disable maintenance mode
* `SET_UP` - Ability to manage with a map
* `REMOVE` - Ability to remove map
* `POINT__START` - Ability to set start point
* `POINT__FINISH` - Ability to set finish point
* `POINT__CHECK_POINT` - Ability to set checkpoint
* `POINT__ACTION__LEAVE` - Ability to set action leave point
* `POINT__ACTION__FINISH` - Ability to set action finish point
* `FIGURE` - Ability to manipulate with a figure
* `RELOAD` - Ability to reload map

## Options

#### Base

Base properties, no need to explain.

```yaml
Option:
  Capacity: 16
  Speed: 0.2
  Difficulty: NONE
  Category:
    - NONE
  Potion:
    List: [ ]
```

#### Quick Start

Allows starting the race by step on the start location.

Hologram at the start will be displayed.

```yaml
Option:
  QuickStart:
    Active: true
```

#### Teleport

Rules, where to move player after completing the race.

**MapLeave** By disabling this option, players are not moved from the finish line after completing the race. Otherwise, they are teleported to a specified location.

**LastLocation** Player is moved to the last location, where he stood before the race.

```yaml
Option:
  Teleport:
    MapLeave: true
    LastLocation: false
```

#### Prologue

To add more adventure, the player does not see the surroundings after joining the map for a specified amount of time.

```yaml
Option:
  Prologue:
    Active: false
    Duration: 3
```

#### SuspiciousBehavior

Some players are trying to beat the record with illegal techniques!

System is able to detect this behaviour and kick them out of map.

```yaml
Option:
  SuspiciousBehavior:
    Air: #Staying in the air for too long can be considered as an illegal technique.
      Active: true
      Duration: 2.0
    PassAllPoints: #Requirement to pass all checkpoints to be able to complete the race.
      Active: false
```

#### Requirements

To be able to start the race, the player has to meet all requirements assigned to this map.

This allows you to create a whole story on your server when players have to complete the races in a specified order.

**Required Rank**

Rank required to access the Parkour Map.

```yaml
Option:
  Requirement:
    Rank: FLEA
```

**Previous Map**

Player has to complete a specified map before accessing this map.

Additionally, you can specify the limit of the previous map.

E.g. Player has to complete a map below 25 seconds.

```yaml
Option:
  Requirement:
    PreviousMap:
      Id: 8b2d5e6a-7a98-4cf9-af33-927db2de4325 #ID of the previous map. There is a recommendation to use in-game GUI to set up these values.
      DecisiveValueLimit: 25000 #Value is in milliseconds.
```

**Lock**

To unlock the map, the player must purchase it in the store.

```yaml
Option:
  Requirement:
    Lock:
      Active: true
      Currency: "VAULT_WRAPPER"
      Price: 10
```

**PlayTime**

Played timed required to enter the map.

* `Total` - Total time spent on the server.
  * Example: Player has to play for at least 5 Days(7200 Minutes) to be able to join the map.
* `Today` - Today's time spent on the server. Probably most used
  * Example: Player has to play for at least 30 Minutes **that day** to be able to join the map.
* `Session` - Time spent on the server since player logged in.
  * Example: Player has to be **online** for at least 30 Minutes to be able to join the map.

```yaml
Option:
  Requirement:
    PlayTime:
      TotalMinute: 0
      TodayMinute: 0
      SessionMinute: 0
```

{% hint style="warning" %}
To disable PlayTime Requirement, keep all values to `0`.
{% endhint %}

## Exclusive Blocks

Exclusive Blocks act as dynamic triggers that execute unique actions a player makes contact.

#### Bottom Border

Stepping on the specified block or reaching below the Y-Coordinate is considered as fall.

```yaml
ExclusiveBlock:
  BottomBorder:
    Coordination: 0.0
    Material:
      - BARRIER
```

#### Jump Simulation

Stepping on the specified block lifts the player up with the specified power.

```yaml
ExclusiveBlock:
  JumpSimulation:
    Power: 1.0
    Material:
      - DIAMOND_BLOCK
```

## Sounds

Sounds improve the player's experience while racing the map. These spatial cues enhance player immersion and clearly signal success or mistakes throughout the course.

{% hint style="info" %}
There is recommended to use in-game GUI to set up these values.
{% endhint %}

## Figure

Via **Figure**, players are able to join the map. This figure also displays the current status of the map.

System offers pre-defined **Armor Stand**, with clothes and head. All values can be changed in the configuration file. System also supports **NPC**, you can aslo equip it with armor or items.

{% hint style="warning" %}
Warning at placing the Figure. Figure copies your locations and also facing direction!
{% endhint %}

{% hint style="info" %}
To place a figure type: `/Parkour MapManagement Figure Place <MapName>`
{% endhint %}

### Mode

List of modes mentioned above:

* `NONE`
* `ARMOR_STAND`
* `PLAYER`
* `HOLOGRAM`

```yaml
Figure:
  Mode: PLAYER
```

### Particle

Particles are spawning around the spawned Figure. You can keep them active or disable them. Also, you can change Effect, Color, Speed and Amount.

```yaml
Figure:
  Particle:
    Active: true
    TickDelay: 13 #How fast particles are spawned. (20 ticks = 1 second)
    Data:
      Effect: SPELL_WITCH
      Amount: 35
      Speed: 1.0 #Optional, Default 1.0
      Color: "255:255:255" #Optional, Default White
      Offest: #Optional, Offset from Figures's location. (Vector)
        X: .5
        Y: .5
        Z: .5
```

## Reward

Rewarding system for completing the race.

{% hint style="warning" %}
There is expected that rewards are created, yet! To create rewards, check this tutorial: [How to create Reward](https://wiki.innouniq.com/plugins/thecore/configuration/centralized-reward-repository)
{% endhint %}

{% hint style="info" %}
To allow players to increase their rank, assign SkillPoint Reward for each type of completion.
{% endhint %}

{% hint style="info" %}
There is recommended to use in-game GUI to set up these values.
{% endhint %}

```yaml
Reward:
  Daily:
    Active: true #By enabling this option, the reward for completing the race for the first time in a day is higher as common rewards.
  ChoiceType: QUICK__ALL #Method of rewarding players for completing the race.
  List:
    First:
      Overall:
        - P_SP_5
      Day:
        - P_SP_1
    Repeat:
      - P_SP_1
```

**Choice Types:**

* `QUICK__ALL` - All assigned rewards are given to player
* `QUICK__CHANCE` - One reward is selected from an assigned list by probability

Example for **probability**. `DiamondTools` has 90% chance, `MoneyPocket` has 10% chance to win.

{% hint style="danger" %}
Summary of probability at assinged rewards has to be **100.0**! Otherwise, system won't work correctly!
{% endhint %}

```yaml
Reward:
  ChoiceType: QUICK__CHANCE
  List:
    First:
      Overall:
      - DiamondTools:90.0
      - MoneyPocket:10.0
```