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

feat(docs): Improved javadocs documentation

Browse Source
This commit is contained in:
Adrian 2023-12-18 22:09:19 -05:00
parent 44eace9e42
commit 0a385ef6fb
No known key found for this signature in database
GPG Key ID: FB8EF84DCE1BE452
7 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api/paper/src/main/java/io/github/_4drian3d/authmevelocity/api/paper/event/LoginByProxyEvent.java
View File

@ -17,6 +17,7 @@
package io.github._4drian3d.authmevelocity.api.paper.event;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.bukkit.event.player.PlayerEvent;
@ -36,7 +37,7 @@ public final class LoginByProxyEvent extends PlayerEvent {
* @param who the player to be logged in
*/
public LoginByProxyEvent(@NotNull Player who) {
super(who);
super(who, !Bukkit.isPrimaryThread());
}
@Override

4
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/PreSendOnLoginEvent.java
View File

@ -67,6 +67,10 @@ public final class PreSendOnLoginEvent implements ResultedEvent<ServerResult> {
return this.actualServer;
}
/**
* Obtain the result of the event
* @return the event server result
*/
@Override
public @NotNull ServerResult getResult() {
return this.result;

5
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/ProxyForcedUnregisterEvent.java
View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.Nullable;
/**Event executed in case a player is forced unregister by a server operator*/
/**
* Event executed in case a player is forced unregister by a server operator
* @param player the player who has been forced unregister
* */
public record ProxyForcedUnregisterEvent(@Nullable Player player) {}

1
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/ProxyLoginEvent.java
View File

@ -22,5 +22,6 @@ import org.jetbrains.annotations.NotNull;
/**
* Event executed in case the player is successfully logged in
* @param player the player who has logged in
*/
public record ProxyLoginEvent(@NotNull Player player) {}

5
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/ProxyLogoutEvent.java
View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has logout from the network */
/**
* Event executed in case the player has logout from the network
* @param player the player who has logged out
* */
public record ProxyLogoutEvent(@NotNull Player player) {}

5
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/ProxyRegisterEvent.java
View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has register itself*/
/**
* Event executed in case the player has register itself
* @param player the player registered
* */
public record ProxyRegisterEvent(@NotNull Player player) {}

5
api/velocity/src/main/java/io/github/_4drian3d/authmevelocity/api/velocity/event/ProxyUnregisterEvent.java
View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has unregistered itself*/
/**
* Event executed in case the player has unregistered itself
* @param player the player who has unregistered itself
* */
public record ProxyUnregisterEvent(@NotNull Player player) {}