com.bgsoftware.superiorskyblock.api

Class SuperiorSkyblockAPI

java.lang.Object

com.bgsoftware.superiorskyblock.api.SuperiorSkyblockAPI

public final class SuperiorSkyblockAPI
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	calcAllIslands() Calculate all island worths on the server
static void	createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonusWorth, java.math.BigDecimal bonusLevel, org.bukkit.block.Biome biome, java.lang.String islandName, boolean offset) Create a new island.
static void	createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonus, org.bukkit.block.Biome biome, java.lang.String islandName) Create a new island.
static void	createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonus, org.bukkit.block.Biome biome, java.lang.String islandName, boolean offset) Create a new island.
static void	deleteIsland(Island island) Delete an island
static int	getAPIVersion()
static BlockValuesManager	getBlockValues() Get the blocks manager of the core.
static CommandsManager	getCommands() Get the commands manager of the core.
static FactoriesManager	getFactory() Get the objects factory of the plugin.
static GridManager	getGrid() Get the grid of the core.
static Island	getIsland(java.lang.String islandName) Get an island by it's name.
static Island	getIslandAt(org.bukkit.Location location) Get an island at a location.
static Island	getIslandByUUID(java.util.UUID uuid) Get an island by it's uuid.
static org.bukkit.World	getIslandsWorld(Island island, org.bukkit.World.Environment environment) Get the world of an island by the world's environment.
static KeysManager	getKeys() Get the keys manager of the core.
static MenusManager	getMenus() Get the menus manager of the core.
static MissionsManager	getMissions() Get the missions manager of the core.
static ModulesManager	getModules() Get the modules manager of the plugin.
static SuperiorPlayer	getPlayer(org.bukkit.entity.Player player) Get the superior player object from a player instance.
static SuperiorPlayer	getPlayer(java.lang.String name) Get the superior player object by a player's name.
static SuperiorPlayer	getPlayer(java.util.UUID uuid) Get the superior player object from a player's uuid.
static PlayersManager	getPlayers() Get the players manager of the core.
static ProvidersManager	getProviders() Get the providers manager of the core.
static RolesManager	getRoles() Get the roles manager of the core.
static Schematic	getSchematic(java.lang.String name) Get a schematic object by its name
static SchematicManager	getSchematics() Get the schematics manager of the core.
static SettingsManager	getSettings() Get the settings of the plugin.
static Island	getSpawnIsland() Get the spawn island.
static StackedBlocksManager	getStackedBlocks() Get the stacked-blocks manager of the core.
static SuperiorSkyblock	getSuperiorSkyblock() Get the plugin instance.
static UpgradesManager	getUpgrades() Get the upgrades manager of the core.
static void	registerCommand(SuperiorCommand superiorCommand) Register a sub-command.
static void	setPluginInstance(SuperiorSkyblock plugin) Set the plugin's instance for the API.
static void	setSpawnersProvider(SpawnersProvider spawnersProvider) Set custom spawners provider for the plugin.

Methods inherited from class java.lang.Object

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

Method Detail

getSuperiorSkyblock

public static SuperiorSkyblock getSuperiorSkyblock()

Get the plugin instance.

setPluginInstance

public static void setPluginInstance(SuperiorSkyblock plugin)

Set the plugin's instance for the API. Do not use this method on your own, as it may cause an undefined behavior when using the API.

Parameters:

plugin - The instance of the plugin to set to the API.

getAPIVersion

public static int getAPIVersion()

getPlayer

public static SuperiorPlayer getPlayer(org.bukkit.entity.Player player)

Get the superior player object from a player instance.

getPlayer

@Nullable
public static SuperiorPlayer getPlayer(java.lang.String name)

Get the superior player object by a player's name.

getPlayer

public static SuperiorPlayer getPlayer(java.util.UUID uuid)

Get the superior player object from a player's uuid.

Parameters:

uuid - player uuid

Returns:

The superior player object. null if doesn't exist.

createIsland

