io.github.bananapuncher714.cartographer.core.api

Interface PacketHandler

public interface PacketHandler

Handle NMS methods and packet manipulation.

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
org.bukkit.map.MapCursor	constructMapCursor(int x, int y, double yaw, org.bukkit.map.MapCursor.Type cursorType, java.lang.String name) Construct a MapCursor with the following params.
double	getTPS() Get the current TPS of the Minecraft server.
GeneralUtil	getUtil() Get the GeneralUtil for this PacketHandler.
MinimapPalette	getVanillaPalette() Get the vanilla MinimapPalette, per version.
boolean	isMapRegistered(int id) Check if the id provided is a Cartographer2 map.
default boolean	mapBug() Check if the Minecraft version contains freezing maps.
java.lang.Object	onPacketInterceptIn(org.bukkit.entity.Player player, java.lang.Object packet) Called before a packet gets sent from player to server.
java.lang.Object	onPacketInterceptOut(org.bukkit.entity.Player player, java.lang.Object packet) Called before a packet gets sent from server to player.
boolean	registerCommand(org.bukkit.command.PluginCommand command) Register a command with the default fallback prefix.
boolean	registerCommand(java.lang.String fallbackPrefix, org.bukkit.command.PluginCommand command) Register a command with the fallback prefix indicated.
void	registerMap(int id) Register a MapView with Cartographer2.
void	sendDataTo(int id, byte[] data, org.bukkit.map.MapCursor[] cursors, java.util.UUID... uuids) Send map data to the client.
void	unregisterCommand(org.bukkit.command.PluginCommand command) Unregister a command.
void	unregisterMap(int id) Unregister a MapView with Cartographer2.

Method Detail

onPacketInterceptOut

java.lang.Object onPacketInterceptOut(org.bukkit.entity.Player player,
                                      java.lang.Object packet)

Called before a packet gets sent from server to player.

Parameters:

player - The player receiving the packet.

packet - The packet being sent.

Returns:

The packet that should be sent, null indicates nothing should be sent.

onPacketInterceptIn

java.lang.Object onPacketInterceptIn(org.bukkit.entity.Player player,
                                     java.lang.Object packet)

Called before a packet gets sent from player to server.

Parameters:

player - The player sending the packet.

packet - The packet being received.

Returns:

The packet that should be received, null indicates nothing should be received.

isMapRegistered

boolean isMapRegistered(int id)

Check if the id provided is a Cartographer2 map.

Parameters:

id - The id of a Bukkit MapView.

Returns:

If the MapView with the given id is currently being used for Cartographer2.

unregisterMap

void unregisterMap(int id)

Unregister a MapView with Cartographer2.

Parameters:

id - The id of a Bukkit MapView.

registerMap

void registerMap(int id)

Register a MapView with Cartographer2.

Parameters:

id - The id of a Bukkit MapView

sendDataTo

void sendDataTo(int id,
                byte[] data,
                org.bukkit.map.MapCursor[] cursors,
                java.util.UUID... uuids)

Send map data to the client.

Parameters:

id - The id of the Bukkit MapView.

data - An array of data with size of 128 * 128.

cursors - An array of MapCursors on the map.

uuids - An array of the UUID of players receiving this data.

getVanillaPalette

MinimapPalette getVanillaPalette()

Get the vanilla MinimapPalette, per version.

Returns:

A new MinimapPalette constructed from NMS block and colors.

mapBug

default boolean mapBug()

Check if the Minecraft version contains freezing maps.

Returns:

If the version is 1.10.2 or below.

constructMapCursor

org.bukkit.map.MapCursor constructMapCursor(int x,
                                            int y,
                                            double yaw,
                                            org.bukkit.map.MapCursor.Type cursorType,
                                            java.lang.String name)

Construct a MapCursor with the following params.

Parameters:

x - The x position on the map, from -128 to 127.

y - The y position on the map, from -128 to 127.

yaw - The yaw of the cursor, in degrees.

cursorType - The type of the cursor. Cannot be null.

name - The name that will be displayed by the cursor, if applicable. Can be null.

Returns:

A Bukkit MapCursor.

getTPS

double getTPS()

Get the current TPS of the Minecraft server.

Returns:

May fluctuate highly and quickly, and go above 20.

registerCommand

boolean registerCommand(java.lang.String fallbackPrefix,
                        org.bukkit.command.PluginCommand command)

Register a command with the fallback prefix indicated.

Parameters:

fallbackPrefix - The prefix to use if another command shares the same value.

command - Cannot be null.

Returns:

Whether the command was registered successfully.

registerCommand

boolean registerCommand(org.bukkit.command.PluginCommand command)

Register a command with the default fallback prefix.

Parameters:

command - Cannot be null. The fallback prefix will be the name of the plugin of the command.

Returns:

Whether the command was registered successfully.

unregisterCommand

void unregisterCommand(org.bukkit.command.PluginCommand command)

Unregister a command.

Parameters:

command - The command to unregister, cannot be null.

getUtil

GeneralUtil getUtil()

Get the GeneralUtil for this PacketHandler.

Returns:

A version specific GeneralUtil.