com.aaaaahhhhhhh.bananapuncher714.dimensional.block.library.api

Class DBlock

java.lang.Object

com.aaaaahhhhhhh.bananapuncher714.dimensional.block.library.api.DBlock

public abstract class DBlock
extends java.lang.Object

Base class for a custom block.

Constructor Summary

Constructors

Constructor and Description
DBlock(DInfo info)

Method Summary

Modifier and Type	Method and Description
void	applyPhysics(org.bukkit.Location location) Update the physics of the the nearby blocks surrounding the location, including the block.
void	attackBlock(DBlockData data, org.bukkit.Location location, org.bukkit.entity.HumanEntity entity) Called when a player starts mining a block.
boolean	canEntitySpawnOn(DBlockData data, org.bukkit.Location location, org.bukkit.NamespacedKey type) Set whether the entity type can spawn on the given block.
boolean	causesSuffocation(DBlockData data, org.bukkit.Location location) Does this block cause suffocation damage if the player's head is inside of it.
boolean	destroyedByFluid(DBlockData data, org.bukkit.NamespacedKey fluid) Whether or not the block can be destroyed by the fluid.
void	doPhysics(DBlockData data, org.bukkit.Location location, org.bukkit.Location otherBlock) Called when physics are applied to this object.
void	dropNaturally(DBlockData data, org.bukkit.Location location, org.bukkit.inventory.ItemStack item) Called when the block gets broken.
org.bukkit.block.data.BlockData	getClientBlock(DBlockData data) Set the client view of this block to the BlockData provided.
int	getComparatorLevel(DBlockData data, org.bukkit.Location location) Get the level of redstone that will be given to a comparator.
org.bukkit.block.data.BlockData	getData()
DBlockData	getDefaultBlockData()
float	getExplosionResistance() Get the explosion resistance of this block.
DInfo	getInfo()
org.bukkit.NamespacedKey	getKey()
java.awt.Color	getMapColor(DBlockData data, org.bukkit.Location location) Get the color that should show up on the map.
PistonReaction	getPistonReaction(DBlockData data)
int	getPowerSourceLevel(DBlockData data, org.bukkit.Location location, org.bukkit.block.BlockFace face) Get the level of redstone that is emitted in the direction provided.
abstract DState<?>[]	getStates() Return a list of all DStates that this block supports.
static DTileEntity	getTileEntity(org.bukkit.Location location) Get the DTileEntity at the given location, if it exists.
void	handleRain(org.bukkit.Location location) Called every once in a while when it's raining.
InteractionResult	interact(DBlockData data, org.bukkit.Location location, org.bukkit.entity.HumanEntity entity, boolean mainhand, CollisionResultBlock ray) Called when a HumanEntity right clicks this block, with either hand.
boolean	isComplexRedstone(DBlockData data) Whether or not this block will give comparator output.
boolean	isOccluding(DBlockData data, org.bukkit.Location location) Set whether the block is occluding, such as preventing chests from being accessible.
boolean	isPowerSource(DBlockData data) Whether or not this block will give off redstone power.
void	onContact(DBlockData data, org.bukkit.Location location, org.bukkit.entity.Entity entity) Called when an entity touches, or is inside the block.
void	onDataUpdate(DBlockData data, org.bukkit.Location location) Called after this block gets placed in the world, either through code or command.
void	onProjectileHit(DBlockData data, org.bukkit.entity.Entity projectile, CollisionResultBlock ray) Called when a projectile, hits the block.
void	onRegister() Manage all block related stuff here, such as setting the states and their various values.
void	postBreak(DBlockData data, org.bukkit.Location location) Called after the block gets broken by the player, or removed somehow.
void	stepOn(org.bukkit.Location location, org.bukkit.entity.Entity entity) Called when an entity is standing directly on top of the block.
void	tick(DBlockData data, org.bukkit.Location location, java.util.Random random) Tick event.
void	tickLater(org.bukkit.Location location, int delay) Call the tick(DBlockData, Location, Random) method after a given delay
static void	update(DBlockData block, org.bukkit.Location location) Set the provided DBlockData to the location, and apply physics.
static void	update(DBlockData block, org.bukkit.Location location, boolean doPhysics) Set the provided DBlockData to the location, and apply physics if specified.
void	updateState(DBlockData data, org.bukkit.Location blockloc, org.bukkit.Location neighbor, org.bukkit.block.BlockFace direction) Called when a neighboring block has been changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBlock

