Package com.plotsquared.bukkit.util

Class BukkitUtil

java.lang.Object

com.plotsquared.core.util.WorldUtil

com.plotsquared.bukkit.util.BukkitUtil

public class BukkitUtil
extends WorldUtil

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.adventure.platform.bukkit.BukkitAudiences	BUKKIT_AUDIENCES
static final net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer	LEGACY_COMPONENT_SERIALIZER
static final net.kyori.adventure.text.minimessage.MiniMessage	MINI_MESSAGE

Constructor Summary

Constructors

Constructor	Description
BukkitUtil()

Method Summary

Modifier and Type	Method	Description
static @NonNull Location	adapt(@NonNull Location location)	Turn a PlotSquared Location into a Bukkit Location.
static @NonNull BukkitPlayer	adapt(@NonNull Player player)	Turn a Bukkit Player into a PlotSquared PlotPlayer
static @NonNull Location	adapt(@NonNull Location location)	Turn a Bukkit Location into a PlotSquared Location.
static @NonNull Location	adaptComplete(@NonNull Location location)	Turn a Bukkit Location into a PlotSquared Location.
void	getBiome(@NonNull String world, int x, int z, @NonNull Consumer<com.sk89q.worldedit.world.biome.BiomeType> result)
@NonNull com.sk89q.worldedit.world.biome.BiomeType	getBiomeSynchronous(@NonNull String world, int x, int z)
void	getBlock(@NonNull Location location, @NonNull Consumer<com.sk89q.worldedit.world.block.BlockState> result)
@NonNull com.sk89q.worldedit.world.block.BlockState	getBlockSynchronous(@NonNull Location location)
Set<com.sk89q.worldedit.math.BlockVector2>	getChunkChunks(String world)
@NonNull StringComparison<com.sk89q.worldedit.world.block.BlockState>.ComparisonResult	getClosestBlock(@NonNull String name)
@org.checkerframework.checker.index.qual.NonNegative int	getFoodLevel(@NonNull PlotPlayer<?> player)
@org.checkerframework.checker.index.qual.NonNegative double	getHealth(@NonNull PlotPlayer<?> player)
void	getHighestBlock(@NonNull String world, int x, int z, @NonNull IntConsumer result)
@org.checkerframework.checker.index.qual.NonNegative int	getHighestBlockSynchronous(@NonNull String world, int x, int z)
@NonNull String[]	getSignSynchronous(@NonNull Location location)
@NonNull Location	getSpawn(@NonNull String world)
@org.checkerframework.checker.index.qual.NonNegative int	getTileEntityCount(@NonNull String world, @NonNull com.sk89q.worldedit.math.BlockVector2 chunk)
@NonNull Collection<com.sk89q.worldedit.world.block.BlockType>	getTileEntityTypes()
@NonNull Set<com.sk89q.worldedit.world.entity.EntityType>	getTypesInCategory(@NonNull String category)
@NonNull com.sk89q.worldedit.world.World	getWeWorld(@NonNull String world)
static @Nullable World	getWorld(@NonNull String string)	Get a Bukkit World from its name
boolean	isBlockSame(@NonNull com.sk89q.worldedit.world.block.BlockState block1, @NonNull com.sk89q.worldedit.world.block.BlockState block2)
boolean	isWorld(@NonNull String worldName)
void	refreshChunk(int x, int z, String world)
void	saveWorld(@NonNull String worldName)
void	setFoodLevel(@NonNull PlotPlayer<?> player, @org.checkerframework.checker.index.qual.NonNegative int foodLevel)
void	setHealth(@NonNull PlotPlayer<?> player, @org.checkerframework.checker.index.qual.NonNegative double health)
void	setSign(@NonNull Location location, @NonNull Caption[] lines, @NonNull net.kyori.adventure.text.minimessage.Template... replacements)
void	setSpawn(@NonNull Location location)

Methods inherited from class com.plotsquared.core.util.WorldUtil

setBiome, setBiome, setBiomes, upload

Methods inherited from class java.lang.Object

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

Field Details

BUKKIT_AUDIENCES

public static final net.kyori.adventure.platform.bukkit.BukkitAudiences BUKKIT_AUDIENCES

LEGACY_COMPONENT_SERIALIZER

public static final net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer LEGACY_COMPONENT_SERIALIZER

MINI_MESSAGE

public static final net.kyori.adventure.text.minimessage.MiniMessage MINI_MESSAGE

Constructor Details

BukkitUtil

public BukkitUtil()

Method Details

adapt

public static @NonNull BukkitPlayer adapt(@NonNull Player player)

Turn a Bukkit Player into a PlotSquared PlotPlayer

Parameters:

player - Bukkit player

Returns:

PlotSquared player

adapt

public static @NonNull Location adapt(@NonNull Location location)

Turn a Bukkit Location into a PlotSquared Location. This only copies the 4-tuple (world,x,y,z) and does not include the yaw and the pitch

Parameters:

location - Bukkit location

Returns:

PlotSquared location

adaptComplete

public static @NonNull Location adaptComplete(@NonNull Location location)

