io.github.bananapuncher714.cartographer.core.api

Interface GeneralUtil

public interface GeneralUtil

Different Bukkit methods that change across various Minecraft versions.

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
CrossVersionMaterial	getBlockType(org.bukkit.block.Block block) Get the material type of the block.
CrossVersionMaterial	getBlockType(org.bukkit.ChunkSnapshot snapshot, int x, int y, int z) Get the material of the block in the chunk snapshot at the specified coordinates.
int	getId(org.bukkit.map.MapView view) Get the id of the MapView as an integer.
CrossVersionMaterial	getItemType(org.bukkit.inventory.ItemStack item) Get the material type of the item.
org.bukkit.inventory.ItemStack	getMainHandItem(org.bukkit.entity.Player player) Get the item in the player's main hand
org.bukkit.map.MapView	getMap(int id) Get a MapView for the id provided.
org.bukkit.inventory.ItemStack	getMapItem(int id) Get a filled map item with the mapview of the given id.
org.bukkit.Material	getMapMaterial() Get the material for a filled map.
org.bukkit.map.MapView	getMapViewFrom(org.bukkit.inventory.ItemStack item) Get the a MapView from a map item.
org.bukkit.inventory.ItemStack	getOffHandItem(org.bukkit.entity.Player player) Get the item in the player's off hand
boolean	isValidHand(org.bukkit.event.player.PlayerInteractEvent event) Check if the event is called with the player's main hand.
boolean	isWater(org.bukkit.block.Block block) Check if a block is water.
boolean	isWater(org.bukkit.ChunkSnapshot snapshot, int x, int y, int z) Check if a block at the given position is water.
boolean	updateEvent(org.bukkit.event.block.BlockPhysicsEvent event) Check if this event is significant enough to require updating.

Method Detail

getMapViewFrom

org.bukkit.map.MapView getMapViewFrom(org.bukkit.inventory.ItemStack item)

Get the a MapView from a map item.

Parameters:

item - A map item, may be null.

Returns:

Null if the item is null, or not a map.

getMap

org.bukkit.map.MapView getMap(int id)

Get a MapView for the id provided.

Parameters:

id - The id of the map, may not work for values above 32767 depending on the version of Minecraft.

Returns:

A Bukkit MapView.

getId

int getId(org.bukkit.map.MapView view)

Get the id of the MapView as an integer.

Parameters:

view - Cannot be null.

Returns:

An integer representing the id.

getMapItem

org.bukkit.inventory.ItemStack getMapItem(int id)

Get a filled map item with the mapview of the given id.

Parameters:

id - An integer, may have to be below 32767 depending on the version of Minecraft.

Returns:

An ItemStack of the filled map material.

getMapMaterial

org.bukkit.Material getMapMaterial()

Get the material for a filled map.

Returns:

Actual enum may differ depending on the version of Minecraft.

isValidHand

boolean isValidHand(org.bukkit.event.player.PlayerInteractEvent event)

Check if the event is called with the player's main hand.

Parameters:

event - Cannot be null.

Returns:

If the event's hand is equal to the player's main hand, or true by default in earlier versions of Minecraft.

getMainHandItem

org.bukkit.inventory.ItemStack getMainHandItem(org.bukkit.entity.Player player)

Get the item in the player's main hand

Parameters:

player - The player, cannot be null.

Returns:

The item being held in the main hand

getOffHandItem

org.bukkit.inventory.ItemStack getOffHandItem(org.bukkit.entity.Player player)

Get the item in the player's off hand

Parameters:

player - The player, cannot null.

Returns:

Null if no item is being held.

isWater

boolean isWater(org.bukkit.ChunkSnapshot snapshot,
                int x,
                int y,
                int z)

Check if a block at the given position is water.

Parameters:

snapshot - The snapshot to check

x - X coordinate from 0 to 15.

y - Y coordinate from 0 to 255

z - Z coordinate from 0 to 15.

Returns:

If the block is some form of water, included waterlogged and kelp.

isWater

boolean isWater(org.bukkit.block.Block block)

Check if a block is water.

Parameters:

block - The block to check, cannot be null.

Returns:

If the block is some form of water, included waterlogged and kelp.

getBlockType

CrossVersionMaterial getBlockType(org.bukkit.ChunkSnapshot snapshot,
                                  int x,
                                  int y,
                                  int z)

Get the material of the block in the chunk snapshot at the specified coordinates.

Parameters:

snapshot - Cannot be null.

x - Local x value from 0 to 15.

y - Local y value from 0 to 255.

z - Local z value from 0 to 15.

Returns:

A CrossVersionMaterial representing the type.

getItemType

CrossVersionMaterial getItemType(org.bukkit.inventory.ItemStack item)

Get the material type of the item.

Parameters:

item - Cannot be null.

Returns:

A CrossVersionMaterial representing the type.

getBlockType

CrossVersionMaterial getBlockType(org.bukkit.block.Block block)

Get the material type of the block.

Parameters:

block - Cannot be null.

Returns:

A CrossVersionMaterial representing the type.

updateEvent

boolean updateEvent(org.bukkit.event.block.BlockPhysicsEvent event)

Check if this event is significant enough to require updating.

Parameters:

event - Cannot be null.

Returns:

If the block being updated is the source block.