me.block2block.hubparkour.api

Class HubParkourAPI

java.lang.Object

me.block2block.hubparkour.api.HubParkourAPI

public class HubParkourAPI
extends Object

The HubParkour API.

Constructor Summary

Constructors

Constructor and Description
HubParkourAPI()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HubParkourAPI

public HubParkourAPI()

Method Detail

isInParkour

public static 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 static 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 static 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 static 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 static org.bukkit.Material getPressurePlateType(int type)
                                                throws NullPointerException

Gets the material type of a specific pressure plate type.

Parameters:

type - the type of pressure plate.

Returns:

the material.

Throws:

NullPointerException

getItem

public static org.bukkit.inventory.ItemStack getItem(int type)
                                              throws NullPointerException

Gets the ItemStack of a specific item type.

Parameters:

type - the type of item.

Returns:

the ItemStack.

Throws:

NullPointerException

getGUI

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

Retrieves the 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 static 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 static void openGUI(org.bukkit.entity.Player player,
                           GUI gui)

Opens the specified GUI for the given player.

Parameters:

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

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

Throws:

NullPointerException - if either the player or the GUI is null.

isPre1_13

public static boolean isPre1_13()

Determines whether the server version is before 1.13.

Returns:

true if the server version is 1.12 or lower; false otherwise.

isPost1_14

public static boolean isPost1_14()

Determines whether the server version is 1.14 or newer.

Returns:

true if the server version is 1.14 or above, false otherwise.