me.block2block.hubparkour.api

Class BackendAPI

java.lang.Object

me.block2block.hubparkour.api.BackendAPI

public abstract class BackendAPI
extends Object

The backend API class which the API uses to execute methods.

Constructor Summary

Constructors

Constructor and Description
BackendAPI()

Method Summary

Modifier and Type	Method and Description
abstract void	closeGUI(org.bukkit.entity.Player player) Closes the GUI associated with the specified player, if any.
abstract GUI	getGUI(org.bukkit.entity.Player player) Retrieves a GUI instance associated with the provided player.
static BackendAPI	getImplementation()
abstract org.bukkit.inventory.ItemStack	getItem(int type) Gets the ItemStack of a specific item type.
abstract IParkour	getParkour(int id) Get a specific parkour.
abstract IParkour	getParkour(String name) Get a specific parkour.
abstract IHubParkourPlayer	getPlayer(org.bukkit.entity.Player player) Get a player that is currently in parkour.
abstract org.bukkit.Material	getPressurePlateType(int type) Gets the material type of a specific pressure plate type.
abstract boolean	isInParkour(org.bukkit.entity.Player player) Use to check if a player is in a parkour.
abstract boolean	isPost1_14() Determines whether the server version is 1.14 or newer.
abstract boolean	isPre1_13() Determines whether the server is before 1.13.
abstract void	openGUI(org.bukkit.entity.Player player, GUI gui) Opens a specified GUI for the given player.
static void	setImplementation(BackendAPI implementation)

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendAPI

public BackendAPI()

Method Detail

getImplementation

public static BackendAPI getImplementation()

setImplementation

public static void setImplementation(BackendAPI implementation)

isInParkour

public abstract boolean isInParkour(org.bukkit.entity.Player player)
                             throws NullPointerException

Use to check if a player is in a parkour.

Parameters:

player - the player to check.

Returns:

if the player is in a parkour.

Throws:

NullPointerException - if player is null.

getPlayer

public abstract IHubParkourPlayer getPlayer(org.bukkit.entity.Player player)
                                     throws NullPointerException

Get a player that is currently in parkour.

Parameters:

player - The player to retrieve.

Returns:

the player, or if the player is not in a parkour, null.

Throws:

NullPointerException - if player is null.

getParkour

public abstract IParkour getParkour(int id)

Get a specific parkour.

Parameters:

id - the id of the parkour.

Returns:

The parkour, if it does not exist, null.

getParkour

public abstract IParkour getParkour(String name)
                             throws NullPointerException

Get a specific parkour.

Parameters:

name - the name of the parkour

Returns:

The parkour, if it does not exist, null.

Throws:

NullPointerException - if name is null.

getPressurePlateType

public abstract org.bukkit.Material getPressurePlateType(int type)

Gets the material type of a specific pressure plate type.

Parameters:

type - the type of pressure plate.

Returns:

the material.

getItem

public abstract org.bukkit.inventory.ItemStack getItem(int type)

Gets the ItemStack of a specific item type.

Parameters:

type - the type of item.

Returns:

the ItemStack.

getGUI

public abstract GUI getGUI(org.bukkit.entity.Player player)

Retrieves a GUI instance associated with the provided player.

Parameters:

player - the player for whom the GUI is being retrieved. Must not be null.

Returns:

the GUI instance corresponding to the specified player, or null if no GUI is associated.

Throws:

NullPointerException - if the provided player is null.

closeGUI

public abstract void closeGUI(org.bukkit.entity.Player player)

Closes the GUI associated with the specified player, if any.

Parameters:

player - the player whose GUI should be closed. Must not be null.

Throws:

NullPointerException - if the provided player is null.

openGUI

public abstract void openGUI(org.bukkit.entity.Player player,
                             GUI gui)

Opens a specified GUI for the given player. This method associates the player with the provided GUI instance and displays the interface.

Parameters:

player - the player for whom the GUI will be opened. Must not be null.

gui - the GUI instance to be opened for the player. Must not be null.

Throws:

NullPointerException - if either the player or GUI is null.

isPre1_13

public abstract boolean isPre1_13()

Determines whether the server is before 1.13.

Returns:

true if the server is 1.12 or below.

isPost1_14

public abstract boolean isPost1_14()

Determines whether the server version is 1.14 or newer.

Returns:

true if the server version is 1.14 or above