RedGuy/AuthMeVelocity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(docs): Improved PreSendOnLoginEvent documentation

Browse Source 
Implement AwaitingEvent annotation
This commit is contained in:
4drian3d 2022-08-15 01:09:42 +00:00
parent 98831c4ae3
commit bc54dd591f
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api/velocity/src/main/java/me/adrianed/authmevelocity/api/velocity/event/PreSendOnLoginEvent.java
View File

@ -3,6 +3,7 @@ package me.adrianed.authmevelocity.api.velocity.event;
import java.util.Objects;
import com.velocitypowered.api.event.ResultedEvent;
import com.velocitypowered.api.event.annotation.AwaitingEvent;
import com.velocitypowered.api.proxy.Player;
import com.velocitypowered.api.proxy.server.RegisteredServer;
@ -10,8 +11,12 @@ import org.jetbrains.annotations.NotNull;
/**
* Event to be executed just before sending a player to another server after login/registration.
* Here you have the ability to deny the event.
*
* <p>AuthMeVelocity will wait for the execution of this event to perform the given action,
* which means that you can modify the server to which the player will connect
* or if the player should not be sent to any server after being logged in</p>
*/
@AwaitingEvent
public final class PreSendOnLoginEvent implements ResultedEvent<ServerResult> {
private ServerResult result;
private final Player player;
@ -45,18 +50,11 @@ public final class PreSendOnLoginEvent implements ResultedEvent<ServerResult> {
return this.actualserver;
}
/**
* Get the result of the event
*/
@Override
public @NotNull ServerResult getResult() {
return this.result;
}
/**
* Set the result of the event
* @param newResult the new result
*/
@Override
public void setResult(@NotNull ServerResult newResult) {
this.result = Objects.requireNonNull(newResult);