Merge remote-tracking branch 'origin/v3' into v3

README.md

@@ -75,6 +75,7 @@ You are able to listen after the following events, which directly map to the eve
 | Join              | `join`                     | A player joined the server                 |
 | Leave             | `leave`                    | A player left the server                   |
 | Death             | `death`                    | A player died                              |
+| World change      | `world_change`             | A player changed worlds                    |
 | AFK               | `afk`                      | A player went AFK                          |
 | AFK return        | `afk_return`               | A player returned from being AFK           |
 | Restart scheduled | `server_restart_scheduled` | The server will restart soon               |
@@ -167,6 +168,17 @@ The event received when a player dies in-game.
 - user - `User` that died
 - source - `User` | `null` that killed the user. Only set if they were killed by another player
 
+### World change
+
+([Websocket API docs](https://docs.sc3.io/chatbox/websocket.html#world-change-event) –
+[API reference](https://docs.sc3.io/library/switchchat/interfaces/WorldChange.html))
+
+The event received when a player changes worlds.
+
+- user - `User` that changed worlds
+- origin - `string` of the world the player moved from
+- destination - `string` of the world the player is now in
+
 ### AFK
 
 ([Websocket API docs](https://docs.sc3.io/chatbox/websocket.html#afk-event) –

src/Client.ts

@@ -5,8 +5,8 @@ import WebSocket from "ws";
 import {Capability, FormattingMode, User} from "./types";
 import {Data, Hello, Players, Success, RequestError, Closing} from "./packets";
 import {
-    ChatboxChatMessage, ChatboxCommand, DiscordChatMessage, IngameChatMessage, Leave, Join, Death, AFKReturn, AFK,
-    ServerRestartCancelled, ServerRestartScheduled, BaseEvent
+    ChatboxChatMessage, ChatboxCommand, DiscordChatMessage, IngameChatMessage, Leave, Join, Death, WorldChange,
+    AFKReturn, AFK, ServerRestartCancelled, ServerRestartScheduled, BaseEvent
 } from "./events";
 import {QueueMessage} from "./types/QueueMessage";
 import ChatboxError from "./errors/ChatboxError";
@@ -165,6 +165,12 @@ export declare interface Client {
      */
     on(event: "death", listener: (death: Death) => void): this;
 
+    /**
+     * The event received when a player changes world.
+     * @event
+     */
+    on(event: "world_change", listener: (worldChange: WorldChange) => void): this;
+
     /**
      * The event received when a player goes AFK in-game.
      * @event

src/events/WorldChange.ts

@@ -0,0 +1,26 @@
+import {BaseEvent} from "./BaseEvent";
+import {User, RenderedTextObject} from "../types";
+
+/** The event received when a player changes worlds. */
+export interface WorldChange extends BaseEvent {
+    /** The in-game player who changed worlds. */
+    user: User;
+
+    /**
+     * The world the player has moved from. It will be a Minecraft namespaced registry key, for example:
+     *
+     * - `minecraft:overworld` - The overworld
+     * - `minecraft:the_nether` - The Nether
+     * - `minecraft:the_end` - The End
+     */
+    origin: string;
+
+    /**
+     * The world the player is now in. It will be a Minecraft namespaced registry key, for example:
+     *
+     * - `minecraft:overworld` - The overworld
+     * - `minecraft:the_nether` - The Nether
+     * - `minecraft:the_end` - The End
+     */
+    destination: string;
+}

src/events/index.ts

@@ -4,6 +4,7 @@ export * from "./BaseEvent";
 export * from "./ChatboxChatMessage";
 export * from "./ChatboxCommand";
 export * from "./Death";
+export * from "./WorldChange";
 export * from "./DiscordChatMessage";
 export * from "./IngameChatMessage";
 export * from "./Join";