Many javadoc fixes thanks to Celtic Minstrel
By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
@@ -47,7 +47,7 @@ public interface Block {
|
||||
*
|
||||
* @param face Face of this block to return
|
||||
* @return Block at the given face
|
||||
* @see Block.getRelative(BlockFace face, int distance);
|
||||
* @see #getRelative(BlockFace, int)
|
||||
*/
|
||||
Block getRelative(BlockFace face);
|
||||
|
||||
@@ -199,28 +199,30 @@ public interface Block {
|
||||
/**
|
||||
* Returns true if the block is being powered by Redstone.
|
||||
*
|
||||
* @return
|
||||
* @return True if the block is powered.
|
||||
*/
|
||||
boolean isBlockPowered();
|
||||
|
||||
/**
|
||||
* Returns true if the block is being indirectly powered by Redstone.
|
||||
*
|
||||
* @return
|
||||
* @return True if the block is indirectly powered.
|
||||
*/
|
||||
boolean isBlockIndirectlyPowered();
|
||||
|
||||
/**
|
||||
* Returns true if the block face is being powered by Redstone.
|
||||
*
|
||||
* @return
|
||||
* @param face The block face
|
||||
* @return True if the block face is powered.
|
||||
*/
|
||||
boolean isBlockFacePowered(BlockFace face);
|
||||
|
||||
/**
|
||||
* Returns true if the block face is being indirectly powered by Redstone.
|
||||
*
|
||||
* @return
|
||||
* @param face The block face
|
||||
* @return True if the block face is indirectly powered.
|
||||
*/
|
||||
boolean isBlockFaceIndirectlyPowered(BlockFace face);
|
||||
|
||||
@@ -228,14 +230,14 @@ public interface Block {
|
||||
* Returns the redstone power being provided to this block face
|
||||
*
|
||||
* @param face the face of the block to query or BlockFace.SELF for the block itself
|
||||
* @return
|
||||
* @return The power level.
|
||||
*/
|
||||
int getBlockPower(BlockFace face);
|
||||
|
||||
/**
|
||||
* Returns the redstone power being provided to this block
|
||||
*
|
||||
* @return
|
||||
* @return The power level.
|
||||
*/
|
||||
int getBlockPower();
|
||||
|
||||
|
||||
@@ -103,6 +103,7 @@ public interface BlockState {
|
||||
* Sets the type-id of this block
|
||||
*
|
||||
* @param type Type-Id to change this block to
|
||||
* @return Whether it worked?
|
||||
*/
|
||||
boolean setTypeId(int type);
|
||||
|
||||
@@ -116,7 +117,7 @@ public interface BlockState {
|
||||
* eventuality.
|
||||
*
|
||||
* @return true if the update was successful, otherwise false
|
||||
* @see BlockState.update(boolean force)
|
||||
* @see #update(boolean)
|
||||
*/
|
||||
boolean update();
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ public interface ContainerBlock {
|
||||
/**
|
||||
* Get the block's inventory.
|
||||
*
|
||||
* @return
|
||||
* @return The inventory.
|
||||
*/
|
||||
public Inventory getInventory();
|
||||
}
|
||||
|
||||
@@ -13,42 +13,42 @@ public interface CreatureSpawner extends BlockState {
|
||||
/**
|
||||
* Get the spawner's creature type.
|
||||
*
|
||||
* @return
|
||||
* @return The creature type.
|
||||
*/
|
||||
public CreatureType getCreatureType();
|
||||
|
||||
/**
|
||||
* Set the spawner creature type.
|
||||
*
|
||||
* @param mobType
|
||||
* @param creatureType The creature type.
|
||||
*/
|
||||
public void setCreatureType(CreatureType creatureType);
|
||||
|
||||
/**
|
||||
* Get the spawner's creature type.
|
||||
*
|
||||
* @return
|
||||
* @return The creature type's name.
|
||||
*/
|
||||
public String getCreatureTypeId();
|
||||
|
||||
/**
|
||||
* Set the spawner mob type.
|
||||
*
|
||||
* @param creatureType
|
||||
* @param creatureType The creature type's name.
|
||||
*/
|
||||
public void setCreatureTypeId(String creatureType);
|
||||
|
||||
/**
|
||||
* Get the spawner's delay.
|
||||
*
|
||||
* @return
|
||||
* @return The delay.
|
||||
*/
|
||||
public int getDelay();
|
||||
|
||||
/**
|
||||
* Set the spawner's delay.
|
||||
*
|
||||
* @param delay
|
||||
* @param delay The delay.
|
||||
*/
|
||||
public void setDelay(int delay);
|
||||
}
|
||||
|
||||
@@ -10,28 +10,28 @@ public interface Furnace extends BlockState, ContainerBlock {
|
||||
/**
|
||||
* Get burn time.
|
||||
*
|
||||
* @return
|
||||
* @return Burn time
|
||||
*/
|
||||
public short getBurnTime();
|
||||
|
||||
/**
|
||||
* Set burn time.
|
||||
*
|
||||
* @param burnTime
|
||||
* @param burnTime Burn time
|
||||
*/
|
||||
public void setBurnTime(short burnTime);
|
||||
|
||||
/**
|
||||
* Get cook time.
|
||||
*
|
||||
* @return
|
||||
* @return Cook time
|
||||
*/
|
||||
public short getCookTime();
|
||||
|
||||
/**
|
||||
* Set cook time.
|
||||
*
|
||||
* @param cookTime
|
||||
* @param cookTime Cook time
|
||||
*/
|
||||
public void setCookTime(short cookTime);
|
||||
}
|
||||
|
||||
@@ -11,28 +11,28 @@ public interface NoteBlock extends BlockState {
|
||||
/**
|
||||
* Gets the note.
|
||||
*
|
||||
* @return
|
||||
* @return The note.
|
||||
*/
|
||||
public Note getNote();
|
||||
|
||||
/**
|
||||
* Gets the note.
|
||||
*
|
||||
* @return
|
||||
* @return The note ID.
|
||||
*/
|
||||
public byte getRawNote();
|
||||
|
||||
/**
|
||||
* Set the note.
|
||||
*
|
||||
* @param note
|
||||
* @param note The note.
|
||||
*/
|
||||
public void setNote(Note note);
|
||||
|
||||
/**
|
||||
* Set the note.
|
||||
*
|
||||
* @param note
|
||||
* @param note The note ID.
|
||||
*/
|
||||
public void setRawNote(byte note);
|
||||
|
||||
@@ -47,15 +47,20 @@ public interface NoteBlock extends BlockState {
|
||||
|
||||
/**
|
||||
* Plays an arbitrary note with an arbitrary instrument
|
||||
*
|
||||
*
|
||||
* @param instrument Instrument ID
|
||||
* @param note Note ID
|
||||
* @return true if successful, otherwise false
|
||||
*/
|
||||
public boolean play(byte instrument, byte note);
|
||||
|
||||
/**
|
||||
* Plays an arbitrary note with an arbitrary instrument
|
||||
*
|
||||
*
|
||||
* @param instrument The instrument
|
||||
* @param note The note
|
||||
* @return true if successful, otherwise false
|
||||
* @see Instrument Note
|
||||
*/
|
||||
public boolean play(Instrument instrument, Note note);
|
||||
}
|
||||
|
||||
@@ -31,7 +31,7 @@ public interface Sign extends BlockState {
|
||||
*
|
||||
* @param index Line number to set the text at, starting from 0
|
||||
* @param line New text to set at the specified index
|
||||
* @throws IndexOutOfBoundsException
|
||||
* @throws IndexOutOfBoundsException If the index is out of the range 0..3
|
||||
*/
|
||||
public void setLine(int index, String line) throws IndexOutOfBoundsException;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user