hytopia 0.1.34 → 0.1.37

package/README.md

@@ -5,12 +5,14 @@
 
 ## What is HYTOPIA?
 
-![HYTOPIA Demo](./readme/assets/demo.gif)
+![HYTOPIA Banner](./readme/assets/banner-2.jpeg)
 
 HYTOPIA is a modern games platform inspired by Minecraft, Roblox, and Rec Room.
 
 HYTOPIA allows you to create your own highly-sharable, immersive, massively multiplayer games in a voxel-like style by writing TypeScript or JavaScript. All playable in a web browser on any device!
 
+No need to deal with hosting or complex server infrastructure either, simply upload your game to HYTOPIA and we'll handle the scaling, server costs, and more!
+
 ## What is this SDK?
 
 *Note: This SDK is currently in alpha development. Expect breaking changes with new version releases.*

package/docs/server.audio.md

@@ -22,7 +22,7 @@ Audio instances are created directly as instances. They support a variety of con
 
 ```typescript
 (new Audio({
-  uri: 'assets/music/song.mp3',
+  uri: 'music/song.mp3', // relative to the server's assets directory in the project root, resolves to assets/music/song.mp3
   loop: true,
   volume: 0.5,
 })).play(world);
@@ -328,7 +328,7 @@ The playback rate of the audio if explicitly set.
 
 </td><td>
 
-[Vector3](./server.vector3.md) \| undefined
+[Vector3Like](./server.vector3like.md) \| undefined
 
 
 </td><td>

package/docs/server.audio.position.md

@@ -9,5 +9,5 @@ The position of the audio in the world if explicitly set.
 **Signature:**
 
 ```typescript
-get position(): Vector3 | undefined;
+get position(): Vector3Like | undefined;
 ```

package/docs/server.audio.setposition.md

@@ -9,7 +9,7 @@ Sets the position of the audio. Will detach from entity if attached.
 **Signature:**
 
 ```typescript
-setPosition(position: Vector3): void;
+setPosition(position: Vector3Like): void;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ position
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.audioeventpayload.setposition.md

@@ -60,7 +60,7 @@ Description
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.audioeventpayload.setposition.position.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-position: Vector3;
+position: Vector3Like;
 ```

package/docs/server.audiooptions.md

@@ -178,7 +178,7 @@ _(Optional)_ The playback speed of the audio. Defaults to 1.
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.audiooptions.position.md

@@ -9,5 +9,5 @@ The position in the world where the audio is played.
 **Signature:**
 
 ```typescript
-position?: Vector3;
+position?: Vector3Like;
 ```

package/docs/server.block.globalcoordinate.md

@@ -9,5 +9,5 @@ The global coordinate of the block.
 **Signature:**
 
 ```typescript
-readonly globalCoordinate: Vector3;
+readonly globalCoordinate: Vector3Like;
 ```

package/docs/server.block.md

@@ -74,7 +74,7 @@ The block type of the block.
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.blocktype.md

@@ -24,7 +24,7 @@ Block types are created directly as instances. They support a variety of configu
 const stoneBlockTypeId = 10;
 world.blockTypeRegistry.registerBlockType(stoneBlockTypeId, new BlockType({
   id: stoneBlockTypeId,
-  textureUri: 'assets/textures/stone.png',
+  textureUri: 'textures/stone.png',
   name: 'Stone',
 }));
 

package/docs/server.blocktyperegistry.md

@@ -25,7 +25,7 @@ The constructor for this class is marked as internal. Third-party code should no
 ```typescript
 world.blockTypeRegistry.registerGenericBlockType({
   id: 15,
-  textureUri: 'assets/textures/dirt.png',
+  textureUri: 'textures/dirt.png',
   name: 'Dirt',
 });
 ```
@@ -124,7 +124,7 @@ Get a registered block type by its id.
 </td></tr>
 <tr><td>
 
-[registerBlockType(id, blockTypeReference)](./server.blocktyperegistry.registerblocktype.md)
+[registerBlockType(blockType)](./server.blocktyperegistry.registerblocktype.md)
 
 
 </td><td>

package/docs/server.blocktyperegistry.registerblocktype.md

@@ -9,7 +9,7 @@ Register a block type.
 **Signature:**
 
 ```typescript
-registerBlockType(id: number, blockTypeReference: BlockType): void;
+registerBlockType(blockType: BlockType): void;
 ```
 
 ## Parameters
@@ -32,23 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-id
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The id of the block type to register.
-
-
-</td></tr>
-<tr><td>
-
-blockTypeReference
+blockType
 
 
 </td><td>

package/docs/server.chunk.blockindextolocalcoordinate.md

@@ -9,7 +9,7 @@ Convert a block index to a local coordinate.
 **Signature:**
 
 ```typescript
-static blockIndexToLocalCoordinate(index: number): Vector3;
+static blockIndexToLocalCoordinate(index: number): Vector3Like;
 ```
 
 ## Parameters
@@ -49,7 +49,7 @@ The index of the block to convert.
 </tbody></table>
 **Returns:**
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 The local coordinate of the block.
 

package/docs/server.chunk.getblock.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; [Chunk](./server.chunk.md) &gt; [getBlock](./server.chunk.getblock.md)
+
+## Chunk.getBlock() method
+
+Get the block type id at a specific local coordinate.
+
+**Signature:**
+
+```typescript
+getBlock(localCoordinate: Vector3Like): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+localCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The local coordinate of the block to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The block type id.
+

package/docs/server.chunk.globalcoordinatetolocalcoordinate.md

