Pulling all pending Bukkit-JavaDoc changes

A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions

View File

@@ -8,8 +8,11 @@ package org.bukkit;
public interface BlockChangeDelegate {
/**
* Set a block type at the specified coordinates without doing all world updates and notifications.
* It is safe to have this call World.setTypeId, but it may be slower than World.setRawTypeId.
* Set a block type at the specified coordinates without doing all world
* updates and notifications.
* <p>
* It is safe to have this call World.setTypeId, but it may be slower than
* World.setRawTypeId.
*
* @param x X coordinate
* @param y Y coordinate
@@ -22,8 +25,11 @@ public interface BlockChangeDelegate {
public boolean setRawTypeId(int x, int y, int z, int typeId);
/**
* Set a block type and data at the specified coordinates without doing all world updates and notifications.
* It is safe to have this call World.setTypeId, but it may be slower than World.setRawTypeId.
* Set a block type and data at the specified coordinates without doing
* all world updates and notifications.
* <p>
* It is safe to have this call World.setTypeId, but it may be slower than
* World.setRawTypeId.
*
* @param x X coordinate
* @param y Y coordinate
@@ -38,6 +44,7 @@ public interface BlockChangeDelegate {
/**
* Set a block type at the specified coordinates.
* <p>
* This method cannot call World.setRawTypeId, a full update is needed.
*
* @param x X coordinate
@@ -52,6 +59,7 @@ public interface BlockChangeDelegate {
/**
* Set a block type and data at the specified coordinates.
* <p>
* This method cannot call World.setRawTypeId, a full update is needed.
*
* @param x X coordinate