Skip to content

Commit 4643c20

Browse files
committed
ASdded missing javadocs
1 parent 1dcc597 commit 4643c20

1 file changed

Lines changed: 39 additions & 1 deletion

File tree

Utility Library/src/main/java/org/broken/arrow/utility/library/listner/UtilityListener.java

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,29 @@
1717

1818
import javax.annotation.Nonnull;
1919

20+
/**
21+
* Central listener that delegates events to module-specific bukkit events.
22+
*/
2023
public class UtilityListener implements Listener {
2124
private final ChunkRelevanceTrackerWrapper chunkRelevanceTracker;
2225
private final PlayerChunkTracker playerChunkTracker;
2326

27+
28+
/**
29+
* Creates a new listener instance.
30+
*
31+
* @param chunkRelevanceTracker main chunk relevance handler
32+
*/
2433
public UtilityListener(@Nonnull final ChunkRelevanceTrackerWrapper chunkRelevanceTracker) {
2534
this.chunkRelevanceTracker = chunkRelevanceTracker;
2635
this.playerChunkTracker = chunkRelevanceTracker.getPlayerChunkTracker();
2736
}
2837

29-
38+
/**
39+
* Event called when chunk unloading.
40+
*
41+
* @param event the unload event.
42+
*/
3043
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
3144
public void chunkUnLoad(final ChunkUnloadEvent event) {
3245
final Chunk chunk = event.getChunk();
@@ -35,6 +48,11 @@ public void chunkUnLoad(final ChunkUnloadEvent event) {
3548
});
3649
}
3750

51+
/**
52+
* Handles chunk load events.
53+
*
54+
* @param event the load event.
55+
*/
3856
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
3957
public void chunkLoad(final ChunkLoadEvent event) {
4058
final Chunk chunk = event.getChunk();
@@ -44,11 +62,21 @@ public void chunkLoad(final ChunkLoadEvent event) {
4462
});
4563
}
4664

65+
/**
66+
* Event called when player join server.
67+
*
68+
* @param e the load event.
69+
*/
4770
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
4871
public void onJoin(final PlayerJoinEvent e) {
4972
this.playerChunkTracker.trackPlayer(e.getPlayer());
5073
}
5174

75+
/**
76+
* Updates player chunk on movement.
77+
*
78+
* @param e the player move event.
79+
*/
5280
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
5381
public void onMove(final PlayerMoveEvent e) {
5482
this.playerChunkTracker.onPlayerChunkChange(
@@ -57,11 +85,21 @@ public void onMove(final PlayerMoveEvent e) {
5785
);
5886
}
5987

88+
/**
89+
* Untracks player on quit.
90+
*
91+
* @param e the player move event.
92+
*/
6093
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
6194
public void onQuit(final PlayerQuitEvent e) {
6295
this.playerChunkTracker.untrackPlayer(e.getPlayer());
6396
}
6497

98+
/**
99+
* Updates player chunk on teleport.
100+
*
101+
* @param e the player teleport.
102+
*/
65103
@EventHandler(ignoreCancelled = false, priority = EventPriority.HIGH)
66104
public void onTeleport(final PlayerTeleportEvent e) {
67105
this.playerChunkTracker.onPlayerChunkChange(

0 commit comments

Comments
 (0)