@@ -9,7 +9,7 @@ Convert a global coordinate to a local coordinate.
 **Signature:**
 
 ```typescript
-static globalCoordinateToLocalCoordinate(globalCoordinate: Vector3): Vector3;
+static globalCoordinateToLocalCoordinate(globalCoordinate: Vector3Like): Vector3Like;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ globalCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
@@ -49,7 +49,7 @@ The global coordinate to convert.
 </tbody></table>
 **Returns:**
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 The local coordinate.
 

package/docs/server.chunk.globalcoordinatetoorigincoordinate.md

@@ -9,7 +9,7 @@ Convert a global coordinate to an origin coordinate.
 **Signature:**
 
 ```typescript
-static globalCoordinateToOriginCoordinate(globalCoordinate: Vector3): Vector3;
+static globalCoordinateToOriginCoordinate(globalCoordinate: Vector3Like): Vector3Like;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ globalCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
@@ -49,7 +49,7 @@ The global coordinate to convert.
 </tbody></table>
 **Returns:**
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 The origin coordinate.
 

package/docs/server.chunk.hasblock.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; [Chunk](./server.chunk.md) &gt; [hasBlock](./server.chunk.hasblock.md)
+
+## Chunk.hasBlock() method
+
+Check if a block exists at a specific local coordinate.
+
+**Signature:**
+
+```typescript
+hasBlock(localCoordinate: Vector3Like): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+localCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The local coordinate of the block to check.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether a block exists.
+

package/docs/server.chunk.isvalidorigincoordinate.md

@@ -9,7 +9,7 @@ Check if an origin coordinate is valid.
 **Signature:**
 
 ```typescript
-static isValidOriginCoordinate(coordinate: Vector3): boolean;
+static isValidOriginCoordinate(coordinate: Vector3Like): boolean;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ coordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.chunk.md

@@ -165,7 +165,7 @@ Whether the chunk has been spawned.
 
 </td><td>
 
-[Vector3](./server.vector3.md) \| undefined
+[Vector3Like](./server.vector3like.md) \| undefined
 
 
 </td><td>
@@ -244,6 +244,20 @@ Convert a block index to a local coordinate.
 Despawn the chunk from the world.
 
 
+</td></tr>
+<tr><td>
+
+[getBlock(localCoordinate)](./server.chunk.getblock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the block type id at a specific local coordinate.
+
+
 </td></tr>
 <tr><td>
 
@@ -276,6 +290,20 @@ Convert a global coordinate to a local coordinate.
 Convert a global coordinate to an origin coordinate.
 
 
+</td></tr>
+<tr><td>
+
+[hasBlock(localCoordinate)](./server.chunk.hasblock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Check if a block exists at a specific local coordinate.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.chunk.origincoordinate.md

@@ -9,5 +9,5 @@ The origin coordinate of the chunk.
 **Signature:**
 
 ```typescript
-get originCoordinate(): Vector3 | undefined;
+get originCoordinate(): Vector3Like | undefined;
 ```

package/docs/server.chunk.setblock.md

@@ -9,7 +9,7 @@ Set the block at a specific local coordinate by block type id.
 **Signature:**
 
 ```typescript
-setBlock(localCoordinate: Vector3, blockTypeId: number): void;
+setBlock(localCoordinate: Vector3Like, blockTypeId: number): void;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ localCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.chunk.spawn.md

@@ -9,7 +9,7 @@ Spawn the chunk in the world.
 **Signature:**
 
 ```typescript
-spawn(world: World, originCoordinate: Vector3): void;
+spawn(world: World, originCoordinate: Vector3Like): void;
 ```
 
 ## Parameters
@@ -53,7 +53,7 @@ originCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.chunkeventpayload.setblock.globalcoordinate.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-globalCoordinate: Vector3;
+globalCoordinate: Vector3Like;
 ```

package/docs/server.chunkeventpayload.setblock.localcoordinate.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-localCoordinate: Vector3;
+localCoordinate: Vector3Like;
 ```

package/docs/server.chunkeventpayload.setblock.md

@@ -77,7 +77,7 @@ number
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
@@ -94,7 +94,7 @@ number
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.chunklattice.getblock.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; [ChunkLattice](./server.chunklattice.md) &gt; [getBlock](./server.chunklattice.getblock.md)
+
+## ChunkLattice.getBlock() method
+
+Get the block type id at a specific global coordinate.
+
+**Signature:**
+
+```typescript
+getBlock(globalCoordinate: Vector3Like): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+globalCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The global coordinate of the block to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The block type id, 0 if no block is set.
+

package/docs/server.chunklattice.getchunk.md

@@ -9,7 +9,7 @@ Get a chunk by its origin coordinate.
 **Signature:**
 
 ```typescript
-getChunk(originCoordinate: Vector3): Chunk | undefined;
+getChunk(originCoordinate: Vector3Like): Chunk | undefined;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ originCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.chunklattice.hasblock.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; [ChunkLattice](./server.chunklattice.md) &gt; [hasBlock](./server.chunklattice.hasblock.md)
+
+## ChunkLattice.hasBlock() method
+
+Check if a block exists at a specific global coordinate.
+
+**Signature:**
+
+```typescript
+hasBlock(globalCoordinate: Vector3Like): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+globalCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The global coordinate of the block to check.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether a block exists.
+

package/docs/server.chunklattice.haschunk.md

@@ -9,7 +9,7 @@ Check if a chunk exists by its origin coordinate.
 **Signature:**
 
 ```typescript
-hasChunk(originCoordinate: Vector3): boolean;
+hasChunk(originCoordinate: Vector3Like): boolean;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ originCoordinate
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>