com.alpineclient.plugin.api

Class AlpineClientApi

java.lang.Object

com.alpineclient.plugin.api.AlpineClientApi

public final class AlpineClientApi
extends java.lang.Object

Main wrapper class to interact with the API.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static @NotNull java.util.Collection<AlpinePlayer>	getAllPlayers() Get all players connected via Alpine Client.
static @NotNull java.util.Optional<AlpinePlayer>	getPlayer(@NotNull org.bukkit.entity.Player player) Get a player connected via Alpine Client.
static @NotNull java.util.Optional<AlpinePlayer>	getPlayer(@NotNull java.util.UUID id) Get a player connected via Alpine Client.
static boolean	isPlayerConnected(@NotNull AlpinePlayer player) Check if a player is currently connected via Alpine Client.
static boolean	isPlayerConnected(@NotNull org.bukkit.entity.Player player) Check if a player is connected via Alpine Client.
static boolean	isPlayerConnected(@NotNull java.util.UUID id) Check if a player is connected via Alpine Client.
static void	registerCapabilities(@NotNull org.bukkit.plugin.Plugin plugin, Capability... capabilities) Registers Alpine Client capabilities for a given plugin.
static void	unregisterCapabilities(@NotNull org.bukkit.plugin.Plugin plugin) Unregister all Alpine Client capabilities for a given plugin.

Methods inherited from class java.lang.Object

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

Method Detail

isPlayerConnected

public static boolean isPlayerConnected(@NotNull
                                        @NotNull AlpinePlayer player)

Check if a player is currently connected via Alpine Client.

Parameters:

player - the AlpinePlayer

Returns:

true if the player is using Alpine Client

isPlayerConnected

public static boolean isPlayerConnected(@NotNull
                                        @NotNull org.bukkit.entity.Player player)

Check if a player is connected via Alpine Client.

Parameters:

player - the Player

Returns:

true if the player is using Alpine Client

isPlayerConnected

public static boolean isPlayerConnected(@NotNull
                                        @NotNull java.util.UUID id)

Check if a player is connected via Alpine Client.

Parameters:

id - the UUID of the players account

Returns:

true if the player is using Alpine Client

getPlayer

@NotNull
public static @NotNull java.util.Optional<AlpinePlayer> getPlayer(@NotNull
                                                                           @NotNull org.bukkit.entity.Player player)

Get a player connected via Alpine Client.

Parameters:

player - the Player

Returns:

an Optional describing the player

Since:

1.1.2

getPlayer

@NotNull
public static @NotNull java.util.Optional<AlpinePlayer> getPlayer(@NotNull
                                                                           @NotNull java.util.UUID id)

Get a player connected via Alpine Client.

Parameters:

id - the UUID of the players account

Returns:

an Optional describing the player

Since:

1.1.2

getAllPlayers

@NotNull
public static @NotNull java.util.Collection<AlpinePlayer> getAllPlayers()

Get all players connected via Alpine Client.

Returns:

a list containing AlpinePlayer

Since:

1.1.2

registerCapabilities

public static void registerCapabilities(@NotNull
                                        @NotNull org.bukkit.plugin.Plugin plugin,
                                        @NotNull
                                        Capability... capabilities)

Registers Alpine Client capabilities for a given plugin.

Should be called once for all your desired capabilities on plugin enable.

Parameters:

plugin - the responsible Plugin

capabilities - a varargs array containing Capability

Since:

1.3.0

See Also:

Plugin.onEnable()

unregisterCapabilities

public static void unregisterCapabilities(@NotNull
                                          @NotNull org.bukkit.plugin.Plugin plugin)

Unregister all Alpine Client capabilities for a given plugin.

Should be called once on plugin disable.

Parameters:

plugin - the responsible Plugin

Since:

1.3.0

See Also:

Plugin.onDisable()