hytopia 0.5.20 → 0.5.22-dev1

package/docs/server.startserver.md

@@ -9,7 +9,7 @@ The entry point for running game setup and starting the game server.
 **Signature:**
 
 ```typescript
-export declare function startServer(init: (world: World) => void): void;
+export declare function startServer(init: ((() => void) | ((world: World) => void))): void;
 ```
 
 ## Parameters
@@ -37,12 +37,12 @@ init
 
 </td><td>
 
-(world: [World](./server.world.md)<!-- -->) =&gt; void
+((() =&gt; void) \| ((world: [World](./server.world.md)<!-- -->) =&gt; void))
 
 
 </td><td>
 
-A function that initializes the world.
+A function that initializes the game. The function can take no parameters to just initialize game logic, or it can accept a world parameter. If it accepts a world parameter, a default world will be automatically created and passed to the function.
 
 
 </td></tr>

package/docs/server.world.md

@@ -426,6 +426,27 @@ The scene UI manager for the world.
 The simulation for the world.
 
 
+</td></tr>
+<tr><td>
+
+[skyboxIntensity](./server.world.skyboxintensity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The intensity of the world's skybox brightness.
+
+
 </td></tr>
 <tr><td>
 
@@ -572,6 +593,20 @@ Sets the intensity of the world's directional light.
 Sets the position the world's directional light originates from.
 
 
+</td></tr>
+<tr><td>
+
+[setSkyboxIntensity(intensity)](./server.world.setskyboxintensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the intensity of the world's skybox brightness.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.setskyboxintensity.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; [setSkyboxIntensity](./server.world.setskyboxintensity.md)
+
+## World.setSkyboxIntensity() method
+
+Sets the intensity of the world's skybox brightness.
+
+**Signature:**
+
+```typescript
+setSkyboxIntensity(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
+

package/docs/server.world.skyboxintensity.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; [skyboxIntensity](./server.world.skyboxintensity.md)
+
+## World.skyboxIntensity property
+
+The intensity of the world's skybox brightness.
+
+**Signature:**
+
+```typescript
+get skyboxIntensity(): number;
+```

package/docs/server.worldevent.md

@@ -99,6 +99,20 @@ SET\_DIRECTIONAL\_LIGHT\_POSITION
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_SKYBOX\_INTENSITY
+
+
+</td><td>
+
+`"WORLD.SET_SKYBOX_INTENSITY"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldeventpayloads._world.set_skybox_intensity_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_SKYBOX\_INTENSITY"](./server.worldeventpayloads._world.set_skybox_intensity_.md)
+
+## WorldEventPayloads."WORLD.SET\_SKYBOX\_INTENSITY" property
+
+Emitted when the intensity of the world's skybox brightness is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_SKYBOX_INTENSITY]: {
+        world: World;
+        intensity: number;
+    };
+```

package/docs/server.worldeventpayloads.md

@@ -129,6 +129,25 @@ Emitted when the intensity of the world's directional light is set.
 Emitted when the position of the world's directional light is set.
 
 
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_SKYBOX\_INTENSITY"](./server.worldeventpayloads._world.set_skybox_intensity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; intensity: number; }
+
+
+</td><td>
+
+Emitted when the intensity of the world's skybox brightness is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldmanager.md

@@ -168,5 +168,19 @@ Gets a world by its id.
 Gets all worlds with a specific tag.
 
 
+</td></tr>
+<tr><td>
+
+[setDefaultWorld(world)](./server.worldmanager.setdefaultworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the default world. This is the world players automatically join when they connect to the game.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.worldmanager.setdefaultworld.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; [WorldManager](./server.worldmanager.md) &gt; [setDefaultWorld](./server.worldmanager.setdefaultworld.md)
+
+## WorldManager.setDefaultWorld() method
+
+Sets the default world. This is the world players automatically join when they connect to the game.
+
+**Signature:**
+
+```typescript
+setDefaultWorld(world: World): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world to set as the default.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.worldoptions.map.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; [WorldOptions](./server.worldoptions.md) &gt; [map](./server.worldoptions.map.md)
+
+## WorldOptions.map property
+
+The map of the world.
+
+**Signature:**
+
+```typescript
+map?: WorldMap;
+```

package/docs/server.worldoptions.md

@@ -167,6 +167,25 @@ number
 The unique ID of the world.
 
 
+</td></tr>
+<tr><td>
+
+[map?](./server.worldoptions.map.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldMap](./server.worldmap.md)
+
+
+</td><td>
+
+_(Optional)_ The map of the world.
+
+
 </td></tr>
 <tr><td>
 
@@ -186,6 +205,25 @@ string
 The name of the world.
 
 
+</td></tr>
+<tr><td>
+
+[skyboxIntensity?](./server.worldoptions.skyboxintensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The intensity of the skybox brightness for the world. 0 is black, 1 is full brightness, 1+ is brighter.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldoptions.skyboxintensity.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; [WorldOptions](./server.worldoptions.md) &gt; [skyboxIntensity](./server.worldoptions.skyboxintensity.md)
+
+## WorldOptions.skyboxIntensity property
+
+The intensity of the skybox brightness for the world. 0 is black, 1 is full brightness, 1+ is brighter.
+
+**Signature:**
+
+```typescript
+skyboxIntensity?: number;
+```