Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 2.02 KB

api.md

File metadata and controls

80 lines (63 loc) · 2.02 KB
Raw

Logo

RealScoreboard - API Usage

Adding repository and dependency

  • Maven
<repository>
  <id>neziw-repo</id>
  <url>https://repo.neziw.xyz/releases</url>
</repository>
<dependency>
  <groupId>joserodpt.realscoreboard</groupId>
  <artifactId>realscoreboard-api</artifactId>
  <version>10-12-2022 Build 2</version>
</dependency>
  • Gradle (Groovy)
maven {
    url "https://repo.neziw.xyz/releases"
}
implementation "joserodpt.realscoreboard:RealScoreboard-API:10-11-2022 Build 5"

API Usage

Getting the API instance

You can access API instance by using following method:

RealScoreboardAPI.getInstance();

Example Usage: Example

Accessing static configuration

Configuration file can be accessed via Config class:

boolean isDebugEnabled = Config.file().getBoolean("Debug");
if (isDebugEnabled) {
  isDebugEnabled = false;
  Config.file().set("Debug", false);
}

Accessing managers and other classes

API Classes like managers are abstract and plugin extends them directly itself. You can't get direct access via API to managers, but you can use getters from API instance.

Example Usage:

AbstractDatabaseManager databaseManager = this.scoreboardAPI.getDatabaseManager(); // Getting DatabaseManager
PlayerData playerData = databaseManager.getPlayerData(player.getUniqueId()); // Getting player data from DatabaseManager
playerData.setScoreboardON(false); // Disabling scoreboard for player
databaseManager.savePlayerData(playerData, true); // Saving changes (asynchronously) to database

Links