Package dev.lone.itemsadder.api

Class CustomBlock

java.lang.Object

dev.lone.itemsadder.api.CustomStack

dev.lone.itemsadder.api.CustomBlock

public class CustomBlock
extends CustomStack

Class representing a custom block in ItemsAdder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomBlock.Advanced	This class contains advanced static methods to perform various uncommon tasks, for example read/write directly into the ItemsAdder CustomBlocks region files.

Constructor Summary

Constructors

Constructor	Description
CustomBlock()

Method Summary

Modifier and Type	Method	Description
static @Nullable CustomBlock	byAlreadyPlaced(org.bukkit.block.Block block)	Gets a CustomBlock instance through the provided Bukkit Block.
static @Nullable CustomBlock	byItemStack(org.bukkit.inventory.ItemStack itemStack)	Gets a CustomBlock instance through the provided Bukkit ItemStack.
@Nullable org.bukkit.block.data.BlockData	generateBlockData()	Deprecated. This method name is misleading.
@Nullable org.bukkit.block.data.BlockData	getBaseBlockData()	Gets the base BlockData for this CustomBlock.
static @Nullable org.bukkit.block.data.BlockData	getBaseBlockData(String namespacedID)	Gets the base BlockData for this CustomBlock.
org.bukkit.block.Block	getBlock()	Gets the Bukkit Block associated with this CustomBlock.
static @Nullable CustomBlock	getInstance(String namespacedID)	Gets a CustomBlock instance through the provided namespace and ID.
List<org.bukkit.inventory.ItemStack>	getLoot()	Returns a list of ItemStack instances to drop as loot for this CustomBlock.
List<org.bukkit.inventory.ItemStack>	getLoot(boolean includeSelfBlock)	Returns a list of ItemStack instances to drop as loot for this CustomBlock.
List<org.bukkit.inventory.ItemStack>	getLoot(@Nullable org.bukkit.inventory.ItemStack tool, boolean includeSelfBlock)	Returns a list of ItemStack instances to drop as loot for this CustomBlock.
static List<org.bukkit.inventory.ItemStack>	getLoot(org.bukkit.block.Block bukkitBlock, @Nullable org.bukkit.inventory.ItemStack tool, boolean includeSelfBlock)	Returns a list of ItemStack instances to drop as loot for this CustomBlock.
static Set<String>	getNamespacedIdsInRegistry()	Returns a list of all the registered blocks identifiers in the format namespace:id
int	getOriginalLightLevel()	Returns the original light level of this CustomBlock.
static boolean	isInRegistry(String namespacedId)	Returns true if the registry contains a block with the specified namespaced id in the format namespace:id
boolean	isPlaced()	Returns whether this CustomBlock is placed in the world.
static @Nullable CustomBlock	place(String namespacedId, org.bukkit.Location location)	Places a CustomBlock provided through the namespace and ID at the provided location and returns the CustomBlock instance for it.
CustomBlock	place(org.bukkit.Location location)	Places a CustomBlock through the provided location and returns a CustomBlock instance for it.
boolean	playBreakEffect()	Play the block break particles and sound for this custom block.
static boolean	playBreakEffect(org.bukkit.block.Block bukkitBlock)	Play the block break particles and sound for this custom block.
boolean	playBreakParticles()	Play the block break particles for this custom block.
static boolean	playBreakParticles(org.bukkit.block.Block bukkitBlock)	Play the block break particles for this custom block.
boolean	playBreakSound()	Play the block break sound for this custom block.
static boolean	playBreakSound(org.bukkit.block.Block bukkitBlock)	Play the block break sound for this custom block.
boolean	playPlaceSound()	Play the block place particles for this custom block.
static boolean	playPlaceSound(org.bukkit.block.Block bukkitBlock)	Play the block place particles for this custom block.
boolean	remove()	Returns whether removing this CustomBlock was successful or not.
static boolean	remove(org.bukkit.Location location)	Returns whether removing the CustomBlock at the provided location was successful or not.
void	setCurrentLightLevel(int level)	Sets the current light level for this CustomBlock.

Methods inherited from class dev.lone.itemsadder.api.CustomStack

