Index | TopStats API Documentation

A

AutoSaveSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
LeaderboardManager::add() — Method in class LeaderboardManager: Add a leaderboard instance.
Utils::applyDerivedStat() — Method in class Utils: Apply derived statistics (e.g. KDR) to the dataset.

C

CreateSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
IDatabase::create() — Method in class IDatabase: Create a new data entry for a player.
JsonDatabase::create() — Method in class JsonDatabase: Create a new data entry for a player.
MySQLDatabase::create() — Method in class MySQLDatabase: Create a new data entry for a player.
SQLiteDatabase::create() — Method in class SQLiteDatabase: Create a new data entry for a player.

D

DeleteSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
DataAction — Class in namespace Nicholass003\TopStats\Database\Data
DataType — Class in namespace Nicholass003\TopStats\Database\Data
$ JsonDatabase#database — Property in class JsonDatabase
$ JsonDatabase#data — Property in class JsonDatabase
$ MySQLDatabase#database — Property in class MySQLDatabase
$ MySQLDatabase#data — Property in class MySQLDatabase
DBQuery — Class in namespace Nicholass003\TopStats\Database\Query
$ SQLiteDatabase#database — Property in class SQLiteDatabase
$ SQLiteDatabase#data — Property in class SQLiteDatabase
$ Leaderboard#database — Property in class Leaderboard
LeaderboardManager::dispatchLeaderboardUpdate() — Method in class LeaderboardManager: Dispatches a leaderboard update event for the specified type.
$ TopStats#database — Property in class TopStats

E

ExternalIntegration — Class in namespace Nicholass003\TopStats\External: Defines a contract for integrating external data sources into TopStats.
ExternalIntegration::extractData() — Method in class ExternalIntegration: Extracts leaderboard data from the given event.
ExternalIntegrationRegistry — Class in namespace Nicholass003\TopStats\External: Registry for managing all external integrations.
ExternalSource — Class in namespace Nicholass003\TopStats\External: Represents a data source produced by an ExternalIntegration.
ExternalTypeNames — Class in namespace Nicholass003\TopStats\External
TopVoterIntegration::extractData() — Method in class TopVoterIntegration: Extracts leaderboard data from the given event.
EventListener — Class in namespace Nicholass003\TopStats\Listener
$ TopStats#economyProvider — Property in class TopStats

G

DataType::get() — Method in class DataType
IDatabase::getName() — Method in class IDatabase: Database driver name.
IDatabase::getTemporaryData() — Method in class IDatabase: Get all cached player data.
IDatabase::getTemporaryDataValue() — Method in class IDatabase: Get a specific value for a player.
JsonDatabase::getName() — Method in class JsonDatabase: Database driver name.
JsonDatabase::getTemporaryData() — Method in class JsonDatabase: Get all cached player data.
JsonDatabase::getTemporaryDataValue() — Method in class JsonDatabase: Get a specific value for a player.
MySQLDatabase::getName() — Method in class MySQLDatabase: Database driver name.
MySQLDatabase::getTemporaryData() — Method in class MySQLDatabase
MySQLDatabase::getTemporaryDataValue() — Method in class MySQLDatabase: Get a specific value for a player.
SQLiteDatabase::getName() — Method in class SQLiteDatabase: Database driver name.
SQLiteDatabase::getTemporaryData() — Method in class SQLiteDatabase
SQLiteDatabase::getTemporaryDataValue() — Method in class SQLiteDatabase: Get a specific value for a player.
TopStatsUpdateEvent::getType() — Method in class TopStatsUpdateEvent: Leaderboard type being updated.
TopStatsUpdateEvent::getLeaderboards() — Method in class TopStatsUpdateEvent: Leaderboards affected by this update.
ExternalIntegration::getType() — Method in class ExternalIntegration: Returns a unique identifier for this integration.
ExternalIntegration::getEventClass() — Method in class ExternalIntegration: Returns the fully-qualified class name of the event this integration listens to.
ExternalIntegrationRegistry::getSource() — Method in class ExternalIntegrationRegistry: Returns the data source for a given type.
ExternalIntegrationRegistry::getActiveTypes() — Method in class ExternalIntegrationRegistry: Returns all active integration types.
ExternalSource::getType() — Method in class ExternalSource
ExternalSource::getIntegration() — Method in class ExternalSource
ExternalSource::getEntries() — Method in class ExternalSource
TopVoterIntegration::getType() — Method in class TopVoterIntegration: Returns a unique identifier for this integration.
TopVoterIntegration::getEventClass() — Method in class TopVoterIntegration: Returns the fully-qualified class name of the event this integration listens to.
Leaderboard::getId() — Method in class Leaderboard: Unique runtime identifier of this leaderboard.
Leaderboard::getType() — Method in class Leaderboard: Leaderboard data type (e.g. "kdr", "kills").
Leaderboard::getModel() — Method in class Leaderboard: Underlying model used for rendering.
LeaderboardManager::get() — Method in class LeaderboardManager: Get a leaderboard by ID.
LeaderboardManager::getLeaderboardFromType() — Method in class LeaderboardManager: Get all leaderboards matching a specific type.
LeaderboardManager::getLeaderboardData() — Method in class LeaderboardManager: Access the underlying leaderboard storage config.
Utils::getSortedArrayBoard() — Method in class Utils: Sort data in descending order based on the given type key.
Utils::getTopStatsText() — Method in class Utils: Generate formatted leaderboard text.
Utils::getTopStatsPlayerSkin() — Method in class Utils: Get the skin of a player at a specific leaderboard rank.
Utils::getNextTopStatsIds() — Method in class Utils: Get the next leaderboard ID based on current count.

