hytopia 0.1.69 → 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/docs/server.light._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Light](./server.light.md) &gt; [(constructor)](./server.light._constructor_.md)
+
+## Light.(constructor)
+
+Constructs a new instance of the `Light` class
+
+**Signature:**
+
+```typescript
+constructor(options: LightOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[LightOptions](./server.lightoptions.md)
+
+
+</td><td>
+
+The options for the Light instance.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.light.angle.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; [Light](./server.light.md) &gt; [angle](./server.light.angle.md)
+
+## Light.angle property
+
+If type is spotlight, the angle of the spotlight.
+
+**Signature:**
+
+```typescript
+get angle(): number | undefined;
+```

package/docs/server.light.attachedtoentity.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; [Light](./server.light.md) &gt; [attachedToEntity](./server.light.attachedtoentity.md)
+
+## Light.attachedToEntity property
+
+The entity to which the Light is attached if explicitly set.
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.light.color.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; [Light](./server.light.md) &gt; [color](./server.light.color.md)
+
+## Light.color property
+
+The color of the light.
+
+**Signature:**
+
+```typescript
+get color(): RgbColor;
+```

package/docs/server.light.despawn.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Light](./server.light.md) &gt; [despawn](./server.light.despawn.md)
+
+## Light.despawn() method
+
+Despawns the Light from the world.
+
+**Signature:**
+
+```typescript
+despawn(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.light.distance.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; [Light](./server.light.md) &gt; [distance](./server.light.distance.md)
+
+## Light.distance property
+
+The maximum distance the light will illuminate. 0 does not limit distance. Defaults to 0.
+
+**Signature:**
+
+```typescript
+get distance(): number | undefined;
+```

package/docs/server.light.id.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; [Light](./server.light.md) &gt; [id](./server.light.id.md)
+
+## Light.id property
+
+The unique identifier for the Light.
+
+**Signature:**
+
+```typescript
+get id(): number | undefined;
+```

package/docs/server.light.intensity.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; [Light](./server.light.md) &gt; [intensity](./server.light.intensity.md)
+
+## Light.intensity property
+
+The intensity of the light in candela (cd). Defaults to 1
+
+**Signature:**
+
+```typescript
+get intensity(): number;
+```

package/docs/server.light.isspawned.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; [Light](./server.light.md) &gt; [isSpawned](./server.light.isspawned.md)
+
+## Light.isSpawned property
+
+Whether the Light is spawned into the world.
+
+**Signature:**
+
+```typescript
+get isSpawned(): boolean;
+```