drop, getConfig, getConfigPath, getDamageMainhand, getDisplayName, getDurability, getId, getItemStack, getMaxDurability, getModelPath, getNamespace, getNamespacedID, getPermission, getTextures, getUsages, hasAutoGeneratedModel, hasCustomDurability, hasPermission, hasUsagesAttribute, isBlock, isBlockAllEnchants, matchNamespacedID, reduceUsages, setAttributeModifier, setDisplayName, setDurability, setMaxDurability, setUsages, updateAttackDamageLore, updateAttackSpeedLore

Methods inherited from class java.lang.Object

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

Constructor Details

CustomBlock

public CustomBlock()

Method Details

getNamespacedIdsInRegistry

public static Set<String> getNamespacedIdsInRegistry()

Returns a list of all the registered blocks identifiers in the format namespace:id

Returns:

a list of Namespaces and IDs in the format namespace:id

isInRegistry

public static boolean isInRegistry(String namespacedId)

Returns true if the registry contains a block with the specified namespaced id in the format namespace:id

Parameters:

namespacedId - Namespace and ID in the format namespace:id

Returns:

true if it contains the namespaced id, otherwise false

getInstance

@Nullable
public static @Nullable CustomBlock getInstance(String namespacedID)

Gets a CustomBlock instance through the provided namespace and ID.
This may return null if the provided namespace and ID are invalid.

Parameters:

namespacedID - Namespace and ID in the format namespace:id

Returns:

Possibly-null CustomBlock instance.

byItemStack

@Nullable
public static @Nullable CustomBlock byItemStack(org.bukkit.inventory.ItemStack itemStack)

Gets a CustomBlock instance through the provided Bukkit ItemStack.
This may return null if the provided Bukkit ItemStack is not associated with any CustomBlock.

Parameters:

itemStack - The Bukkit ItemStack to get the CustomBlock instance from.

Returns:

Possibly-null CustomBlock instance.

place

@Nullable
public static @Nullable CustomBlock place(String namespacedId,
 org.bukkit.Location location)

Places a CustomBlock provided through the namespace and ID at the provided location and returns the CustomBlock instance for it.
This may return null if the provided namespace and ID are invalid.

Parameters:

namespacedId - Namespace and ID in the format namespace:id

location - The location to place the CustomBlock at.

Returns:

Possibly-null CustomBlock instance.

place

public CustomBlock place(org.bukkit.Location location)

Places a CustomBlock through the provided location and returns a CustomBlock instance for it.

Parameters:

location - The location to place the CustomBlock at.

Returns:

CustomBlock instance from the location.

byAlreadyPlaced

@Nullable
public static @Nullable CustomBlock byAlreadyPlaced(org.bukkit.block.Block block)

Gets a CustomBlock instance through the provided Bukkit Block.
This may return null if the provided Block is not associated with a CustomBlock.

Parameters:

block - The Bukkit Block to get the CustomBlock from.

Returns:

Possibly-null CustomBlock instance.

remove

public boolean remove()

Returns whether removing this CustomBlock was successful or not.
A removal is successful if the Block associated with this CustomBlock exists.

Returns:

true if the CustomBlock could be removed, otherwise false.

playBreakEffect

public boolean playBreakEffect()

Play the block break particles and sound for this custom block.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playBreakEffect

public static boolean playBreakEffect(org.bukkit.block.Block bukkitBlock)

Play the block break particles and sound for this custom block.

Parameters:

bukkitBlock - the location of which block you want to play break effect of.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playBreakSound

public boolean playBreakSound()

Play the block break sound for this custom block.

Returns:

true if the sound was played successfully because the bukkitBlock is a custom block, otherwise false.

playBreakSound

public static boolean playBreakSound(org.bukkit.block.Block bukkitBlock)

Play the block break sound for this custom block.

Parameters:

bukkitBlock - the location of which block you want to play break sound of.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playBreakParticles

public boolean playBreakParticles()

Play the block break particles for this custom block.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playBreakParticles

public static boolean playBreakParticles(org.bukkit.block.Block bukkitBlock)

Play the block break particles for this custom block.

Parameters:

bukkitBlock - the location of which block you want to play break particles of.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playPlaceSound

