Package org.bukkit.block

Interface Bell

All Superinterfaces:

BlockState, Metadatable, PersistentDataHolder, TileState

public interface Bell
extends TileState

Represents a captured state of Bell.

Method Summary

Modifier and Type	Method	Description
int	getResonatingTicks()	Get the amount of ticks since this bell has been resonating, or 0 if the bell is not currently resonating.
int	getShakingTicks()	Get the amount of ticks since this bell has been shaking, or 0 if the bell is not currently shaking.
boolean	isResonating()	Check whether or not this bell is resonating.
boolean	isShaking()	Check whether or not this bell is shaking.
boolean	ring()	Ring this bell in the direction that the bell is facing.
boolean	ring(BlockFace direction)	Ring this bell.
boolean	ring(Entity entity)	Ring this bell in the direction that the bell is facing.
boolean	ring(Entity entity, BlockFace direction)	Ring this bell.

Methods inherited from interface org.bukkit.block.BlockState

copy, copy, getBlock, getBlockData, getChunk, getData, getLightLevel, getLocation, getLocation, getRawData, getType, getWorld, getX, getY, getZ, isPlaced, setBlockData, setData, setRawData, setType, update, update, update

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.block.TileState

getPersistentDataContainer

Method Details

ring

boolean ring(@Nullable
 Entity entity,
 @Nullable
 BlockFace direction)

Ring this bell. This will call a BellRingEvent.

Parameters:

entity - the entity ringing the bell

direction - the direction from which the bell was rung or null to ring in the direction that the bell is facing

Returns:

true if rung successfully, false if the event was cancelled

ring

boolean ring(@Nullable
 Entity entity)

Ring this bell in the direction that the bell is facing. This will call a BellRingEvent.

Parameters:

entity - the entity ringing the bell

Returns:

true if rung successfully, false if the event was cancelled

ring

boolean ring(@Nullable
 BlockFace direction)

Ring this bell. This will call a BellRingEvent.

Parameters:

direction - the direction from which the bell was rung or null to ring in the direction that the bell is facing

Returns:

true if rung successfully, false if the event was cancelled

ring

boolean ring()

Ring this bell in the direction that the bell is facing. This will call a BellRingEvent.

Returns:

true if rung successfully, false if the event was cancelled

isShaking

boolean isShaking()

Check whether or not this bell is shaking. A bell is considered to be shaking if it was recently rung.

A bell will typically shake for 50 ticks.

Returns:

true if shaking, false otherwise

getShakingTicks

int getShakingTicks()

Get the amount of ticks since this bell has been shaking, or 0 if the bell is not currently shaking.

A bell will typically shake for 50 ticks.

Returns:

the time in ticks since the bell was rung, or 0 if not shaking

isResonating

boolean isResonating()

Check whether or not this bell is resonating. A bell is considered to be resonating if while shaking, raiders were detected in the area and are ready to be highlighted to nearby players.

A bell will typically resonate for 40 ticks.

Returns:

true if resonating, false otherwise

getResonatingTicks

int getResonatingTicks()

Get the amount of ticks since this bell has been resonating, or 0 if the bell is not currently resonating.

A bell will typically resonate for 40 ticks.

Returns:

the time in ticks since the bell has been resonating, or 0 if not resonating