|
16 | 16 | */ |
17 | 17 | public interface ClaimedChunkEvent { |
18 | 18 | /** |
19 | | - * Fired when a chunk is about to be claimed. This can be cancelled by returning a non-null claim result; it is |
20 | | - * recommended to use {@link ClaimResult#customProblem(String)} for this. |
| 19 | + * Fired when a chunk is about to be claimed. This can be cancelled by returning a failed claim result; it is |
| 20 | + * recommended to use {@link ClaimResult#customProblem(String)} for this. Return {@link ClaimResult#success()} to |
| 21 | + * allow the operation to continue. |
21 | 22 | */ |
22 | 23 | Event<Before> BEFORE_CLAIM = EventFactory.createCompoundEventResult(); |
23 | 24 | /** |
24 | | - * Fired when a chunk is about to be force-loaded. This can be cancelled by returning a non-null claim result; it is |
25 | | - * recommended to use {@link ClaimResult#customProblem(String)} for this. |
| 25 | + * Fired when a chunk is about to be force-loaded. This can be cancelled by returning a failed claim result; it is |
| 26 | + * recommended to use {@link ClaimResult#customProblem(String)} for this. Return {@link ClaimResult#success()} to |
| 27 | + * allow the operation to continue. |
26 | 28 | */ |
27 | 29 | Event<Before> BEFORE_LOAD = EventFactory.createCompoundEventResult(); |
28 | 30 | /** |
29 | | - * Fired when a chunk is about to be un-claimed. This can be cancelled by returning a non-null claim result; it is |
30 | | - * recommended to use {@link ClaimResult#customProblem(String)} for this. |
| 31 | + * Fired when a chunk is about to be unclaimed. This can be cancelled by returning a failed claim result; it is |
| 32 | + * recommended to use {@link ClaimResult#customProblem(String)} for this. Return {@link ClaimResult#success()} to |
| 33 | + * allow the operation to continue. |
31 | 34 | */ |
32 | 35 | Event<Before> BEFORE_UNCLAIM = EventFactory.createCompoundEventResult(); |
33 | 36 | /** |
34 | | - * Fired when a chunk is about to be un-force-loaded. This can be cancelled by returning a non-null claim result; it is |
35 | | - * recommended to use {@link ClaimResult#customProblem(String)} for this. |
| 37 | + * Fired when a chunk is about to be un-force-loaded. This can be cancelled by returning a failed claim result; it is |
| 38 | + * recommended to use {@link ClaimResult#customProblem(String)} for this. Return {@link ClaimResult#success()} to |
| 39 | + * allow the operation to continue. |
36 | 40 | */ |
37 | 41 | Event<Before> BEFORE_UNLOAD = EventFactory.createCompoundEventResult(); |
38 | 42 |
|
|
0 commit comments