[SPIGOT-2323] Event Handler JD for ignoreCancled describes logic backwards for boolean value Created: 27/May/16  Updated: 11/Dec/17  Resolved: 27/May/16

Status: Closed
Project: Spigot
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Minor
Reporter: Sycholic Assignee: Unassigned
Resolution: Cannot Reproduce Votes: 0
Labels: EventHandler, Javadocs, ignoreCancelled


 Description   

public abstract boolean ignoreCancelled
Define if the handler ignores a cancelled event.
If ignoreCancelled is true and the event is cancelled, the method is not called. Otherwise, the method is always called.

If you are ignoring the cancel then true would mean it ignores it, not allow it to be cancelled still.
Minor issue just in the JD not worth putting in a PR for something this trivial

 Comments   
Comment by Black Hole [ 28/May/16 ]

I think you don't undersstand the event concept of calling multiple event handles in order. Some of these events could cancel a cancellable event or the event even could be cancelled before calling the first event handler.

Have a look at http://wiki.bukkit.org/Event_API_Reference

Comment by Sycholic [ 28/May/16 ]

then I guess "the method is not called" means it is not being cancelled even though it flat out says your event method is not called...

Comment by Black Hole [ 27/May/16 ]

The JavaDoc is specifying the behaviour correctly:

Setting "ignoreCancelled" to true means your event handler is ignoring cancelled events.

Generated at Fri Apr 11 15:30:00 UTC 2025 using Jira 10.3.3#10030003-sha1:d220e3fefc8dfc6d47f522d3b9a20c1455e12b7b.