hytopia 0.5.0-dev1 → 0.5.0-dev3

package/docs/server.worldmanager.createworld.md

@@ -0,0 +1,55 @@
+<!-- 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; [createWorld](./server.worldmanager.createworld.md)
+
+## WorldManager.createWorld() method
+
+Creates a new world.
+
+**Signature:**
+
+```typescript
+createWorld(options: Omit<WorldOptions, 'id'>): World;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Omit&lt;[WorldOptions](./server.worldoptions.md)<!-- -->, 'id'&gt;
+
+
+</td><td>
+
+The options for the world.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[World](./server.world.md)
+
+The created world.
+

package/docs/server.worldmanager.getallworlds.md

@@ -0,0 +1,19 @@
+<!-- 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; [getAllWorlds](./server.worldmanager.getallworlds.md)
+
+## WorldManager.getAllWorlds() method
+
+Gets all worlds.
+
+**Signature:**
+
+```typescript
+getAllWorlds(): World[];
+```
+**Returns:**
+
+[World](./server.world.md)<!-- -->\[\]
+
+All worlds.
+

package/docs/server.worldmanager.getdefaultworld.md

@@ -0,0 +1,19 @@
+<!-- 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; [getDefaultWorld](./server.worldmanager.getdefaultworld.md)
+
+## WorldManager.getDefaultWorld() method
+
+Gets the default world.
+
+**Signature:**
+
+```typescript
+getDefaultWorld(): World;
+```
+**Returns:**
+
+[World](./server.world.md)
+
+The default world.
+

package/docs/server.worldmanager.getworld.md

@@ -0,0 +1,55 @@
+<!-- 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; [getWorld](./server.worldmanager.getworld.md)
+
+## WorldManager.getWorld() method
+
+Gets a world by its id.
+
+**Signature:**
+
+```typescript
+getWorld(id: number): World | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The id of the world to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[World](./server.world.md) \| undefined
+
+The world with the provided id, or undefined if no world is found.
+

package/docs/server.worldmanager.getworldsbytag.md

@@ -0,0 +1,55 @@
+<!-- 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; [getWorldsByTag](./server.worldmanager.getworldsbytag.md)
+
+## WorldManager.getWorldsByTag() method
+
+Gets all worlds with a specific tag.
+
+**Signature:**
+
+```typescript
+getWorldsByTag(tag: string): World[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tag
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The tag to get the worlds for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[World](./server.world.md)<!-- -->\[\]
+
+All worlds with the provided tag.
+

package/docs/server.worldmanager.instance.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; [WorldManager](./server.worldmanager.md) &gt; [instance](./server.worldmanager.instance.md)
+
+## WorldManager.instance property
+
+The global WorldManager instance as a singleton.
+
+**Signature:**
+
+```typescript
+static readonly instance: WorldManager;
+```

package/docs/server.worldmanager.md

@@ -0,0 +1,172 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldManager](./server.worldmanager.md)
+
+## WorldManager class
+
+Manages all worlds in a game server.
+
+**Signature:**
+
+```typescript
+export default class WorldManager 
+```
+
+## Remarks
+
+The WorldManager is created internally as a global singleton accessible with the static property `WorldManager.instance`<!-- -->.
+
+<h2>Events</h2>
+
+This class emits global events with payloads listed under [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
+
+## Example
+
+
+```typescript
+import { WorldManager } from 'hytopia';
+
+const worldManager = WorldManager.instance;
+const newWorld = worldManager.createWorld({
+  name: 'My New World',
+  skyboxUri: 'skyboxes/partly-cloudy',
+});
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[instance](./server.worldmanager.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[WorldManager](./server.worldmanager.md)
+
+
+</td><td>
+
+The global WorldManager instance as a singleton.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[createWorld(options)](./server.worldmanager.createworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new world.
+
+
+</td></tr>
+<tr><td>
+
+[getAllWorlds()](./server.worldmanager.getallworlds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all worlds.
+
+
+</td></tr>
+<tr><td>
+
+[getDefaultWorld()](./server.worldmanager.getdefaultworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the default world.
+
+
+</td></tr>
+<tr><td>
+
+[getWorld(id)](./server.worldmanager.getworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets a world by its id.
+
+
+</td></tr>
+<tr><td>
+
+[getWorldsByTag(tag)](./server.worldmanager.getworldsbytag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all worlds with a specific tag.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldmanagerevent.md

@@ -0,0 +1,47 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldManagerEvent](./server.worldmanagerevent.md)
+
+## WorldManagerEvent enum
+
+Event types a WorldManager instance can emit to the global event router. See [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum WorldManagerEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+WORLD\_CREATED
+
+
+</td><td>
+
+`"WORLD_MANAGER.WORLD_CREATED"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldmanagereventpayloads._world_manager.world_created_.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md) &gt; ["WORLD\_MANAGER.WORLD\_CREATED"](./server.worldmanagereventpayloads._world_manager.world_created_.md)
+
+## WorldManagerEventPayloads."WORLD\_MANAGER.WORLD\_CREATED" property
+
+Emitted when a world is created.
+
+**Signature:**
+
+```typescript
+[WorldManagerEvent.WORLD_CREATED]: {
+        world: World;
+    };
+```

package/docs/server.worldmanagereventpayloads.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
+
+## WorldManagerEventPayloads interface
+
+Event payloads for WorldManager emitted events.
+
+**Signature:**
+
+```typescript
+export interface WorldManagerEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["WORLD\_MANAGER.WORLD\_CREATED"](./server.worldmanagereventpayloads._world_manager.world_created_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a world is created.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldoptions.md

@@ -205,6 +205,25 @@ string
 The URI of the skybox cubemap for the world.
 
 
+</td></tr>
+<tr><td>
+
+[tag?](./server.worldoptions.tag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ An arbitrary identifier tag of the world. Useful for your own logic
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldoptions.tag.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; [tag](./server.worldoptions.tag.md)
+
+## WorldOptions.tag property
+
+An arbitrary identifier tag of the world. Useful for your own logic
+
+**Signature:**
+
+```typescript
+tag?: string;
+```

package/examples/hygrounds/gc.log

@@ -0,0 +1,11 @@
+error: invalid JSC environment variable
+
+    BUN_JSC_gcPrintStats=1
+
+For a list of options, see this file:
+
+    https://github.com/oven-sh/webkit/blob/main/Source/JavaScriptCore/runtime/OptionsList.h
+
+Environment variables must be prefixed with "BUN_JSC_". This code runs before .env files are loaded, so those won't work here.
+
+Warning: options change between releases of Bun and WebKit without notice. This is not a stable API, you should not rely on it beyond debugging something, and it may be removed entirely in a future version of Bun.

package/package.json

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