sasheg/DeltaZern
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improvements to BlockStates

Browse Source 
* Update Javadoc of block state classes to better match implementation behaviour.
* Add Container interface which provides access to the snapshot inventory.

By: Lukas Hennig <lukas@wirsindwir.de>
This commit is contained in:
Bukkit/Spigot
2017-08-05 14:35:40 +10:00
parent 5727987ab3
commit 2ab655238c
25 changed files with 186 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files
paper-api/src/main/java/org/bukkit/block/NoteBlock.java
+15 -5
View File
@@ -4,7 +4,7 @@ import org.bukkit.Instrument;
import org.bukkit.Note;
/**
* Represents a note.
* Represents a captured state of a note block.
*/
public interface NoteBlock extends BlockState {
@@ -41,31 +41,41 @@ public interface NoteBlock extends BlockState {
public void setRawNote(byte note);
/**
* Attempts to play the note at block
* Attempts to play the note at the block.
* <p>
* If the block is no longer a note block, this will return false
* If the block represented by this block state is no longer a note block,
* this will return false.
*
* @return true if successful, otherwise false
* @throws IllegalStateException if this block state is not placed
*/
public boolean play();
/**
* Plays an arbitrary note with an arbitrary instrument
* Plays an arbitrary note with an arbitrary instrument at the block.
* <p>
* If the block represented by this block state is no longer a note block,
* this will return false.
*
* @param instrument Instrument ID
* @param note Note ID
* @return true if successful, otherwise false
* @throws IllegalStateException if this block state is not placed
* @deprecated Magic value
*/
@Deprecated
public boolean play(byte instrument, byte note);
/**
* Plays an arbitrary note with an arbitrary instrument
* Plays an arbitrary note with an arbitrary instrument at the block.
* <p>
* If the block represented by this block state is no longer a note block,
* this will return false.
*
* @param instrument The instrument
* @param note The note
* @return true if successful, otherwise false
* @throws IllegalStateException if this block state is not placed
* @see Instrument Note
*/
public boolean play(Instrument instrument, Note note);