hytopia 0.1.1 → 0.1.2

package/docs/server.hytopia.worldloop.world.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoop](./server.hytopia.worldloop.md) &gt; [world](./server.hytopia.worldloop.world.md)
+
+## HYTOPIA.WorldLoop.world property
+
+The world that the loop manages.
+
+**Signature:**
+
+```typescript
+get world(): World;
+```

package/docs/server.hytopia.worldmap.blocks.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldMap](./server.hytopia.worldmap.md) &gt; [blocks](./server.hytopia.worldmap.blocks.md)
+
+## HYTOPIA.WorldMap.blocks property
+
+The blocks in the map
+
+**Signature:**
+
+```typescript
+blocks: {
+        [coordinate: string]: number;
+    };
+```

package/docs/server.hytopia.worldmap.blocktypes.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldMap](./server.hytopia.worldmap.md) &gt; [blockTypes](./server.hytopia.worldmap.blocktypes.md)
+
+## HYTOPIA.WorldMap.blockTypes property
+
+The block types in the map.
+
+**Signature:**
+
+```typescript
+blockTypes: {
+        id: number;
+        name: string;
+        textureUri: string;
+    }[];
+```

package/docs/server.hytopia.worldmap.md

@@ -0,0 +1,76 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [WorldMap](./server.hytopia.worldmap.md)
+
+## HYTOPIA.WorldMap interface
+
+A map representation for a world.
+
+**Signature:**
+
+```typescript
+export interface WorldMap 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[blocks](./server.hytopia.worldmap.blocks.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[coordinate: string\]: number; }
+
+
+</td><td>
+
+The blocks in the map
+
+
+</td></tr>
+<tr><td>
+
+[blockTypes](./server.hytopia.worldmap.blocktypes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ id: number; name: string; textureUri: string; }\[\]
+
+
+</td><td>
+
+The block types in the map.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldoptions.gravity.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldOptions](./server.hytopia.worldoptions.md) &gt; [gravity](./server.hytopia.worldoptions.gravity.md)
+
+## HYTOPIA.WorldOptions.gravity property
+
+The gravity vector for the world.
+
+**Signature:**
+
+```typescript
+gravity?: Vector3;
+```

package/docs/server.hytopia.worldoptions.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldOptions](./server.hytopia.worldoptions.md) &gt; [id](./server.hytopia.worldoptions.id.md)
+
+## HYTOPIA.WorldOptions.id property
+
+The unique ID of the world.
+
+**Signature:**
+
+```typescript
+id: number;
+```

package/docs/server.hytopia.worldoptions.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [WorldOptions](./server.hytopia.worldoptions.md)
+
+## HYTOPIA.WorldOptions interface
+
+Options for creating a World instance.
+
+**Signature:**
+
+```typescript
+export interface WorldOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[gravity?](./server.hytopia.worldoptions.gravity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+_(Optional)_ The gravity vector for the world.
+
+
+</td></tr>
+<tr><td>
+
+[id](./server.hytopia.worldoptions.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The unique ID of the world.
+
+
+</td></tr>
+<tr><td>
+
+[name](./server.hytopia.worldoptions.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the world.
+
+
+</td></tr>
+<tr><td>
+
+[skyboxUri](./server.hytopia.worldoptions.skyboxuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the skybox cubemap for the world.
+
+
+</td></tr>
+<tr><td>
+
+[tickRate?](./server.hytopia.worldoptions.tickrate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The tick rate for the world.
+
+
+</td></tr>
+</tbody></table>

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

package/docs/server.hytopia.worldoptions.skyboxuri.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldOptions](./server.hytopia.worldoptions.md) &gt; [skyboxUri](./server.hytopia.worldoptions.skyboxuri.md)
+
+## HYTOPIA.WorldOptions.skyboxUri property
+
+The URI of the skybox cubemap for the world.
+
+**Signature:**
+
+```typescript
+skyboxUri: string;
+```

package/docs/server.hytopia.worldoptions.tickrate.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldOptions](./server.hytopia.worldoptions.md) &gt; [tickRate](./server.hytopia.worldoptions.tickrate.md)
+
+## HYTOPIA.WorldOptions.tickRate property
+
+The tick rate for the world.
+
+**Signature:**
+
+```typescript
+tickRate?: number;
+```