hytopia 0.1.69 → 0.1.71

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.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

@@ -336,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>
 
@@ -524,7 +545,7 @@ Loads a map into the world.
 
 </td><td>
 
-Sets the color of the ambient light.
+Sets the color of the world's ambient light.
 
 
 </td></tr>
@@ -538,7 +559,7 @@ Sets the color of the ambient light.
 
 </td><td>
 
-Sets the intensity of the ambient light.
+Sets the intensity of the world's ambient light.
 
 
 </td></tr>
@@ -552,7 +573,7 @@ Sets the intensity of the ambient light.
 
 </td><td>
 
-Sets the color of the directional light.
+Sets the color of the world's directional light.
 
 
 </td></tr>
@@ -566,7 +587,7 @@ Sets the color of the directional light.
 
 </td><td>
 
-Sets the intensity of the directional light.
+Sets the intensity of the world's directional light.
 
 
 </td></tr>
@@ -580,7 +601,7 @@ Sets the intensity of the directional light.
 
 </td><td>
 
-Sets the position the directional light originates from.
+Sets the position the world's directional light originates from.
 
 
 </td></tr>

package/docs/server.world.setambientlightcolor.md

@@ -4,7 +4,7 @@
 
 ## World.setAmbientLightColor() method
 
-Sets the color of the ambient light.
+Sets the color of the world's ambient light.
 
 **Signature:**
 

package/docs/server.world.setambientlightintensity.md

@@ -4,7 +4,7 @@
 
 ## World.setAmbientLightIntensity() method
 
-Sets the intensity of the ambient light.
+Sets the intensity of the world's ambient light.
 
 **Signature:**
 

package/docs/server.world.setdirectionallightcolor.md

@@ -4,7 +4,7 @@
 
 ## World.setDirectionalLightColor() method
 
-Sets the color of the directional light.
+Sets the color of the world's directional light.
 
 **Signature:**
 

package/docs/server.world.setdirectionallightintensity.md

@@ -4,7 +4,7 @@
 
 ## World.setDirectionalLightIntensity() method
 
-Sets the intensity of the directional light.
+Sets the intensity of the world's directional light.
 
 **Signature:**
 

package/docs/server.world.setdirectionallightposition.md

@@ -4,7 +4,7 @@
 
 ## World.setDirectionalLightPosition() method
 
-Sets the position the directional light originates from.
+Sets the position the world's directional light originates from.
 
 **Signature:**
 

package/docs/server.worldoptions.ambientlightcolor.md

@@ -4,7 +4,7 @@
 
 ## WorldOptions.ambientLightColor property
 
-The color of the ambient light.
+The color of the ambient light for the world.
 
 **Signature:**
 

package/docs/server.worldoptions.ambientlightintensity.md

@@ -4,7 +4,7 @@
 
 ## WorldOptions.ambientLightIntensity property
 
-The intensity of the ambient light. 0 to 1+
+The intensity of the ambient light for the world. 0 to 1+
 
 **Signature:**
 

package/docs/server.worldoptions.directionallightcolor.md

@@ -4,7 +4,7 @@
 
 ## WorldOptions.directionalLightColor property
 
-The color of the directional light.
+The color of the directional light for the world.
 
 **Signature:**
 

package/docs/server.worldoptions.directionallightintensity.md

@@ -4,7 +4,7 @@
 
 ## WorldOptions.directionalLightIntensity property
 
-The intensity of the directional light. 0 to 1+
+The intensity of the directional light for the world. 0 to 1+
 
 **Signature:**
 

package/docs/server.worldoptions.directionallightposition.md

@@ -4,7 +4,7 @@
 
 ## WorldOptions.directionalLightPosition property
 
-The position the directional light originates from.
+The position the directional light originates from for the world.
 
 **Signature:**
 

package/docs/server.worldoptions.md

@@ -50,7 +50,7 @@ Description
 
 </td><td>
 
-_(Optional)_ The color of the ambient light.
+_(Optional)_ The color of the ambient light for the world.
 
 
 </td></tr>
@@ -69,7 +69,7 @@ number
 
 </td><td>
 
-_(Optional)_ The intensity of the ambient light. 0 to 1+
+_(Optional)_ The intensity of the ambient light for the world. 0 to 1+
 
 
 </td></tr>
@@ -88,7 +88,7 @@ _(Optional)_ The intensity of the ambient light. 0 to 1+
 
 </td><td>
 
-_(Optional)_ The color of the directional light.
+_(Optional)_ The color of the directional light for the world.
 
 
 </td></tr>
@@ -107,7 +107,7 @@ number
 
 </td><td>
 
-_(Optional)_ The intensity of the directional light. 0 to 1+
+_(Optional)_ The intensity of the directional light for the world. 0 to 1+
 
 
 </td></tr>
@@ -126,7 +126,7 @@ _(Optional)_ The intensity of the directional light. 0 to 1+
 
 </td><td>
 
-_(Optional)_ The position the directional light originates from.
+_(Optional)_ The position the directional light originates from for the world.
 
 
 </td></tr>

package/examples/lighting/README.md

@@ -0,0 +1,3 @@
+# lighting
+
+A cave map with examples of creative lighting usages