Package org.tan.api

Class TanAPI

java.lang.Object

org.tan.api.TanAPI

public abstract class TanAPI
extends Object

The main entry point to the TanAPI.

Use getInstance() to access the instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TanAPI()

Method Summary

Modifier and Type	Method	Description
abstract TanClaimManager	getClaimManager()
static TanAPI	getInstance()	TanAPI entry point
abstract TanLandmarkManager	getLandmarkManager()
abstract org.leralix.lib.data.PluginVersion	getMinimumSupportingMapPlugin()	Get the minimum supporting map plugin version, used for ensuring compatibility with the map plugin
abstract TanPlayerManager	getPlayerManager()
abstract org.leralix.lib.data.PluginVersion	getPluginVersion()
abstract TanTerritoryManager	getTerritoryManager()
static void	register(TanAPI api)	Register the TanAPI instance This method should never be called outside the TanAPI implementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TanAPI

protected TanAPI()

Method Details

register

public static void register(TanAPI api)

Register the TanAPI instance This method should never be called outside the TanAPI implementation

Parameters:

api - the TanAPI instance

getInstance

public static TanAPI getInstance()

TanAPI entry point

Returns:

the TanAPI instance

getPlayerManager

public abstract TanPlayerManager getPlayerManager()

Returns:

the player manager, responsible for player access

getTerritoryManager

public abstract TanTerritoryManager getTerritoryManager()

Returns:

the territory manager, responsible for territory access

getClaimManager

public abstract TanClaimManager getClaimManager()

Returns:

the claim manager, responsible for information about claims

getLandmarkManager

public abstract TanLandmarkManager getLandmarkManager()

Returns:

the landmark manager, responsible for landmark access

getPluginVersion

public abstract org.leralix.lib.data.PluginVersion getPluginVersion()

Returns:

Get the plugin version

getMinimumSupportingMapPlugin

public abstract org.leralix.lib.data.PluginVersion getMinimumSupportingMapPlugin()

Get the minimum supporting map plugin version, used for ensuring compatibility with the map plugin

Returns:

the minimum supporting map plugin version