hytopia 0.1.70 → 0.1.71

package/docs/server.chatmanager.md

@@ -35,6 +35,50 @@ world.chatManager.registerCommand('/kick', (player, args, message) => {
 });
 ```
 
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[onBroadcastMessage?](./server.chatmanager.onbroadcastmessage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(player: [Player](./server.player.md) \| undefined, message: string, color?: string) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called when a broadcast (public) message is sent by a player or the server.
+
+
+</td></tr>
+</tbody></table>
+
 ## Methods
 
 <table><thead><tr><th>
@@ -77,7 +121,7 @@ Register a command and its callback.
 
 </td><td>
 
-Send a broadcast message to all players in the world.
+Send a system broadcast message to all players in the world.
 
 
 </td></tr>
@@ -91,7 +135,7 @@ Send a broadcast message to all players in the world.
 
 </td><td>
 
-Send a message to a specific player, only visible to them.
+Send a system message to a specific player, only visible to them.
 
 
 </td></tr>

package/docs/server.chatmanager.onbroadcastmessage.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChatManager](./server.chatmanager.md) &gt; [onBroadcastMessage](./server.chatmanager.onbroadcastmessage.md)
+
+## ChatManager.onBroadcastMessage property
+
+A function that is called when a broadcast (public) message is sent by a player or the server.
+
+**Signature:**
+
+```typescript
+onBroadcastMessage?: (player: Player | undefined, message: string, color?: string) => void;
+```

package/docs/server.chatmanager.sendbroadcastmessage.md

@@ -4,7 +4,7 @@
 
 ## ChatManager.sendBroadcastMessage() method
 
-Send a broadcast message to all players in the world.
+Send a system broadcast message to all players in the world.
 
 **Signature:**
 

package/docs/server.chatmanager.sendplayermessage.md

@@ -4,7 +4,7 @@
 
 ## ChatManager.sendPlayerMessage() method
 
-Send a message to a specific player, only visible to them.
+Send a system message to a specific player, only visible to them.
 
 **Signature:**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.70",
+  "version": "0.1.71",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -4665,6 +4665,45 @@
           "name": "ChatManager",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "server!ChatManager#onBroadcastMessage:member",
+              "docComment": "/**\n * A function that is called when a broadcast (public) message is sent by a player or the server.\n *\n * @param player - The player that sent the message, or undefined if the message is a system message from the server.\n *\n * @param message - The message to send.\n *\n * @param color - The color of the message as a hex color code, excluding #.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onBroadcastMessage?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(player: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined, message: string, color?: string) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "onBroadcastMessage",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!ChatManager#registerCommand:member(1)",
@@ -4733,7 +4772,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!ChatManager#sendBroadcastMessage:member(1)",
-              "docComment": "/**\n * Send a broadcast message to all players in the world.\n *\n * @param message - The message to send.\n *\n * @param color - The color of the message as a hex color code, excluding #.\n *\n * @example\n * ```typescript\n * chatManager.sendBroadcastMessage('Hello, world!', 'FF00AA');\n * ```\n *\n */\n",
+              "docComment": "/**\n * Send a system broadcast message to all players in the world.\n *\n * @param message - The message to send.\n *\n * @param color - The color of the message as a hex color code, excluding #.\n *\n * @example\n * ```typescript\n * chatManager.sendBroadcastMessage('Hello, world!', 'FF00AA');\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -4797,7 +4836,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!ChatManager#sendPlayerMessage:member(1)",
-              "docComment": "/**\n * Send a message to a specific player, only visible to them.\n *\n * @param player - The player to send the message to.\n *\n * @param message - The message to send.\n *\n * @param color - The color of the message as a hex color code, excluding #.\n *\n * @example\n * ```typescript\n * chatManager.sendPlayerMessage(player, 'Hello, player!', 'FF00AA');\n * ```\n *\n */\n",
+              "docComment": "/**\n * Send a system message to a specific player, only visible to them.\n *\n * @param player - The player to send the message to.\n *\n * @param message - The message to send.\n *\n * @param color - The color of the message as a hex color code, excluding #.\n *\n * @example\n * ```typescript\n * chatManager.sendPlayerMessage(player, 'Hello, player!', 'FF00AA');\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/server.d.ts

@@ -614,6 +614,15 @@ export declare enum ChatEventType {
  * @public
  */
 export declare class ChatManager {
+    /**
+     * A function that is called when a broadcast (public) message is sent
+     * by a player or the server.
+     *
+     * @param player - The player that sent the message, or undefined if the message is a system message from the server.
+     * @param message - The message to send.
+     * @param color - The color of the message as a hex color code, excluding #.
+     */
+    onBroadcastMessage?: (player: Player | undefined, message: string, color?: string) => void;
 
 
 
@@ -629,7 +638,7 @@ export declare class ChatManager {
      */
     unregisterCommand(command: string): void;
     /**
-     * Send a broadcast message to all players in the world.
+     * Send a system broadcast message to all players in the world.
      * @param message - The message to send.
      * @param color - The color of the message as a hex color code, excluding #.
      *
@@ -640,7 +649,7 @@ export declare class ChatManager {
      */
     sendBroadcastMessage(message: string, color?: string): void;
     /**
-     * Send a message to a specific player, only visible to them.
+     * Send a system message to a specific player, only visible to them.
      * @param player - The player to send the message to.
      * @param message - The message to send.
      * @param color - The color of the message as a hex color code, excluding #.
@@ -653,6 +662,7 @@ export declare class ChatManager {
     sendPlayerMessage(player: Player, message: string, color?: string): void;
 
 
+
 }
 
 /**