Skip to main content

Customize Value Provider

Asynchronous Provider​

You can set async to true to make the provider asynchronous, meaning it will be executed in a separate thread. This can be useful if the provider is slow or if it performs a lot of calculations.

holders:
  jump:
    type: statistic
    statistic: jump
    async: true

Default Values​

You can change the default values, returned by some queries and commands, by adding some settings to your holder settings.

holders:
  jump:
    type: statistic
    statistic: jump
    default-value: null # The default value of an entry. This will be used when a player joins the server the first time
    null-name: "---" # Default value for the name
    null-uuid: "---" # Default value for the uuid
    null-value: "---" # Default value for the value
    line: "&7[&b{index}&7] &b{name} &7- &b{value}" # Default format for the top line in the top list

Default Value Display​

You can set a default Value Display that will be applied to all the queries by setting the default-value-display setting.

holders:
  jump:
    type: statistic
    statistic: jump
    default-value-display: "decimal:groupingSeparator=,&groupingSize=3&maximumFractionDigits=0"

Reversed Leaderboard​

By default, the leaderboard is measured by the player with the highest value first. If you want to change that (e.g. show the player with the least value first), you can set reverse to true.

holders:
  jump:
    type: statistic
    statistic: jump
    reverse: true

Handle Formatted Values​

If the output of a Value Provider (Placeholder for example) is a formatted value and you are confident that you can get the raw value from it with a simple method of taking only numbers and the decimal separator, you can enable the formatted option in your Holder Setting.

holders:
  example-formatted-value-provider:
    type: statistic
    statistic: jump
    formatted: true
    formatted-settings: # Optional settings for the formatted value
      decimal-separator: "." # Change this to the decimal separator of the formatted value

Ignore & Reset Permission​

You can specify a set of permissions so that the Holder will skip updating the value of the player if they have one of the permissions.

holders:
  jump:
    type: statistic
    statistic: jump
    ignore-permission: exclude.permission

  jump-multiple:
    type: statistic
    statistic: jump
    ignore-permission:
      - exclude.permission1
      - exclude.permission2

You can also specify a set of permissions so that the Holder will reset the value of the player if they have one of the permissions.

holders:
  jump:
    type: statistic
    statistic: jump
    reset-permission: reset.permission

  jump-multiple:
    type: statistic
    statistic: jump
    reset-permission:
      - reset.permission1
      - reset.permission2

Show Errors​

By default, any errors that occur during the execution of a provider will be truncated. If you want to show the errors instead, you can set show-errors to true.

holders:
  jump:
    type: statistic
    statistic: jump
    show-errors: true

You can also reset the value of the player if there is an error when updating the value.

holders:
  jump:
    type: statistic
    statistic: jump
    reset-on-error: true