EventHandler.java 2.39 KB
Newer Older
KingRainbow44's avatar
KingRainbow44 committed
1
2
package emu.grasscutter.server.event;

3
import emu.grasscutter.Grasscutter;
4
import emu.grasscutter.utils.EventConsumer;
5

KingRainbow44's avatar
KingRainbow44 committed
6
public final class EventHandler {
KingRainbow44's avatar
KingRainbow44 committed
7
8
9
10
11
12
13
14
15
16
    private final Class<? extends Event> event;

    /**
     * Creates an instance of {@link EventHandler} for the specified event.
     * @param event The event to handle.
     * @return An instance of {@link EventHandler}.
     */
    public static EventHandler forEvent(Class<? extends Event> event) {
        return new EventHandler(event);
    }
KingRainbow44's avatar
KingRainbow44 committed
17
    
18
    private EventHandler(Class<? extends Event> event) {
KingRainbow44's avatar
KingRainbow44 committed
19
20
        this.event = event;
    }
21
    
22
    private EventConsumer listener;
23
24
25
26
27
28
29
    private HandlerPriority priority;
    private boolean handleCanceled;

    /**
     * Gets which event this handler is handling.
     * @return An event class.
     */
KingRainbow44's avatar
KingRainbow44 committed
30
    public Class<? extends Event> handles() {
31
32
33
34
35
36
37
        return this.event;
    }

    /**
     * Returns the callback for the handler.
     * @return A consumer callback.
     */
38
    public EventConsumer getCallback() {
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
        return this.listener;
    }

    /**
     * Returns the handler's priority.
     * @return The priority of the handler.
     */
    public HandlerPriority getPriority() {
        return this.priority;
    }

    /**
     * Returns if the handler will ignore cancelled events.
     * @return The ignore cancelled state.
     */
    public boolean ignoresCanceled() {
        return this.handleCanceled;
    }

    /**
     * Sets the callback method for when the event is invoked.
     * @param listener An event handler method.
     * @return Method chaining.
     */
63
    public EventHandler listener(EventConsumer listener) {
64
65
66
67
68
69
70
71
        this.listener = listener; return this;
    }

    /**
     * Changes the handler's priority in handling events.
     * @param priority The priority of the handler.
     * @return Method chaining.
     */
KingRainbow44's avatar
KingRainbow44 committed
72
    public EventHandler priority(HandlerPriority priority) {
73
74
75
76
77
78
79
80
        this.priority = priority; return this;
    }

    /**
     * Sets if the handler will ignore cancelled events.
     * @param ignore If the handler should ignore cancelled events.
     * @return Method chaining.
     */
KingRainbow44's avatar
KingRainbow44 committed
81
    public EventHandler ignore(boolean ignore) {
82
83
84
85
86
87
88
89
90
        this.handleCanceled = ignore; return this;
    }

    /**
     * Registers the handler into the PluginManager.
     */
    public void register() {
        Grasscutter.getPluginManager().registerListener(this);
    }
KingRainbow44's avatar
KingRainbow44 committed
91
}