I

DataType::isDerived() — Method in class DataType
DataType::isRaw() — Method in class DataType
IDatabase — Class in namespace Nicholass003\TopStats\Database: Defines a database driver for TopStats.
MySQLDatabase::isAutoSaveActive() — Method in class MySQLDatabase
SQLInterface::isAutoSaveActive() — Method in class SQLInterface
SQLiteDatabase::isAutoSaveActive() — Method in class SQLiteDatabase
ExternalIntegration::isForceSorting() — Method in class ExternalIntegration: Whether this integration already sorts its data internally.
TopVoterIntegration::isForceSorting() — Method in class TopVoterIntegration: Whether this integration already sorts its data internally.
$ Leaderboard#id — Property in class Leaderboard
Leaderboard::isForceSorting() — Method in class Leaderboard: Whether sorting is handled externally.
Leaderboard::isCustomDataType() — Method in class Leaderboard: Check if this leaderboard uses a custom data type.

J

JsonDatabase — Class in namespace Nicholass003\TopStats\Database
Leaderboard::jsonSerialize() — Method in class Leaderboard: Serialize leaderboard data for storage.

L

ListSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
$ TopStatsSubCommand#leaderboardManager — Property in class TopStatsSubCommand
IDatabase::loadData() — Method in class IDatabase: Load all data into memory.
JsonDatabase::loadData() — Method in class JsonDatabase: Load all data into memory.
MySQLDatabase::loadData() — Method in class MySQLDatabase: Load all data into memory.
SQLiteDatabase::loadData() — Method in class SQLiteDatabase: Load all data into memory.
Leaderboard — Class in namespace Nicholass003\TopStats\Leaderboard: Represents a single leaderboard instance.
LeaderboardManager — Class in namespace Nicholass003\TopStats\Leaderboard: Manages all leaderboard instances and their lifecycle.
$ LeaderboardManager#leaderboards — Property in class LeaderboardManager
$ LeaderboardManager#leaderboardData — Property in class LeaderboardManager
LeaderboardManager::leaderboards() — Method in class LeaderboardManager: Get all registered leaderboards.
LeaderboardManager::loadData() — Method in class LeaderboardManager: Load leaderboard data from storage.
$ TopStats#leaderboardManager — Property in class TopStats

M

MySQLDatabase — Class in namespace Nicholass003\TopStats\Database
Utils::moneyTransaction() — Method in class Utils: Check if a money value change represents a valid transaction.

N

NumberFormatter — Class in namespace Nicholass003\TopStats\Utils: Format numeric values into short readable form.

O

AutoSaveSubCommand::onRun() — Method in class AutoSaveSubCommand
CreateSubCommand::onRun() — Method in class CreateSubCommand
DeleteSubCommand::onRun() — Method in class DeleteSubCommand
ListSubCommand::onRun() — Method in class ListSubCommand
TeleportSubCommand::onRun() — Method in class TeleportSubCommand
TypeSubCommand::onRun() — Method in class TypeSubCommand
TopStatsCommand::onRun() — Method in class TopStatsCommand
EventListener::onPlayerJoin() — Method in class EventListener
EventListener::onEntityTeleport() — Method in class EventListener
EventListener::onPlayerDeath() — Method in class EventListener
EventListener::onBlockBreak() — Method in class EventListener
EventListener::onBlockPlace() — Method in class EventListener
EventListener::onPlayerChangeSkin() — Method in class EventListener
EventListener::onPlayerChat() — Method in class EventListener
EventListener::onPlayerItemConsume() — Method in class EventListener
EventListener::onCraftItem() — Method in class EventListener
EventListener::onPlayerDropItem() — Method in class EventListener
EventListener::onPlayerEmote() — Method in class EventListener
EventListener::onPlayerItemEnchant() — Method in class EventListener
EventListener::onEntityItemPickup() — Method in class EventListener
EventListener::onPlayerJump() — Method in class EventListener
EventListener::onPlayerKick() — Method in class EventListener
EventListener::onEntityRegainHealth() — Method in class EventListener
EventListener::onPlayerExperienceChange() — Method in class EventListener
EventListener::onEntityDamage() — Method in class EventListener
EventListener::onPlayerMove() — Method in class EventListener
UpdateTask::onRun() — Method in class UpdateTask
TopStats::onLoad() — Method in class TopStats
TopStats::onEnable() — Method in class TopStats
TopStats::onDisable() — Method in class TopStats
TopStats::onRun() — Method in class TopStats