public boolean playPlaceSound()

Play the block place particles for this custom block.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

playPlaceSound

public static boolean playPlaceSound(org.bukkit.block.Block bukkitBlock)

Play the block place particles for this custom block.

Parameters:

bukkitBlock - the location of which block you want to play place particles of.

Returns:

true if the effect was played successfully because the bukkitBlock is a custom block, otherwise false.

remove

public static boolean remove(org.bukkit.Location location)

Returns whether removing the CustomBlock at the provided location was successful or not.
A removal is successful if the Block at the provided location is an actual CustomBlock.

Parameters:

location - The location to remove the CustomBlock from.

Returns:

true if the CustomBlock could be removed, otherwise false.

generateBlockData

@Deprecated
@Nullable
public @Nullable org.bukkit.block.data.BlockData generateBlockData()

Deprecated.

This method name is misleading.

Use getBaseBlockData() instead.

Generates and returns BlockData associated with this CustomBlock.

Returns:

BlockData associated with the CustomBlock.

getBaseBlockData

@Nullable
public @Nullable org.bukkit.block.data.BlockData getBaseBlockData()

Gets the base BlockData for this CustomBlock. It doesn't get the current placed block BlockData but the BlockData used to show the custom block in-game.

Warning: TILE CustomBlocks (Spawners) will return null. For now there is no way to obtain this data with this API.

Returns:

the base BlockData for this CustomBlock.

getBaseBlockData

@Nullable
public static @Nullable org.bukkit.block.data.BlockData getBaseBlockData(String namespacedID)

Gets the base BlockData for this CustomBlock. It doesn't get the current placed block BlockData but the BlockData used to show the custom block in-game. Warning: TILE CustomBlocks (Spawners) will return null. For now there is no way to obtain this data with this API.

Parameters:

namespacedID - the Namespace and ID in the format namespace:id of the block to get base BlockData of.

Returns:

the base BlockData for this CustomBlock.

getBlock

public org.bukkit.block.Block getBlock()

Gets the Bukkit Block associated with this CustomBlock.

Returns:

Bukkit Block associated with the CustomBlock.

isPlaced

public boolean isPlaced()

Returns whether this CustomBlock is placed in the world.

Returns:

true if the CustomBlock was placed in the world, otherwise false.

getLoot

public List<org.bukkit.inventory.ItemStack> getLoot(boolean includeSelfBlock)

Returns a list of ItemStack instances to drop as loot for this CustomBlock.

Parameters:

includeSelfBlock - If the CustomBlock itself should be included in the list.

Returns:

List containing ItemStack instances for the loot.

getLoot

public List<org.bukkit.inventory.ItemStack> getLoot()

Returns a list of ItemStack instances to drop as loot for this CustomBlock.

Returns:

List containing ItemStack instances for the loot.

getLoot

public List<org.bukkit.inventory.ItemStack> getLoot(@Nullable
 @Nullable org.bukkit.inventory.ItemStack tool,
 boolean includeSelfBlock)

Returns a list of ItemStack instances to drop as loot for this CustomBlock.

Parameters:

tool - The Item required to get the loot for the CustomBlock.

includeSelfBlock - If the CustomBlock itself should be included in the list.

Returns:

List containing ItemStack instances for the loot.

getLoot

public static List<org.bukkit.inventory.ItemStack> getLoot(org.bukkit.block.Block bukkitBlock,
 @Nullable
 @Nullable org.bukkit.inventory.ItemStack tool,
 boolean includeSelfBlock)

Returns a list of ItemStack instances to drop as loot for this CustomBlock.

Parameters:

bukkitBlock - The Bukkit Block to get the loots from.

tool - The Item required to get the loot for the CustomBlock.

includeSelfBlock - If the CustomBlock itself should be included in the list.

Returns:

List containing ItemStack instances for the loot.

getOriginalLightLevel

public int getOriginalLightLevel()

Returns the original light level of this CustomBlock.

Returns:

Integer representing the original light level of the CustomBlock.

setCurrentLightLevel

public void setCurrentLightLevel(int level)

Sets the current light level for this CustomBlock.

Parameters:

level - The light level to set for this CustomBlock.