hytopia 0.1.68 → 0.1.70

package/docs/server.md

@@ -170,6 +170,28 @@ Manages event emission and assigned listener callbacks.
 Manages the game and associated worlds and systems.
 
 
+</td></tr>
+<tr><td>
+
+[Light](./server.light.md)
+
+
+</td><td>
+
+Represents a light in a world. Lights can be point lights or spotlights.
+
+
+</td></tr>
+<tr><td>
+
+[LightManager](./server.lightmanager.md)
+
+
+</td><td>
+
+Manages Light instances in a world.
+
+
 </td></tr>
 <tr><td>
 
@@ -486,6 +508,28 @@ Event types an Entity instance can emit.
 Event types a GameServer instance can emit.
 
 
+</td></tr>
+<tr><td>
+
+[LightEventType](./server.lighteventtype.md)
+
+
+</td><td>
+
+Event types a Light instance can emit.
+
+
+</td></tr>
+<tr><td>
+
+[LightType](./server.lighttype.md)
+
+
+</td><td>
+
+The types a Light can be.
+
+
 </td></tr>
 <tr><td>
 
@@ -648,6 +692,17 @@ Options for creating an Entity instance.
 An EventRouter event.
 
 
+</td></tr>
+<tr><td>
+
+[LightOptions](./server.lightoptions.md)
+
+
+</td><td>
+
+Options for creating a Light instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -850,6 +905,17 @@ Payloads for events an Entity instance can emit.
 Payloads for events emitted by a GameServer instance.
 
 
+</td></tr>
+<tr><td>
+
+[LightEventPayload](./server.lighteventpayload.md)
+
+
+</td><td>
+
+Payloads for events a Light instance can emit.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.sceneui.attachedtoentity.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.attachedToEntity property
 
+The entity to which the SceneUI is attached if explicitly set.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.id.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.id property
 
+The unique identifier for the SceneUI.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.isloaded.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.isLoaded property
 
+Whether the SceneUI is loaded into the world.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.md

@@ -102,6 +102,8 @@ Description
 
 </td><td>
 
+The entity to which the SceneUI is attached if explicitly set.
+
 
 </td></tr>
 <tr><td>
@@ -121,6 +123,8 @@ number \| undefined
 
 </td><td>
 
+The unique identifier for the SceneUI.
+
 
 </td></tr>
 <tr><td>
@@ -140,6 +144,8 @@ boolean
 
 </td><td>
 
+Whether the SceneUI is loaded into the world.
+
 
 </td></tr>
 <tr><td>
@@ -159,6 +165,8 @@ boolean
 
 </td><td>
 
+The offset of the SceneUI from the attached entity or position.
+
 
 </td></tr>
 <tr><td>
@@ -178,6 +186,8 @@ boolean
 
 </td><td>
 
+The position of the SceneUI in the world if explicitly set.
+
 
 </td></tr>
 <tr><td>
@@ -197,6 +207,8 @@ Readonly&lt;object&gt;
 
 </td><td>
 
+The state of the SceneUI.
+
 
 </td></tr>
 <tr><td>
@@ -216,6 +228,8 @@ string
 
 </td><td>
 
+The template ID of the SceneUI.
+
 
 </td></tr>
 <tr><td>
@@ -235,6 +249,8 @@ number \| undefined
 
 </td><td>
 
+The maximum view distance the SceneUI will be visible to the player.
+
 
 </td></tr>
 <tr><td>
@@ -254,6 +270,8 @@ number \| undefined
 
 </td><td>
 
+The world the SceneUI is loaded into.
+
 
 </td></tr>
 </tbody></table>

package/docs/server.sceneui.offset.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.offset property
 
+The offset of the SceneUI from the attached entity or position.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.position.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.position property
 
+The position of the SceneUI in the world if explicitly set.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.state.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.state property
 
+The state of the SceneUI.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.templateid.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.templateId property
 
+The template ID of the SceneUI.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.viewdistance.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.viewDistance property
 
+The maximum view distance the SceneUI will be visible to the player.
+
 **Signature:**
 
 ```typescript

package/docs/server.sceneui.world.md

@@ -4,6 +4,8 @@
 
 ## SceneUI.world property
 
+The world the SceneUI is loaded into.
+
 **Signature:**
 
 ```typescript

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

