Skip to content

Query

This page provides information about the query system, which is used to retrieve data from the Top Holder.

Format

The format of a query is as follows:

<holder>;<type>;<args>
  • <holder>: The Top Holder to query.
  • <type>: The type of data to retrieve.
  • <args>: Additional arguments for the query.

If the <type> does not require any arguments, the query can be simplified to:

<holder>;<type>

Types

Click me to edit the example values

top_name

  • Format:
    • <holder>;top_name;<position>
  • Description: The name of the player at the specified position.
  • Argument:
    • <holder>: The name of the Holder
    • <position>: The position of the player in the Holder
  • Example:
    • money;top_name;1
      • Retrieve the name of the player at position 1 in the Holder named money

top_key

  • Format:
    • <holder>;top_key;<position>
  • Description: The UUID of the player at the specified position.
  • Argument:
    • <holder>: The name of the Holder
    • <position>: The position of the player in the Holder
  • Example:
    • money;top_key;1
      • Retrieve the UUID of the player at position 1 in the Holder named money

top_value

  • Format:
    • <holder>;top_value;<position>
    • <holder>;top_value;<position>;<format>
  • Description: The value of the player at the specified position.
  • Argument:
    • <holder>: The name of the Holder
    • <position>: The position of the player in the Holder
    • <format>: A number format pattern, see Value Display for more details on how to apply a format
  • Example:
    • money;top_value;1
      • Retrieve the value of the player at position 1 in the Holder named money
    • money;top_value;1;#,###
      • Retrieve the formatted value of the player at position 1 in the Holder named money, in the format of #,###

top_value_raw

  • Format:
    • <holder>;top_value_raw;<position>
  • Description: The raw value of the player at the specified position.
  • Argument:
    • <holder>: The name of the Holder
    • <position>: The position of the player in the Holder
  • Example:
    • money;top_value_raw;1
      • Retrieve the raw value of the player at position 1 in the Holder named money

top_rank

  • Format:
    • <holder>;top_rank
    • <holder>;top_rank;<format>
  • Description: The player's rank (position number) in the specified Holder.
  • Argument:
    • <holder>: The name of the Holder
    • <format>: A number format pattern, see Value Display for more details on how to apply a format
  • Example:
    • money;top_rank
      • Retrieve the rank of the player in the Holder named money
    • money;top_rank;#,###
      • Retrieve the formatted rank of the player in the Holder named money

top_size

  • Format:
    • <holder>;top_size
  • Description: The amount of entries in the Holder.
  • Argument:
    • <holder>: The name of the Holder
  • Example:
    • money;top_size
      • Retrieve the amount of entries in the Holder named money

value

  • Format:
    • <holder>;value
    • <holder>;value;<format>
  • Description: The value of the player.
  • Argument:
    • <holder>: The name of the Holder
    • <format>: A number format pattern, see Value Display for more details on how to apply a format
  • Example:
    • money;value
      • Retrieve the value of the player in the Holder named money
    • money;value;#,###
      • Retrieve the formatted value of the player in the Holder named money

value_raw

  • Format:
    • <holder>;value_raw
  • Description: The raw value of the player.
  • Argument:
    • <holder>: The name of the Holder
  • Example:
    • money;value_raw
      • Retrieve the raw value of the player in the Holder named money