Turn a Bukkit Location into a PlotSquared Location. This copies the entire 6-tuple (world,x,y,z,yaw,pitch).

Parameters:

location - Bukkit location

Returns:

PlotSquared location

adapt

public static @NonNull Location adapt(@NonNull Location location)

Turn a PlotSquared Location into a Bukkit Location. This only copies the 4-tuple (world,x,y,z) and does not include the yaw and the pitch

Parameters:

location - PlotSquared location

Returns:

Bukkit location

getWorld

public static @Nullable World getWorld(@NonNull String string)

Get a Bukkit World from its name

Parameters:

string - World name

Returns:

World if it exists, or null

isBlockSame

public boolean isBlockSame(@NonNull com.sk89q.worldedit.world.block.BlockState block1,
 @NonNull com.sk89q.worldedit.world.block.BlockState block2)

Specified by:

isBlockSame in class WorldUtil

isWorld

public boolean isWorld(@NonNull String worldName)

Specified by:

isWorld in class WorldUtil

getBiome

public void getBiome(@NonNull String world,
 int x,
 int z,
 @NonNull Consumer<com.sk89q.worldedit.world.biome.BiomeType> result)

Specified by:

getBiome in class WorldUtil

getBiomeSynchronous

public @NonNull com.sk89q.worldedit.world.biome.BiomeType getBiomeSynchronous(@NonNull String world,
 int x,
 int z)

Specified by:

getBiomeSynchronous in class WorldUtil

getHighestBlock

public void getHighestBlock(@NonNull String world,
 int x,
 int z,
 @NonNull IntConsumer result)

Specified by:

getHighestBlock in class WorldUtil

getHighestBlockSynchronous

public @org.checkerframework.checker.index.qual.NonNegative int getHighestBlockSynchronous(@NonNull String world,
 int x,
 int z)

Specified by:

getHighestBlockSynchronous in class WorldUtil

getSignSynchronous

public @NonNull String[] getSignSynchronous(@NonNull Location location)

Specified by:

getSignSynchronous in class WorldUtil

getSpawn

public @NonNull Location getSpawn(@NonNull String world)

Specified by:

getSpawn in class WorldUtil

setSpawn

public void setSpawn(@NonNull Location location)

Specified by:

setSpawn in class WorldUtil

saveWorld

public void saveWorld(@NonNull String worldName)

Specified by:

saveWorld in class WorldUtil

setSign

public void setSign(@NonNull Location location,
 @NonNull Caption[] lines,
 @NonNull net.kyori.adventure.text.minimessage.Template... replacements)

Specified by:

setSign in class WorldUtil

getClosestBlock

public @NonNull StringComparison<com.sk89q.worldedit.world.block.BlockState>.ComparisonResult getClosestBlock(@NonNull String name)

Specified by:

getClosestBlock in class WorldUtil

getWeWorld

public @NonNull com.sk89q.worldedit.world.World getWeWorld(@NonNull String world)

Specified by:

getWeWorld in class WorldUtil

refreshChunk

public void refreshChunk(int x,
 int z,
 String world)

Specified by:

refreshChunk in class WorldUtil

getBlock

public void getBlock(@NonNull Location location,
 @NonNull Consumer<com.sk89q.worldedit.world.block.BlockState> result)

Specified by:

getBlock in class WorldUtil

getBlockSynchronous

public @NonNull com.sk89q.worldedit.world.block.BlockState getBlockSynchronous(@NonNull Location location)

Specified by:

getBlockSynchronous in class WorldUtil

getHealth

public @org.checkerframework.checker.index.qual.NonNegative double getHealth(@NonNull PlotPlayer<?> player)

Specified by:

getHealth in class WorldUtil

getFoodLevel

public @org.checkerframework.checker.index.qual.NonNegative int getFoodLevel(@NonNull PlotPlayer<?> player)

Specified by:

getFoodLevel in class WorldUtil

setHealth

public void setHealth(@NonNull PlotPlayer<?> player,
 @org.checkerframework.checker.index.qual.NonNegative double health)

Specified by:

setHealth in class WorldUtil

setFoodLevel

public void setFoodLevel(@NonNull PlotPlayer<?> player,
 @org.checkerframework.checker.index.qual.NonNegative int foodLevel)

Specified by:

setFoodLevel in class WorldUtil

getTypesInCategory

public @NonNull Set<com.sk89q.worldedit.world.entity.EntityType> getTypesInCategory(@NonNull String category)

Specified by:

getTypesInCategory in class WorldUtil

getTileEntityTypes

public @NonNull Collection<com.sk89q.worldedit.world.block.BlockType> getTileEntityTypes()

Specified by:

getTileEntityTypes in class WorldUtil

getTileEntityCount

public @org.checkerframework.checker.index.qual.NonNegative int getTileEntityCount(@NonNull String world,
 @NonNull com.sk89q.worldedit.math.BlockVector2 chunk)

Specified by:

getTileEntityCount in class WorldUtil

getChunkChunks

public Set<com.sk89q.worldedit.math.BlockVector2> getChunkChunks(String world)

Overrides:

getChunkChunks in class WorldUtil