public DBlock(DInfo info)

Method Detail

getKey

public final org.bukkit.NamespacedKey getKey()

getInfo

public final DInfo getInfo()

getData

public final org.bukkit.block.data.BlockData getData()

getDefaultBlockData

public final DBlockData getDefaultBlockData()

tickLater

public final void tickLater(org.bukkit.Location location,
                            int delay)

Call the tick(DBlockData, Location, Random) method after a given delay

Parameters:

location - The location of the block to tick.

delay - The delay in ticks.

applyPhysics

public final void applyPhysics(org.bukkit.Location location)

Update the physics of the the nearby blocks surrounding the location, including the block.

Parameters:

location - The location to update around.

onRegister

public void onRegister()

Manage all block related stuff here, such as setting the states and their various values. Gets called after being completely added to the internal registries.

getClientBlock

public org.bukkit.block.data.BlockData getClientBlock(DBlockData data)

Set the client view of this block to the BlockData provided.

Parameters:

data - This value should not be modified in any way except for determining the states. Doing so will throw an IllegalArgumentException.

Returns:

A non-null block data representing the state client side.

onContact

public void onContact(DBlockData data,
                      org.bukkit.Location location,
                      org.bukkit.entity.Entity entity)

Called when an entity touches, or is inside the block.

Parameters:

data -

location -

entity -

dropNaturally

public void dropNaturally(DBlockData data,
                          org.bukkit.Location location,
                          org.bukkit.inventory.ItemStack item)

Called when the block gets broken. Drop items and things here.

Parameters:

data -

location -

item -

canEntitySpawnOn

public boolean canEntitySpawnOn(DBlockData data,
                                org.bukkit.Location location,
                                org.bukkit.NamespacedKey type)

Set whether the entity type can spawn on the given block.

Parameters:

data -

location -

type - NamespacedKey of the entity. Follows NMS naming conventions. May not match with Bukkit EntityType enums.

Returns:

isOccluding

public boolean isOccluding(DBlockData data,
                           org.bukkit.Location location)

Set whether the block is occluding, such as preventing chests from being accessible.

Parameters:

data -

location -

Returns:

attackBlock

public void attackBlock(DBlockData data,
                        org.bukkit.Location location,
                        org.bukkit.entity.HumanEntity entity)

Called when a player starts mining a block.

Parameters:

data -

location -

entity -

stepOn

public void stepOn(org.bukkit.Location location,
                   org.bukkit.entity.Entity entity)

Called when an entity is standing directly on top of the block.

Parameters:

location -

entity -

onProjectileHit

public void onProjectileHit(DBlockData data,
                            org.bukkit.entity.Entity projectile,
                            CollisionResultBlock ray)

Called when a projectile, hits the block. Does not apply to snowballs for some reason.

Parameters:

data -

projectile - Does not support all projectiles.

ray -

onDataUpdate

public void onDataUpdate(DBlockData data,
                         org.bukkit.Location location)

Called after this block gets placed in the world, either through code or command.

Parameters:

data -

location -

postBreak

public void postBreak(DBlockData data,
                      org.bukkit.Location location)

Called after the block gets broken by the player, or removed somehow.

Parameters:

data -

location -

tick

public void tick(DBlockData data,
                 org.bukkit.Location location,
                 java.util.Random random)