public static void createIsland(SuperiorPlayer superiorPlayer,
                                java.lang.String schemName,
                                java.math.BigDecimal bonus,
                                org.bukkit.block.Biome biome,
                                java.lang.String islandName)

Create a new island.

Parameters:

superiorPlayer - owner of the island

schemName - the schematic of the island to be pasted

bonus - The default island bonus level

biome - The default island biome

islandName - The island name

createIsland

public static void createIsland(SuperiorPlayer superiorPlayer,
                                java.lang.String schemName,
                                java.math.BigDecimal bonus,
                                org.bukkit.block.Biome biome,
                                java.lang.String islandName,
                                boolean offset)

Create a new island.

Parameters:

superiorPlayer - The new owner for the island.

schemName - The schematic that should be used.

bonus - A starting worth for the island.

biome - A starting biome for the island.

islandName - The name of the new island.

offset - Should the island have an offset for it's values? If disabled, the bonus will be given.

createIsland

public static void createIsland(SuperiorPlayer superiorPlayer,
                                java.lang.String schemName,
                                java.math.BigDecimal bonusWorth,
                                java.math.BigDecimal bonusLevel,
                                org.bukkit.block.Biome biome,
                                java.lang.String islandName,
                                boolean offset)

Create a new island.

Parameters:

superiorPlayer - The new owner for the island.

schemName - The schematic that should be used.

bonusWorth - A starting worth for the island.

bonusLevel - A starting level for the island.

biome - A starting biome for the island.

islandName - The name of the new island.

offset - Should the island have an offset for it's values? If disabled, the bonus will be given.

deleteIsland

public static void deleteIsland(Island island)

Delete an island

getIsland

@Nullable
public static Island getIsland(java.lang.String islandName)

Get an island by it's name.

getIslandByUUID

@Nullable
public static Island getIslandByUUID(java.util.UUID uuid)

Get an island by it's uuid.

getSpawnIsland

public static Island getSpawnIsland()

Get the spawn island.

getIslandsWorld

@Nullable
public static org.bukkit.World getIslandsWorld(Island island,
                                                          org.bukkit.World.Environment environment)

Get the world of an island by the world's environment.

getIslandAt

@Nullable
public static Island getIslandAt(org.bukkit.Location location)

Get an island at a location.

calcAllIslands

public static void calcAllIslands()

Calculate all island worths on the server

getSchematic

@Nullable
public static Schematic getSchematic(java.lang.String name)

Get a schematic object by its name

setSpawnersProvider

public static void setSpawnersProvider(SpawnersProvider spawnersProvider)

Set custom spawners provider for the plugin.

Parameters:

spawnersProvider - The spawner provider to set.

registerCommand

public static void registerCommand(SuperiorCommand superiorCommand)

Register a sub-command.

Parameters:

superiorCommand - The sub command to register.

getGrid

public static GridManager getGrid()

Get the grid of the core.

getStackedBlocks

public static StackedBlocksManager getStackedBlocks()

Get the stacked-blocks manager of the core.

getBlockValues

public static BlockValuesManager getBlockValues()

Get the blocks manager of the core.

getSchematics

public static SchematicManager getSchematics()

Get the schematics manager of the core.

getPlayers

public static PlayersManager getPlayers()

Get the players manager of the core.

getRoles

public static RolesManager getRoles()

Get the roles manager of the core.

getMissions

public static MissionsManager getMissions()

Get the missions manager of the core.

getMenus

public static MenusManager getMenus()

Get the menus manager of the core.

getKeys

public static KeysManager getKeys()

Get the keys manager of the core.

getProviders

public static ProvidersManager getProviders()

Get the providers manager of the core.

getUpgrades

public static UpgradesManager getUpgrades()

Get the upgrades manager of the core.

getCommands

public static CommandsManager getCommands()

Get the commands manager of the core.

getSettings

public static SettingsManager getSettings()

Get the settings of the plugin.

getFactory

public static FactoriesManager getFactory()

Get the objects factory of the plugin.

getModules

public static ModulesManager getModules()

Get the modules manager of the plugin.