Chapter 5

Value Provider

A unit that provides values to the Top Holder. Continue reading to learn more about the built-in value providers.

Subsections of Value Provider

Statistic

This is a provider that provides statistic values of a player to the Top Holder.

Format

​
holders:
  <holder-name>:
    # The type of the provider
    type: statistic
    # The name of the statistic
    statistic: <statistic>
    # The name of the material. Used for some statistics that require an item.
    material: <material>
    # The name of the entity. Used for some statistics that require an entity.
    entity: <entity>
  • Available values for <statistic> can be found here
  • Available values for <material> can be found here
  • Available values for <entity> can be found here
{
  "holders": {
    "<holder-name>": {
      // The type of the provider
      "type": "statistic",
      // The type of the statistic
      "statistic-type": "<statistic-type>",
      // The name of the statistic
      "statistic": "<statistic>"
    }
  }
}
  • The available <statistic-type> and <statistic> can be found here

Behavior

​

  • If the statistic is a Generic type, the material and entity fields are ignored. The provider will return the value of the statistic for the player.

  • If the statistic is a Material type, the material field will be used:

    • If the material is not specified, the provider will return the value of the statistic for all materials.
    • If the material is specified, the provider will return the value of the statistic for the specified material.
    • The material field can be a string or a list of strings.
material: STONE

material:
  - STONE
  - COBBLESTONE
  • If the statistic is an Entity type, the entity field will be used:
    • If the entity is not specified, the provider will return the value of the statistic for all entities.
    • If the entity is specified, the provider will return the value of the statistic for the specified entity.
    • The entity field can be a string or a list of strings.
entity: ZOMBIE

entity:
  - ZOMBIE
  - SKELETON
  • If the statistic-type is not specified, it will default to minecraft:custom.
  • If the statistic-type is minecraft:custom, the value of the statistic field will be one of the Custom statistic names
  • If the statistic-type is one of the ITEM types (e.g. minecraft:broken, minecraft:crafted, minecraft:used, minecraft:picked_up, etc.), the value of the statistic field will be one of the Items
  • If the statistic-type is one of the ENTITY types (e.g. minecraft:killed, minecraft:killed_by, etc.), the value of the statistic field will be one of the Entities
  • If the statistic-type is one of the BLOCK types (e.g. minecraft:mined, minecraft:broken, etc.), the value of the statistic field will be one of the Blocks

Example

​
holders:
  # Holder that shows the number of times a player has jumped
  jump:
    type: statistic
    statistic: JUMP
  # Holder that shows the number of blocks mined by a player
  mine:
    type: statistic
    statistic: MINE_BLOCK
  # Holder that shows the number of times a player has killed a zombie
  zombie:
    type: statistic
    statistic: KILL_ENTITY
    entity: ZOMBIE
  # Holder that shows the number of times a player has mined diamond ore
  diamond:
    type: statistic
    statistic: MINE_BLOCK
    material: DIAMOND_ORE
  # Holder that shows the number of times a player has mined diamond ore or gold ore
  diamond_or_gold:
    type: statistic
    statistic: MINE_BLOCK
    material:
      - DIAMOND_ORE
      - GOLD_ORE
  # Holder that shows the number of times a player has killed a zombie or a skeleton
  zombie_or_skeleton:
    type: statistic
    statistic: KILL_ENTITY
    entity:
      - ZOMBIE
      - SKELETON
{
  "holders": {
    // Holder that shows the number of times a player has jumped
    "jump": {
      "type": "statistic",
      "statistic": "minecraft:jump"
    },
    // Holder that shows the number of times a player has mined a block
    "mine": {
      "type": "statistic",
      "statistic-type": "minecraft:mined"
    },
    // Holder that shows the number of times a player has killed a zombie
    "zombie": {
      "type": "statistic",
      "statistic-type": "minecraft:killed",
      "statistic": "minecraft:zombie"
    },
    // Holder that shows the number of times a player has mined diamond ore
    "diamond": {
      "type": "statistic",
      "statistic-type": "minecraft:mined",
      "statistic": "minecraft:diamond_ore"
    },
    // Holder that shows the number of times a player has mined diamond ore or gold ore
    "diamond_or_gold": {
      "type": "statistic",
      "statistic-type": "minecraft:mined",
      "statistic": [
        "minecraft:diamond_ore",
        "minecraft:gold_ore"
      ]
    },
    // Holder that shows the number of times a player has killed a zombie or a skeleton
    "zombie_or_skeleton": {
      "type": "statistic",
      "statistic-type": "minecraft:killed",
      "statistic": [
        "minecraft:zombie",
        "minecraft:skeleton"
      ]
    }
  }
}

Placeholder

This is a provider that allows you to use PlaceholderAPI placeholders as values in the Top Holder.

Format

​
Note

Requires PlaceholderAPI

holders:
  <holder-name>:
    # The type of the provider
    type: placeholder
    # The placeholder used to get the value
    placeholder: <placeholder>
    # Whether the placeholder should be parsed for online players only (Those who are in the server). Default is true.
    # If set to false, the placeholder will be parsed for all players, even those who are offline.
    online: <true/false>
Note

The placeholders are provided by Text Placeholder API You can check its wiki for more information: Wiki

{
  "holders": {
    "<holder-name>": {
      // The type of the provider
      "type": "placeholder",
      // The placeholder used to get the value
      "placeholder": "<placeholder>"
    }
  }
}

Example

​
holders:
  # Holder that shows the number of diamonds a player has mined
  # Use the Statistic expansion: /papi ecloud download Statistic
  diamonds:
    type: placeholder
    placeholder: "%statistic_mine_block:DIAMOND_ORE%"
  # Holder that shows the amount of money a player has
  # Use the Vault expansion: /papi ecloud download Vault
  money:
    type: placeholder
    placeholder: "%vault_eco_balance%"
    online: false # Get the value for all players, even those who are offline.
{
  "holders": {
    // Holder that shows the level of a player
    // Use PlayerEx
    "level": {
      "type": "placeholder",
      "placeholder": "%playerex:level%"
    }
  }
}

MiniPlaceholder

Note

Requires MiniPlaceholders

This is a provider that allows you to use MiniPlaceholders placeholders as values in the Top Holder.

Format

​
holders:
  <holder-name>:
    # The type of the provider
    type: mini-placeholder
    # The placeholder used to get the value
    placeholder: <placeholder>
{
  "holders": {
    "<holder-name>": {
      // The type of the provider
      "type": "mini-placeholder",
      // The placeholder used to get the value
      "placeholder": "<placeholder>"
    }
  }
}

Example

​
holders:
  # Holder that shows the amount of money a player has
  # Use the Vault expansion: https://modrinth.com/plugin/miniplaceholders-vault-expansion
  money:
    type: mini-placeholder
    placeholder: "<vault_eco_balance>"
{
  "holders": {
    "money": {
      "type": "mini-placeholder",
      "placeholder": "<vault_eco_balance>"
    }
  }
}