13
0
geforkt von Mirrors/Paper

Update documentation of BlockPhysicsEvent

By: md_5 <git@md-5.net>
Dieser Commit ist enthalten in:
Bukkit/Spigot 2018-08-12 13:05:16 +10:00
Ursprung cb5d8ec4e1
Commit 15d9fd30b9

Datei anzeigen

@ -7,7 +7,23 @@ import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList; import org.bukkit.event.HandlerList;
/** /**
* Thrown when a block physics check is called * Thrown when a block physics check is called.
* <br>
* This event is a high frequency event, it may be called thousands of times per
* a second on a busy server. Plugins are advised to listen to the event with
* caution and only perform lightweight checks when using it.
* <br>
* In addition to this, cancelling the event is liable to leave the world in an
* inconsistent state. For example if you use the event to leave a block
* floating in mid air when that block has a requirement to be attached to
* something, there is no guarantee that the floating block will persist across
* server restarts or map upgrades.
* <br>
* Plugins should also note that where possible this event may only called for
* the "root" block of physics updates in order to limit event spam. Physics
* updates that cause other blocks to change their state may not result in an
* event for each of those blocks (usually adjacent). If you are concerned about
* monitoring these changes then you should check adjacent blocks yourself.
*/ */
public class BlockPhysicsEvent extends BlockEvent implements Cancellable { public class BlockPhysicsEvent extends BlockEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList(); private static final HandlerList handlers = new HandlerList();