From 87f74eaeda442162e957bc071f09243cb21f8614 Mon Sep 17 00:00:00 2001 From: Ecconia <18501527+Ecconia@users.noreply.github.com> Date: Mon, 22 Sep 2025 21:34:06 +0200 Subject: [PATCH] [ci skip] Improve documentation for priority parameter in EventManager (#1619) * Improve documentation for priority parameter in EventManager PostOrder was deprecated in commit (4f227badc20dc30b0f6d84b5349c8809481dcbb1) in favor of priorities. PostOrder itself was very descriptive on which PostOrder is processed first. A number cannot be descriptive about that - it is never clear if higher or lower numbers are processed first. The Subscribe event attribute does contain a description on how priorities are evaluated. The EventManager did not, which literally did confused developers manually registering events. This commit fixes this by describing the priority argument in EventManager with the same description that Subscribe uses. * Fixed checkstyle --------- Co-authored-by: Adrian Gonzales --- .../main/java/com/velocitypowered/api/event/EventManager.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/api/src/main/java/com/velocitypowered/api/event/EventManager.java b/api/src/main/java/com/velocitypowered/api/event/EventManager.java index b8702ab3..ed11986c 100644 --- a/api/src/main/java/com/velocitypowered/api/event/EventManager.java +++ b/api/src/main/java/com/velocitypowered/api/event/EventManager.java @@ -60,7 +60,8 @@ public interface EventManager { * * @param plugin the plugin to associate with the handler * @param eventClass the class for the event handler to register - * @param postOrder the relative order in which events should be posted to the handler + * @param postOrder the relative order in which events should be posted to the handler. The higher + * the priority, the earlier the event handler will be called * @param handler the handler to register * @param the event type to handle */