com.alpineclient.plugin.api.objects

Class AlpinePlayer

java.lang.Object

com.alpineclient.plugin.api.objects.AlpinePlayer

public final class AlpinePlayer
extends java.lang.Object

Holds data about an Alpine Client user and provides methods for interacting with them.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
AlpinePlayer(@NotNull org.bukkit.entity.Player bukkitPlayer, @NotNull com.alpineclient.plugin.util.object.HandshakeData data)
AlpinePlayer(@NotNull org.bukkit.entity.Player bukkitPlayer, @NotNull java.lang.String platform, @NotNull java.lang.String version)

Method Summary

Modifier and Type	Method and Description
void	deleteWaypoint(@NotNull java.util.UUID id) Requests the player delete a waypoint with a given UUID.
@NotNull org.bukkit.entity.Player	getBukkitPlayer() Get the underlying Bukkit player object.
@NotNull java.lang.String	getClientBrand() Get the full client brand consisting of their version and platform.
@NotNull java.util.List<java.lang.String>	getMods() Deprecated. functionality removed; no replacement
@NotNull java.lang.String	getPlatform() Get the mod platform the user is on.
@NotNull java.lang.String	getVersion() Get the Minecraft version the user is on.
void	sendCooldown(@NotNull Cooldown cooldown) Sends a cooldown to this player.
void	sendNotification(@NotNull Notification notification) Sends a notification to this player.
void	sendWaypoint(@NotNull Waypoint waypoint) Sends a waypoint to this player.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlpinePlayer

@ApiStatus.Internal
public AlpinePlayer(@NotNull
                                        @NotNull org.bukkit.entity.Player bukkitPlayer,
                                        @NotNull
                                        @NotNull com.alpineclient.plugin.util.object.HandshakeData data)

AlpinePlayer

@ApiStatus.Internal
public AlpinePlayer(@NotNull
                                        @NotNull org.bukkit.entity.Player bukkitPlayer,
                                        @NotNull
                                        @NotNull java.lang.String platform,
                                        @NotNull
                                        @NotNull java.lang.String version)

Method Detail

getBukkitPlayer

@NotNull
public @NotNull org.bukkit.entity.Player getBukkitPlayer()

Get the underlying Bukkit player object.

Returns:

the Player

getPlatform

@NotNull
public @NotNull java.lang.String getPlatform()

Get the mod platform the user is on.

e.g. fabric, forge

Returns:

the mod platform

getVersion

@NotNull
public @NotNull java.lang.String getVersion()

Get the Minecraft version the user is on.

e.g. 1.8.9, 1.20

Returns:

the Minecraft version

getMods

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="1.4.0")
 @NotNull
public @NotNull java.util.List<java.lang.String> getMods()

Deprecated. functionality removed; no replacement

Get all the user's loaded mod IDs.

e.g. ["sodium", "lithium", "alpineclient"]

Returns:

a list containing mod IDs

getClientBrand

@NotNull
public @NotNull java.lang.String getClientBrand()

Get the full client brand consisting of their version and platform.

e.g. 1.18.2-fabric

Returns:

the client brand

sendNotification

public void sendNotification(@NotNull
                             @NotNull Notification notification)

Sends a notification to this player.

Parameters:

notification - the notification to send

sendWaypoint

public void sendWaypoint(@NotNull
                         @NotNull Waypoint waypoint)

Sends a waypoint to this player.

Parameters:

waypoint - the waypoint to send

deleteWaypoint

public void deleteWaypoint(@NotNull
                           @NotNull java.util.UUID id)

Requests the player delete a waypoint with a given UUID.

Parameters:

id - the waypoint to delete

Since:

1.2.1

sendCooldown

public void sendCooldown(@NotNull
                         @NotNull Cooldown cooldown)

Sends a cooldown to this player.

If you intend to utilize the Cooldowns module, you must first declare the capability with AlpineClientApi.registerCapabilities(Plugin, Capability...).

Parameters:

cooldown - the cooldown to send

Since:

1.3.0