P

AutoSaveSubCommand::prepare() — Method in class AutoSaveSubCommand
CreateSubCommand::prepare() — Method in class CreateSubCommand
DeleteSubCommand::prepare() — Method in class DeleteSubCommand
ListSubCommand::prepare() — Method in class ListSubCommand
TeleportSubCommand::prepare() — Method in class TeleportSubCommand
$ TopStatsSubCommand#plugin — Property in class TopStatsSubCommand
TypeSubCommand::prepare() — Method in class TypeSubCommand
$ TopStatsCommand#plugin — Property in class TopStatsCommand
TopStatsCommand::prepare() — Method in class TopStatsCommand

R

DataType::RAW() — Method in class DataType
ExternalIntegrationRegistry::register() — Method in class ExternalIntegrationRegistry: Registers a new external integration and binds its event listener.
LeaderboardManager::remove() — Method in class LeaderboardManager: Remove a leaderboard by ID and destroy its model.

S

TopStatsCommand::showForm() — Method in class TopStatsCommand
DataType::setup() — Method in class DataType
IDatabase::saveData() — Method in class IDatabase: Persist all data to storage.
JsonDatabase::saveData() — Method in class JsonDatabase: Persist all data to storage.
MySQLDatabase::saveData() — Method in class MySQLDatabase: Persist all data to storage.
SQLInterface — Class in namespace Nicholass003\TopStats\Database
SQLiteDatabase — Class in namespace Nicholass003\TopStats\Database
SQLiteDatabase::saveData() — Method in class SQLiteDatabase: Persist all data to storage.
ExternalSource::setEntries() — Method in class ExternalSource
Leaderboard::setModel() — Method in class Leaderboard: Replace the model instance.
Leaderboard::spawn() — Method in class Leaderboard: Spawn the leaderboard for all current viewers.
Leaderboard::setForceSorting() — Method in class Leaderboard: Enable or disable external sorting.
LeaderboardManager::saveData() — Method in class LeaderboardManager: Save all leaderboard data to storage.
NumberFormatter::short() — Method in class NumberFormatter: Convert a number into compact form (e.g. 1.2K, 3.4M).

T

TeleportSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
TopStatsSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
TypeSubCommand — Class in namespace Nicholass003\TopStats\Command\SubCommand
TopStatsCommand — Class in namespace Nicholass003\TopStats\Command
MySQLDatabase::toggleAutoSave() — Method in class MySQLDatabase
SQLInterface::toggleAutoSave() — Method in class SQLInterface
SQLiteDatabase::toggleAutoSave() — Method in class SQLiteDatabase
TopStatsEvent — Class in namespace Nicholass003\TopStats\Event
TopStatsUpdateEvent — Class in namespace Nicholass003\TopStats\Event: Fired when leaderboards of a specific type are about to be updated.
TopVoterIntegration — Class in namespace Nicholass003\TopStats\External\Support
$ Leaderboard#text — Property in class Leaderboard
$ Leaderboard#title — Property in class Leaderboard
TopStats — Class in namespace Nicholass003\TopStats
Utils::timeFormat() — Method in class Utils: Convert seconds into a formatted duration string.

U

IDatabase::update() — Method in class IDatabase: Update player data with a specific action.
JsonDatabase::update() — Method in class JsonDatabase: Update player data with a specific action.
MySQLDatabase::update() — Method in class MySQLDatabase: Update player data with a specific action.
SQLiteDatabase::update() — Method in class SQLiteDatabase: Update player data with a specific action.
ExternalIntegrationRegistry::unregister() — Method in class ExternalIntegrationRegistry: Unregisters an integration by type.
Leaderboard::updateText() — Method in class Leaderboard: Update the displayed text.
Leaderboard::updateTitle() — Method in class Leaderboard: Update the displayed title.
Leaderboard::update() — Method in class Leaderboard: Update leaderboard content using provided or database data.
UpdateTask — Class in namespace Nicholass003\TopStats\Task
Utils — Class in namespace Nicholass003\TopStats\Utils: Utility helpers for leaderboard processing and formatting.

V

Utils::validateTextFormat() — Method in class Utils: Format a leaderboard entry into text.
Utils::validateDataAction() — Method in class Utils: Determine the type of change between two values.

_

TopStatsSubCommand::__construct() — Method in class TopStatsSubCommand
JsonDatabase::__construct() — Method in class JsonDatabase
MySQLDatabase::__construct() — Method in class MySQLDatabase
SQLiteDatabase::__construct() — Method in class SQLiteDatabase
TopStatsUpdateEvent::__construct() — Method in class TopStatsUpdateEvent
ExternalSource::__construct() — Method in class ExternalSource
Leaderboard::__construct() — Method in class Leaderboard
LeaderboardManager::__construct() — Method in class LeaderboardManager
EventListener::__construct() — Method in class EventListener
UpdateTask::__construct() — Method in class UpdateTask
TopStats::__construct() — Method in class TopStats