Skip to content

Commit 0b2bc4d

Browse files
committed
Support priorities for event listeners
1 parent 497fb74 commit 0b2bc4d

File tree

3 files changed

+94
-1
lines changed

3 files changed

+94
-1
lines changed

src/api/java/baritone/api/event/listener/IEventBus.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
* A type of {@link IGameEventListener} that can have additional listeners
2222
* registered so that they receive the events that are dispatched to this
2323
* listener.
24+
* <p>
25+
* Listeners with higher priority will be called first.
2426
*
2527
* @author Brady
2628
* @since 11/14/2018
@@ -29,8 +31,17 @@ public interface IEventBus extends IGameEventListener {
2931

3032
/**
3133
* Registers the specified {@link IGameEventListener} to this event bus
34+
* using a default priority {@code 0}
3235
*
3336
* @param listener The listener
3437
*/
3538
void registerEventListener(IGameEventListener listener);
39+
40+
/**
41+
* Registers the specified {@link IGameEventListener} to this event bus.
42+
*
43+
* @param priority The listener priority
44+
* @param listener The listener
45+
*/
46+
void registerEventListener(int priority, IGameEventListener listener);
3647
}

src/main/java/baritone/event/GameEventHandler.java

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
import baritone.cache.CachedChunk;
2828
import baritone.cache.WorldProvider;
2929
import baritone.utils.BlockStateInterface;
30+
import it.unimi.dsi.fastutil.ints.IntList;
31+
import it.unimi.dsi.fastutil.ints.IntArrayList;
3032
import net.minecraft.world.level.ChunkPos;
3133
import net.minecraft.world.level.Level;
3234
import net.minecraft.world.level.block.state.BlockState;
@@ -43,7 +45,9 @@ public final class GameEventHandler implements IEventBus, Helper {
4345

4446
private final Baritone baritone;
4547

48+
// reading/iterating `listeners` is allowed without synchronization
4649
private final List<IGameEventListener> listeners = new CopyOnWriteArrayList<>();
50+
private final IntList priorities = new IntArrayList();
4751

4852
public GameEventHandler(Baritone baritone) {
4953
this.baritone = baritone;
@@ -184,6 +188,16 @@ public void onPathEvent(PathEvent event) {
184188

185189
@Override
186190
public final void registerEventListener(IGameEventListener listener) {
187-
this.listeners.add(listener);
191+
this.registerEventListener(0, listener);
192+
}
193+
194+
@Override
195+
public final synchronized void registerEventListener(int priority, IGameEventListener listener) {
196+
int i = 0;
197+
while (i < this.listeners.size() && priority <= this.priorities.getInt(i)) {
198+
++i;
199+
}
200+
this.listeners.add(i, listener);
201+
this.priorities.add(i, priority);
188202
}
189203
}
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
* This file is part of Baritone.
3+
*
4+
* Baritone is free software: you can redistribute it and/or modify
5+
* it under the terms of the GNU Lesser General Public License as published by
6+
* the Free Software Foundation, either version 3 of the License, or
7+
* (at your option) any later version.
8+
*
9+
* Baritone is distributed in the hope that it will be useful,
10+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
* GNU Lesser General Public License for more details.
13+
*
14+
* You should have received a copy of the GNU Lesser General Public License
15+
* along with Baritone. If not, see <https://www.gnu.org/licenses/>.
16+
*/
17+
18+
package baritone.event;
19+
20+
import baritone.api.event.listener.AbstractGameEventListener;
21+
import org.junit.Test;
22+
23+
import java.util.ArrayList;
24+
import java.util.Arrays;
25+
import java.util.List;
26+
27+
import static org.junit.Assert.assertEquals;
28+
29+
public class GameEventHandlerTest {
30+
31+
@Test
32+
public void testListenerOrder() {
33+
GameEventHandler bus = new GameEventHandler(null /* baritone */);
34+
35+
List<String> output = new ArrayList<>();
36+
37+
bus.registerEventListener(0, new TestEventListener("0 0", output));
38+
bus.registerEventListener(0, new TestEventListener("0 1", output));
39+
bus.registerEventListener(1, new TestEventListener("1 2", output));
40+
bus.registerEventListener(new TestEventListener("_ 3", output));
41+
bus.registerEventListener(-1, new TestEventListener("-1 4", output));
42+
bus.registerEventListener(1, new TestEventListener("1 5", output));
43+
bus.registerEventListener(0, new TestEventListener("0 6", output));
44+
45+
bus.onPlayerDeath();
46+
47+
assertEquals(new ArrayList<>(Arrays.asList(
48+
"1 2", "1 5", "0 0", "0 1", "_ 3", "0 6", "-1 4"
49+
)),
50+
output
51+
);
52+
}
53+
54+
private static class TestEventListener implements AbstractGameEventListener {
55+
private final String id;
56+
private final List<String> output;
57+
58+
public TestEventListener(String id, List<String> output) {
59+
this.id = id;
60+
this.output = output;
61+
}
62+
63+
@Override
64+
public void onPlayerDeath() { // the only event without an argument ☺
65+
output.add(id);
66+
}
67+
}
68+
}

0 commit comments

Comments
 (0)