SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
paper-api/src/main/java/org/bukkit/block/BlockState.java
View File

@ -9,7 +9,7 @@ import org.bukkit.metadata.Metadatable;
/**
* Represents a captured state of a block, which will not change automatically.
* <p />
* <p>
* Unlike Block, which only one object can exist per coordinate, BlockState can
* exist multiple times for any given Block. Note that another plugin may change
* the state of the block and you will not know, or they may change the block to
@ -127,7 +127,7 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* This has the same effect as calling update(false). That is to say,
* this will not modify the state of a block if it is no longer the same
* type as it was when this state was taken. It will return false in this
@ -141,7 +141,7 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* This has the same effect as calling update(force, true). That is to say,
* this will trigger a physics update to surrounding blocks.
*
@ -153,14 +153,14 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* Unless force is true, this will not modify the state of a block if it is
* no longer the same type as it was when this state was taken. It will return
* false in this eventuality.
* <p />
* <p>
* If force is true, it will set the type of the block to match the new state,
* set the state data and then return true.
* <p />
* <p>
* If applyPhysics is true, it will trigger a physics update on surrounding
* blocks which could cause them to update or disappear.
*