From 16f01fecc08ceba1ab0e3635603c199a662eb983 Mon Sep 17 00:00:00 2001
From: sylvessa <225480449+sylvessa@users.noreply.github.com>
Date: Sun, 29 Mar 2026 13:05:06 -0500
Subject: [PATCH] update docs to add playerpreloginevent

---
 .../docs/usage-of-all-events.md               | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/Minecraft.Server.FourKit/docs/usage-of-all-events.md b/Minecraft.Server.FourKit/docs/usage-of-all-events.md
index 913ae8ff5..a3f7394b6 100644
--- a/Minecraft.Server.FourKit/docs/usage-of-all-events.md
+++ b/Minecraft.Server.FourKit/docs/usage-of-all-events.md
@@ -10,6 +10,37 @@ Events that implement \ref Minecraft.Server.FourKit.Event.Cancellable "Cancellab
 
 @section player_events Player Events
 
+@subsection playerpreloginevent PlayerPreLoginEvent
+
+\ref Minecraft.Server.FourKit.Event.Player.PlayerPreLoginEvent "PlayerPreLoginEvent" is fired before a player is allowed to join the server. You can inspect the players name and IP address, and cancel the event to prevent them from joining (such as for bans, whitelists, etc).
+
+```csharp
+[EventHandler]
+public void onPreLogin(PlayerPreLoginEvent e)
+{
+    // block by name
+    if (e.getName() == "Dumb")
+    {
+        e.setCancelled(true);
+    }
+
+    // block by ip
+    if (e.getAddress().getHostAddress() == "127.0.0.1")
+    {
+        e.setCancelled(true);
+    }
+}
+```
+
+| Method | Description |
+|--------|-------------|
+| `getName()` | The player's username attempting to join. |
+| `getAddress()` | The \ref Minecraft.Server.FourKit.Net.InetSocketAddress "InetSocketAddress" of the connection. |
+| `isCancelled()` | Whether the login is cancelled. |
+| `setCancelled(bool)` | Cancel or allow the login. |
+
+> **Cancellable:** Yes
+
 @subsection playerjoinevent PlayerJoinEvent
 
 \ref Minecraft.Server.FourKit.Event.Player.PlayerJoinEvent "PlayerJoinEvent" is fired when a player joins the server. You can read or change the join message that is broadcast to all online players.