Leaderboards

Every stored currency with Leaderboard on is ranked. A currency with it off, or one this plugin does not store, answers "… has no leaderboard." rather than an empty board.

Opening a board

A player gets the board as a screen, menus/user/top.yml, 90 places deep, with heads, positions and amounts, and the money supply in its corner. The page argument is for the console, which gets ten lines per page under a header and the money in circulation:

TOP Dollars page 1
 ▎ In circulation » $1,204,300.00
 #1 Steve » $250,000.00
 #2 Alex » $180,500.00

How the board is read

The board is read from the database and kept for a minute, because a leaderboard on a scoreboard is asked for every tick. While it refreshes, the old board keeps being served. The first look after a start waits for the read instead of opening empty. The cache holds the first 100 places; the screen shows 90.

Each server keeps its own copy, so two servers can disagree for up to a minute after a large payment.

The money supply

Every balance of the currency added up — hidden players included — is the money in circulation. It is read with the board, so it is as fresh as the board:

• the console's /baltop prints it under the header;
• top.yml shows it in slot 45 as %top_total%;
• %exyliaeconomy_economy_total_<currency>% returns it. See Placeholders.

When ExyliaAnalytics is installed, each stored currency's supply and how many players hold any of it are handed to it a minute after the start and every ten minutes after that. See Integrations.

Leaving players off

exyliaeconomy.top.exempt leaves a player off every leaderboard, without taking a place: the board ranks the next player into it. It is granted to nobody by default, operators included, so a server owner shows up unless they choose not to.

A permission cannot be checked for somebody offline, and the board ranks everybody, so the exemption is stored in the database when the player joins. Granting or removing it applies from their next join, and on the board within a minute after that.

An exempt player's money still counts in the supply, and %exyliaeconomy_economy_rank_<currency>% answers — for them.