package/docs/server.world.ambientlightintensity.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; [World](./server.world.md) &gt; [ambientLightIntensity](./server.world.ambientlightintensity.md)
+
+## World.ambientLightIntensity property
+
+The intensity of the ambient light.
+
+**Signature:**
+
+```typescript
+get ambientLightIntensity(): number;
+```

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

package/docs/server.world.directionallightintensity.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; [World](./server.world.md) &gt; [directionalLightIntensity](./server.world.directionallightintensity.md)
+
+## World.directionalLightIntensity property
+
+The intensity of the directional light.
+
+**Signature:**
+
+```typescript
+get directionalLightIntensity(): number;
+```

package/docs/server.world.directionallightposition.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; [World](./server.world.md) &gt; [directionalLightPosition](./server.world.directionallightposition.md)
+
+## World.directionalLightPosition property
+
+The position the directional light originates from.
+
+**Signature:**
+
+```typescript
+get directionalLightPosition(): Vector3Like;
+```

package/docs/server.world.lightmanager.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; [World](./server.world.md) &gt; [lightManager](./server.world.lightmanager.md)
+
+## World.lightManager property
+
+The light manager for the world.
+
+**Signature:**
+
+```typescript
+get lightManager(): LightManager;
+```

package/docs/server.world.md

@@ -87,6 +87,48 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ambientLightColor](./server.world.ambientlightcolor.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color of the ambient light.
+
+
+</td></tr>
+<tr><td>
+
+[ambientLightIntensity](./server.world.ambientlightintensity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The intensity of the ambient light.
+
+
+</td></tr>
+<tr><td>
+
 [audioManager](./server.world.audiomanager.md)
 
 
@@ -168,6 +210,69 @@ The chat manager for the world.
 The chunk lattice for the world.
 
 
+</td></tr>
+<tr><td>
+
+[directionalLightColor](./server.world.directionallightcolor.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color of the directional light.
+
+
+</td></tr>
+<tr><td>
+
+[directionalLightIntensity](./server.world.directionallightintensity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The intensity of the directional light.
+
+
+</td></tr>
+<tr><td>
+
+[directionalLightPosition](./server.world.directionallightposition.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The position the directional light originates from.
+
+
 </td></tr>
 <tr><td>
 
@@ -231,6 +336,27 @@ number
 The unique ID of the world.
 
 
+</td></tr>
+<tr><td>
+
+[lightManager](./server.world.lightmanager.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[LightManager](./server.lightmanager.md)
+
+
+</td><td>
+
+The light manager for the world.
+
+
 </td></tr>
 <tr><td>
 
@@ -408,6 +534,76 @@ Description
 Loads a map into the world.
 
 
+</td></tr>
+<tr><td>
+
+[setAmbientLightColor(color)](./server.world.setambientlightcolor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the color of the world's ambient light.
+
+
+</td></tr>
+<tr><td>
+
+[setAmbientLightIntensity(intensity)](./server.world.setambientlightintensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the intensity of the world's ambient light.
+
+
+</td></tr>
+<tr><td>
+
+[setDirectionalLightColor(color)](./server.world.setdirectionallightcolor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the color of the world's directional light.
+
+
+</td></tr>
+<tr><td>
+
+[setDirectionalLightIntensity(intensity)](./server.world.setdirectionallightintensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the intensity of the world's directional light.
+
+
+</td></tr>
+<tr><td>
+
+[setDirectionalLightPosition(position)](./server.world.setdirectionallightposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the position the world's directional light originates from.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.setambientlightcolor.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [World](./server.world.md) &gt; [setAmbientLightColor](./server.world.setambientlightcolor.md)
+
+## World.setAmbientLightColor() method
+
+Sets the color of the world's ambient light.
+
+**Signature:**
+
+```typescript
+setAmbientLightColor(color: RgbColor): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+color
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color of the light.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.world.setambientlightintensity.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [World](./server.world.md) &gt; [setAmbientLightIntensity](./server.world.setambientlightintensity.md)
+
+## World.setAmbientLightIntensity() method
+
+Sets the intensity of the world's ambient light.
+
+**Signature:**
+
+```typescript
+setAmbientLightIntensity(intensity: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+intensity
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The intensity.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+