API

Learn how to install and use the API

Towns and Nations API is new and errors may happen. To report a bug or suggest an update, please reach us on Discord.

Installing the API

The API tan-api is hosted on maven central portal. It can be compiled from Maven and Gradle :

Gradle

repositories {
    mavenCentral()
}

dependencies {
    compileOnly 'io.github.leralix:tan-api:0.3.0'
}

Gradle (Kotlin)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("io.github.leralix:tan-api:0.3.0")
}

Maven

<dependencies>
    <dependency>
        <groupId>io.github.leralix</groupId>
        <artifactId>tan-api</artifactId>
        <version>0.3.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

<repositories>
    <repository>
        <id>central</id>
        <url>https://repo.maven.apache.org/maven2</url>
    </repository>
</repositories>

API example

import org.tan.api.TanAPI;
import org.tan.api.getters.TanPlayerManager;
import org.tan.api.interfaces.TanPlayer;
import org.tan.api.interfaces.TanTown;

public void getPlayerTowns() {
    TanAPI api = TanAPI.getInstance(); //Entry point of the api
    TanPlayerManager playerManager = api.getPlayerManager();
    Collection<TanPlayer> players = playerManager.getAll();
        for (TanPlayer player : players) {
            Optional<TanTown> playerTown = player.getTown();
            if(playerTown.isEmpty()){
                getLogger().info("Player: " + player.getNameStored() + " is not in a town");
            }
            else {
                getLogger().info("Player: " + player.getNameStored() + " is in town : " + playerTown.get().getName());
            }
        }
    }
}

Javadoc can be found here.

Main manager classes :

PlayerManager

Handles all player-related actions, such as:

• Retrieving player data.

• Managing town membership.

TerritoryManager

Manages town and region data:

• Fetching town details.

• Checking region ownership.

ClaimManager

Handles land claims and permissions:

• Checking chunk and block ownership.

• Claiming chunk for territories

LandmarkManager

Manages property data:

• Retrieving landmarks and structures.

• Modifying rewards