Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@@ -102,7 +102,7 @@ public class PlayerEggThrowEvent extends PlayerEvent {
|
||||
/**
|
||||
* Get the number of mob hatches from the egg. By default the number
|
||||
* will be he number the server would've done
|
||||
* <p />
|
||||
* <p>
|
||||
* 7/8 chance of being 0
|
||||
* 31/256 ~= 1/8 chance to be 1
|
||||
* 1/256 chance to be 4
|
||||
@@ -115,7 +115,7 @@ public class PlayerEggThrowEvent extends PlayerEvent {
|
||||
|
||||
/**
|
||||
* Change the number of mobs coming out of the hatched egg
|
||||
* <p />
|
||||
* <p>
|
||||
* The boolean hatching will override this number.
|
||||
* Ie. If hatching = false, this number will not matter
|
||||
*
|
||||
|
||||
@@ -63,7 +63,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
|
||||
|
||||
/**
|
||||
* Gets the amount of experience received when fishing.
|
||||
* <p />
|
||||
* <p>
|
||||
* Note: This value has no default effect unless the event state is {@link State#CAUGHT_FISH}.
|
||||
*
|
||||
* @return the amount of experience to drop
|
||||
@@ -74,7 +74,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
|
||||
|
||||
/**
|
||||
* Sets the amount of experience received when fishing.
|
||||
* <p />
|
||||
* <p>
|
||||
* Note: This value has no default effect unless the event state is {@link State#CAUGHT_FISH}.
|
||||
*
|
||||
* @param amount the amount of experience to drop
|
||||
|
||||
@@ -54,7 +54,7 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
/**
|
||||
* Sets the cancellation state of this event. A canceled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
* <p />
|
||||
* <p>
|
||||
* Canceling this event will prevent use of food (player won't lose the
|
||||
* food item), prevent bows/snowballs/eggs from firing, etc. (player won't
|
||||
* lose the ammo)
|
||||
|
||||
@@ -23,7 +23,7 @@ public class PlayerMoveEvent extends PlayerEvent implements Cancellable {
|
||||
/**
|
||||
* Gets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
* <p />
|
||||
* <p>
|
||||
* If a move or teleport event is cancelled, the player will be moved or
|
||||
* teleported back to the Location as defined by getFrom(). This will not
|
||||
* fire an event
|
||||
@@ -37,7 +37,7 @@ public class PlayerMoveEvent extends PlayerEvent implements Cancellable {
|
||||
/**
|
||||
* Sets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
* <p />
|
||||
* <p>
|
||||
* If a move or teleport event is cancelled, the player will be moved or
|
||||
* teleported back to the Location as defined by getFrom(). This will not
|
||||
* fire an event
|
||||
|
||||
Reference in New Issue
Block a user