twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-15 04:05:50 -07:00
Code Issues Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-02-22 22:49:38 -06:00
parent c23f9be8d3
commit 78abaa5f6d
46 changed files with 292 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
paper-api/src/main/java/org/bukkit/Server.java
View File

@@ -652,7 +652,7 @@ public interface Server extends PluginMessageRecipient {
/**
* Gets user-specified limit for number of ambient mobs that can spawn in a chunk
* @returns The ambient spawn limit
* @return The ambient spawn limit
*/
int getAmbientSpawnLimit();

9
paper-api/src/main/java/org/bukkit/World.java
View File

@@ -671,10 +671,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
* Spawn a {@link FallingBlock} entity at the given {@link Location} of the specified blockId (converted to {@link Material})
*
* @param location The {@link Location} to spawn the FallingBlock
* @param blockId see {@see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)} material
* @param blockId The id of the intended material
* @param blockData The block data
* @return The spawned FallingBlock instance
* @throws IllegalArgumentException see {@see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)}
* @throws IllegalArgumentException if location is null, or blockId is invalid
* @see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)
*/
public FallingBlock spawnFallingBlock(Location location, int blockId, byte blockData) throws IllegalArgumentException;
@@ -999,7 +1000,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
/**
* Gets the limit for number of ambient mobs that can spawn in a chunk in this world
* @returns The ambient spawn limit
* @return The ambient spawn limit
*/
int getAmbientSpawnLimit();
@@ -1021,7 +1022,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
* @param volume The volume of the sound
* @param pitch The pitch of the sound
*/
void playSound(Location loc, Sound sound, float volume, float pitch);
void playSound(Location location, Sound sound, float volume, float pitch);
/**
* Get existing rules

2
paper-api/src/main/java/org/bukkit/block/Skull.java
View File

@@ -24,7 +24,7 @@ public interface Skull extends BlockState {
/**
* Sets the owner of the skull
*
* @param owner the new owner of the skull
* @param name the new owner of the skull
* @return true if the owner was successfully set
*/
public boolean setOwner(String name);

4
paper-api/src/main/java/org/bukkit/configuration/ConfigurationSection.java
View File

@@ -297,7 +297,7 @@ public interface ConfigurationSection {
* <p />
* If the double does not exist but a default value has been specified, this
* will return the default value. If the double does not exist and no default
* value was specified, this will return null.
* value was specified, this will return 0.
*
* @param path Path of the double to get.
* @return Requested double.
@@ -334,7 +334,7 @@ public interface ConfigurationSection {
* <p />
* If the long does not exist but a default value has been specified, this
* will return the default value. If the long does not exist and no default
* value was specified, this will return null.
* value was specified, this will return 0.
*
* @param path Path of the long to get.
* @return Requested long.

4
paper-api/src/main/java/org/bukkit/conversations/FixedSetPrompt.java
View File

@@ -31,8 +31,8 @@ public abstract class FixedSetPrompt extends ValidatingPrompt {
/**
* Utility function to create a formatted string containing all the options declared in the constructor.
* The result is formatted like "[bar, cheese, panda]"
* @return
*
* @return the options formatted like "[bar, cheese, panda]" if bar, cheese, and panda were the options used
*/
protected String formatFixedSet() {
return "[" + StringUtils.join(fixedSet, ", ") + "]";

2
paper-api/src/main/java/org/bukkit/event/Event.java
View File

@@ -17,6 +17,7 @@ public abstract class Event {
/**
* This constructor is used to explicitly declare an event as synchronous or asynchronous.
*
* @param isAsync true indicates the event will fire asynchronously. false by default
*/
public Event(boolean isAsync) {
@@ -47,6 +48,7 @@ public abstract class Event {
* <li>Some implementations may selectively declare a specific event use as asynchronous.
* This behavior should be clearly defined.</li>
* <li>Asynchronous calls are not calculated in the plugin timing system.</li>
*
* @return false by default, true if the event fires asynchronously
*/
public final boolean isAsynchronous() {

7
paper-api/src/main/java/org/bukkit/scheduler/BukkitRunnable.java
View File

@@ -42,7 +42,7 @@ public abstract class BukkitRunnable implements Runnable {
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
* @see BukkitScheduler#runTaskAsynchronously(Plugin, Runnable, long, long)
* @see BukkitScheduler#runTaskAsynchronously(Plugin, Runnable)
*/
public synchronized BukkitTask runTaskAsynchronously(Plugin plugin) throws IllegalArgumentException, IllegalStateException {
checkState();
@@ -53,12 +53,11 @@ public abstract class BukkitRunnable implements Runnable {
* Schedules this to run after the specified number of server ticks.
*
* @param plugin the reference to the plugin scheduling task
* @param task the task to be run
* @param delay the ticks to wait before running the task
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
* @see BukkitScheduler#runTaskLater(Plugin, Runnable, long, long)
* @see BukkitScheduler#runTaskLater(Plugin, Runnable, long)
*/
public synchronized BukkitTask runTaskLater(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException {
checkState();
@@ -76,7 +75,7 @@ public abstract class BukkitRunnable implements Runnable {
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
* @see BukkitScheduler#runTaskLaterAsynchronously(Plugin, Runnable, long, long)
* @see BukkitScheduler#runTaskLaterAsynchronously(Plugin, Runnable, long)
*/
public synchronized BukkitTask runTaskLaterAsynchronously(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException {
checkState();