mirror of
https://github.com/PaperMC/Paper.git
synced 2025-01-09 11:44:19 +01:00
Pulling all pending Bukkit-JavaDoc changes
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
parent
606b5ba706
commit
a98bf9de33
6 changed files with 16 additions and 7 deletions
|
@ -636,10 +636,14 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||||
public Scoreboard getScoreboard();
|
public Scoreboard getScoreboard();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the player's visible Scoreboard
|
* Sets the player's visible Scoreboard.
|
||||||
* Scoreboard must be currently registered or an IllegalArgumentException is thrown
|
|
||||||
*
|
*
|
||||||
* @param scoreboard New Scoreboard for the player
|
* @param scoreboard New Scoreboard for the player
|
||||||
|
* @throws IllegalArgumentException if scoreboard is null
|
||||||
|
* @throws IllegalArgumentException if scoreboard was not created by the
|
||||||
|
* {@link org.bukkit.scoreboard.ScoreboardManager scoreboard manager}
|
||||||
|
* @throws IllegalStateException if this is a player that is not logged
|
||||||
|
* yet or has logged out
|
||||||
*/
|
*/
|
||||||
public void setScoreboard(Scoreboard scoreboard);
|
public void setScoreboard(Scoreboard scoreboard) throws IllegalArgumentException, IllegalStateException;
|
||||||
}
|
}
|
||||||
|
|
|
@ -65,6 +65,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get cost in exp levels of the enchantment
|
* Get cost in exp levels of the enchantment
|
||||||
|
*
|
||||||
* @return experience level cost
|
* @return experience level cost
|
||||||
*/
|
*/
|
||||||
public int getExpLevelCost() {
|
public int getExpLevelCost() {
|
||||||
|
@ -73,6 +74,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set cost in exp levels of the enchantment
|
* Set cost in exp levels of the enchantment
|
||||||
|
*
|
||||||
* @param level - cost in levels
|
* @param level - cost in levels
|
||||||
*/
|
*/
|
||||||
public void setExpLevelCost(int level) {
|
public void setExpLevelCost(int level) {
|
||||||
|
@ -91,6 +93,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Which button was pressed to initiate the enchanting.
|
* Which button was pressed to initiate the enchanting.
|
||||||
|
*
|
||||||
* @return The button index (0, 1, or 2).
|
* @return The button index (0, 1, or 2).
|
||||||
*/
|
*/
|
||||||
public int whichButton() {
|
public int whichButton() {
|
||||||
|
|
|
@ -59,6 +59,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get list of offered exp level costs of the enchantment (modify values to change offer)
|
* Get list of offered exp level costs of the enchantment (modify values to change offer)
|
||||||
|
*
|
||||||
* @return experience level costs offered
|
* @return experience level costs offered
|
||||||
*/
|
*/
|
||||||
public int[] getExpLevelCostsOffered() {
|
public int[] getExpLevelCostsOffered() {
|
||||||
|
@ -67,6 +68,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get enchantment bonus in effect - corresponds to number of bookshelves
|
* Get enchantment bonus in effect - corresponds to number of bookshelves
|
||||||
|
*
|
||||||
* @return enchantment bonus
|
* @return enchantment bonus
|
||||||
*/
|
*/
|
||||||
public int getEnchantmentBonus() {
|
public int getEnchantmentBonus() {
|
||||||
|
|
|
@ -177,7 +177,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
|
||||||
*/
|
*/
|
||||||
MAGIC,
|
MAGIC,
|
||||||
/**
|
/**
|
||||||
*
|
* Damage caused by Wither potion effect
|
||||||
*/
|
*/
|
||||||
WITHER,
|
WITHER,
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -21,7 +21,7 @@ public class PlayerPickupItemEvent extends PlayerEvent implements Cancellable {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the ItemDrop created by the player
|
* Gets the Item picked up by the player.
|
||||||
*
|
*
|
||||||
* @return Item
|
* @return Item
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -44,11 +44,11 @@ public class PotionEffect implements ConfigurationSerializable {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a potion affect. Assumes ambient is true.
|
* Creates a potion effect. Assumes ambient is true.
|
||||||
*
|
*
|
||||||
* @param type Effect type
|
* @param type Effect type
|
||||||
* @param duration measured in ticks
|
* @param duration measured in ticks
|
||||||
* @param amplifier the amplifier for the affect
|
* @param amplifier the amplifier for the effect
|
||||||
* @see PotionEffect#PotionEffect(PotionEffectType, int, int, boolean)
|
* @see PotionEffect#PotionEffect(PotionEffectType, int, int, boolean)
|
||||||
*/
|
*/
|
||||||
public PotionEffect(PotionEffectType type, int duration, int amplifier) {
|
public PotionEffect(PotionEffectType type, int duration, int amplifier) {
|
||||||
|
|
Loading…
Reference in a new issue