Tick event. This is NOT called every tick, but only when called through @{link tickLater(Location, int).

Parameters:

data -

location -

random -

updateState

public void updateState(DBlockData data,
                        org.bukkit.Location blockloc,
                        org.bukkit.Location neighbor,
                        org.bukkit.block.BlockFace direction)

Called when a neighboring block has been changed.

Parameters:

data -

blockloc -

neighbor -

direction - The direction of the neighboring block.

doPhysics

public void doPhysics(DBlockData data,
                      org.bukkit.Location location,
                      org.bukkit.Location otherBlock)

Called when physics are applied to this object. May include things like redstone, and regular physics checks.

Parameters:

data -

location -

otherBlock - May not always be directly adjacent to the block.

handleRain

public void handleRain(org.bukkit.Location location)

Called every once in a while when it's raining.

Parameters:

location - Not sure what this location represents.

isComplexRedstone

public boolean isComplexRedstone(DBlockData data)

Whether or not this block will give comparator output.

Parameters:

data -

Returns:

getComparatorLevel

public int getComparatorLevel(DBlockData data,
                              org.bukkit.Location location)

Get the level of redstone that will be given to a comparator. @{link isComplexRedstone(DBlockData) must return true for this to be called. Apply a physics update if the comparator level output changes.

Parameters:

data -

location -

Returns:

isPowerSource

public boolean isPowerSource(DBlockData data)

Whether or not this block will give off redstone power.

Parameters:

data -

Returns:

getPowerSourceLevel

public int getPowerSourceLevel(DBlockData data,
                               org.bukkit.Location location,
                               org.bukkit.block.BlockFace face)

Get the level of redstone that is emitted in the direction provided. @{link isPowerSource(DBlockData) must return true for this to be called. Apply a physics update if the redstone level changes.

Parameters:

data -

location -

face -

Returns:

interact

public InteractionResult interact(DBlockData data,
                                  org.bukkit.Location location,
                                  org.bukkit.entity.HumanEntity entity,
                                  boolean mainhand,
                                  CollisionResultBlock ray)

Called when a HumanEntity right clicks this block, with either hand.

Parameters:

data -

location -

entity -

mainhand -

ray -

Returns:

PASS signifies that nothing has occurred, and the item being held will receive the right click action. SUCCESS will cancel any item interaction events that may have occurred instead.

destroyedByFluid

public boolean destroyedByFluid(DBlockData data,
                                org.bukkit.NamespacedKey fluid)

Whether or not the block can be destroyed by the fluid.

Parameters:

data -

fluid - Namespaced key id of the fluid.

Returns:

causesSuffocation

public boolean causesSuffocation(DBlockData data,
                                 org.bukkit.Location location)

Does this block cause suffocation damage if the player's head is inside of it.

Parameters:

data -

location -

Returns:

getExplosionResistance

public float getExplosionResistance()

Get the explosion resistance of this block. Find the vanilla values here: https://minecraft.gamepedia.com/Explosion#Blast_resistance

Returns:

getMapColor

public java.awt.Color getMapColor(DBlockData data,
                                  org.bukkit.Location location)

Get the color that should show up on the map. It will be matched to the closest available Minecraft color.

Parameters:

data -

location -

Returns:

getPistonReaction

public PistonReaction getPistonReaction(DBlockData data)

getStates

public abstract DState<?>[] getStates()

Return a list of all DStates that this block supports.

Returns:

update

public static void update(DBlockData block,
                          org.bukkit.Location location)

Set the provided DBlockData to the location, and apply physics.

Parameters:

block -

location -

update

public static void update(DBlockData block,
                          org.bukkit.Location location,
                          boolean doPhysics)

Set the provided DBlockData to the location, and apply physics if specified.

Parameters:

block -

location -

doPhysics - Whether or not to apply physics.

getTileEntity

public static DTileEntity getTileEntity(org.bukkit.Location location)

Get the DTileEntity at the given location, if it exists.

Parameters:

location -

Returns:

Returns null if not found.