aboutsummaryrefslogtreecommitdiffstats
path: root/docs/task-types/essentials_balance-(task-type).md
blob: 07bd24ad7cf021e87e3353bc2ff0324db7d82aa9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
title: essentials_balance
parent: External task types
grand_parent: Task types
---

# essentials_balance (task type)

Since v2.12
{: .label .label-green }

Plugin 'Essentials' required
{: .label }

Reach a certain balance.

## Options

| Key      | Description          | Type    | Required | Default | Notes |
|----------|----------------------|---------|----------|---------|-------|
| `amount` | The amount to reach. | Integer | Yes      | \-      | \-    |

## Examples

Reach a balance of \$1000:

``` yaml
essentialsbalance:
  type: "essentials_balance"
  amount: 1000                          # amount of money to rach
```