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-08-03 21:46:30 -04:00
parent b9642786eb
commit 599ec05858
80 changed files with 259 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
paper-api/src/main/java/org/bukkit/util/BlockIterator.java
View File

@@ -14,7 +14,6 @@ import java.util.NoSuchElementException;
/**
* This class performs ray tracing and iterates along blocks on a line
*/
public class BlockIterator implements Iterator<Block> {
private final World world;
@@ -49,7 +48,6 @@ public class BlockIterator implements Iterator<Block> {
* @param maxDistance This is the maximum distance in blocks for the trace. Setting this value above 140 may lead to problems with unloaded chunks. A value of 0 indicates no limit
*
*/
public BlockIterator(World world, Vector start, Vector direction, double yOffset, int maxDistance) {
this.world = world;
this.maxDistance = maxDistance;
@@ -224,9 +222,7 @@ public class BlockIterator implements Iterator<Block> {
* @param loc The location for the start of the ray trace
* @param yOffset The trace begins vertically offset from the start vector by this value
* @param maxDistance This is the maximum distance in blocks for the trace. Setting this value above 140 may lead to problems with unloaded chunks. A value of 0 indicates no limit
*
*/
public BlockIterator(Location loc, double yOffset, int maxDistance) {
this(loc.getWorld(), loc.toVector(), loc.getDirection(), yOffset, maxDistance);
}
@@ -257,7 +253,6 @@ public class BlockIterator implements Iterator<Block> {
*
* @param entity Information from the entity is used to set up the trace
* @param maxDistance This is the maximum distance in blocks for the trace. Setting this value above 140 may lead to problems with unloaded chunks. A value of 0 indicates no limit
*
*/
public BlockIterator(LivingEntity entity, int maxDistance) {

3
paper-api/src/main/java/org/bukkit/util/ChatPaginator.java
View File

@@ -19,6 +19,7 @@ public class ChatPaginator {
/**
* Breaks a raw string up into pages using the default width and height.
*
* @param unpaginatedString The raw string to break.
* @param pageNumber The page number to fetch.
* @return A single chat page.
@@ -29,6 +30,7 @@ public class ChatPaginator {
/**
* Breaks a raw string up into pages using a provided width and height.
*
* @param unpaginatedString The raw string to break.
* @param pageNumber The page number to fetch.
* @param lineLength The desired width of a chat line.
@@ -51,6 +53,7 @@ public class ChatPaginator {
/**
* Breaks a raw string up into a series of lines. Words are wrapped using spaces as decimeters and the newline
* character is respected.
*
* @param rawString The raw string to break.
* @param lineLength The length of a line of text.
* @return An array of word-wrapped lines.