Package org.bukkit.block

Interface Jukebox

All Superinterfaces:

BlockInventoryHolder, BlockState, InventoryHolder, Metadatable, PersistentDataHolder, TileState

public interface Jukebox
extends TileState, BlockInventoryHolder

Represents a captured state of a jukebox.

Method Summary

Modifier and Type	Method	Description
boolean	eject()	Stops the jukebox playing and ejects the current record.
JukeboxInventory	getInventory()	Get the object's inventory.
Material	getPlaying()	Gets the record inserted into the jukebox.
ItemStack	getRecord()	Gets the record item inserted into the jukebox.
JukeboxInventory	getSnapshotInventory()
boolean	hasRecord()	Gets whether or not this jukebox has a record.
boolean	isPlaying()	Checks if the jukebox is playing a record.
void	setPlaying(Material record)	Sets the record being played.
void	setRecord(ItemStack record)	Sets the record being played.
boolean	startPlaying()	Starts the jukebox playing if there is a record.
void	stopPlaying()	Stops the jukebox playing without ejecting the record.

Methods inherited from interface org.bukkit.inventory.BlockInventoryHolder

getBlock

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

getPlaying

@NotNull
Material getPlaying()

Gets the record inserted into the jukebox.

Returns:

The record Material, or AIR if none is inserted

setPlaying

void setPlaying(@Nullable
 Material record)

Sets the record being played.

Parameters:

record - The record Material, or null/AIR to stop playing

hasRecord

boolean hasRecord()

Gets whether or not this jukebox has a record.

A jukebox can have a record but not be playing if it was stopped with stopPlaying() or if a record has finished playing.

Returns:

true if this jukebox has a record, false if it the jukebox is empty

getRecord

@NotNull
ItemStack getRecord()

Gets the record item inserted into the jukebox.

Returns:

a copy of the inserted record, or an air stack if none

setRecord

void setRecord(@Nullable
 ItemStack record)

Sets the record being played. The jukebox will start playing automatically.

Parameters:

record - the record to insert or null/AIR to empty

isPlaying

boolean isPlaying()

Checks if the jukebox is playing a record.

Returns:

True if there is a record playing

startPlaying

boolean startPlaying()

Starts the jukebox playing if there is a record.

Returns:

true if the jukebox had a record and was able to start playing, false if the jukebox was already playing or did not have a record

stopPlaying

void stopPlaying()

Stops the jukebox playing without ejecting the record.

eject

boolean eject()

Stops the jukebox playing and ejects the current record.

If the block represented by this state is no longer a jukebox, this will do nothing and return false.

Returns:

True if a record was ejected; false if there was none playing

Throws:

IllegalStateException - if this block state is not placed

getInventory

@NotNull
JukeboxInventory getInventory()

Description copied from interface: InventoryHolder

Get the object's inventory.

Specified by:

getInventory in interface InventoryHolder

Returns:

inventory

See Also:

• Container.getInventory()

getSnapshotInventory

@NotNull
JukeboxInventory getSnapshotInventory()

Returns:

snapshot inventory

See Also:

• Container.getSnapshotInventory()