Better document how to use the login plugin message API

This commit is contained in:
Andrew Steinborn
2021-12-23 15:44:19 -05:00
parent 8c39d9a1e4
commit 058014aa75

View File

@@ -21,6 +21,12 @@ import org.checkerframework.checker.nullness.qual.Nullable;
* (for offline mode). Velocity will wait for this event to finish firing before proceeding further * (for offline mode). Velocity will wait for this event to finish firing before proceeding further
* with the login process, but you should try to limit the work done in any event that fires during * with the login process, but you should try to limit the work done in any event that fires during
* the login process. * the login process.
*
* <p>
* As of Velocity 3.1.0, you may cast the {@link InboundConnection} to a
* {@link com.velocitypowered.api.proxy.LoginPhaseConnection} to allow a
* proxy plugin to send login plugin messages to the client.
* </p>
*/ */
@AwaitingEvent @AwaitingEvent
public final class PreLoginEvent implements ResultedEvent<PreLoginEvent.PreLoginComponentResult> { public final class PreLoginEvent implements ResultedEvent<PreLoginEvent.PreLoginComponentResult> {