hytopia 0.1.33 → 0.1.36

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);

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.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: Vector3): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+localCoordinate
+
+
+</td><td>
+
+[Vector3](./server.vector3.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.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: Vector3): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+localCoordinate
+
+
+</td><td>
+
+[Vector3](./server.vector3.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.md

@@ -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.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: Vector3): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+globalCoordinate
+
+
+</td><td>
+
+[Vector3](./server.vector3.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.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: Vector3): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+globalCoordinate
+
+
+</td><td>
+
+[Vector3](./server.vector3.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.md

@@ -81,6 +81,20 @@ Description
 Get all chunks in the lattice.
 
 
+</td></tr>
+<tr><td>
+
+[getBlock(globalCoordinate)](./server.chunklattice.getblock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the block type id at a specific global coordinate.
+
+
 </td></tr>
 <tr><td>
 
@@ -95,6 +109,20 @@ Get all chunks in the lattice.
 Get a chunk by its origin coordinate.
 
 
+</td></tr>
+<tr><td>
+
+[hasBlock(globalCoordinate)](./server.chunklattice.hasblock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Check if a block exists at a specific global coordinate.
+
+
 </td></tr>
 <tr><td>
 
@@ -120,7 +148,7 @@ Check if a chunk exists by its origin coordinate.
 
 </td><td>
 
-Set the block at a global coordinate by block type id, automatically creating a chunk if it doesn't exist.
+Set the block at a global coordinate by block type id, automatically creating a chunk if it doesn't exist. Use block type id 0 for air.
 
 
 </td></tr>

package/docs/server.chunklattice.setblock.md

@@ -4,7 +4,7 @@
 
 ## ChunkLattice.setBlock() method
 
-Set the block at a global coordinate by block type id, automatically creating a chunk if it doesn't exist.
+Set the block at a global coordinate by block type id, automatically creating a chunk if it doesn't exist. Use block type id 0 for air.
 
 **Signature:**
 
@@ -58,7 +58,7 @@ number
 
 </td><td>
 
-The block type id to set.
+The block type id to set. Use 0 to remove the block and replace with air.
 
 
 </td></tr>

package/docs/server.collider.md

@@ -198,6 +198,27 @@ RAPIER.Collider \| undefined
 The raw collider object from the Rapier physics engine.
 
 
+</td></tr>
+<tr><td>
+
+[shape](./server.collider.shape.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+The shape of the collider.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.collider.shape.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; [Collider](./server.collider.md) &gt; [shape](./server.collider.shape.md)
+
+## Collider.shape property
+
+The shape of the collider.
+
+**Signature:**
+
+```typescript
+get shape(): ColliderShape;
+```

package/docs/server.default_block_entity_rigid_body_options.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; [DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.default_block_entity_rigid_body_options.md)
+
+## DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS variable
+
+The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided.
+
+**Signature:**
+
+```typescript
+DEFAULT_BLOCK_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions
+```

package/docs/server.default_entity_rigid_body_options.md

@@ -4,7 +4,7 @@
 
 ## DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS variable
 
-The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
+The default rigid body options for a model entity when EntityOptions.rigidBodyOptions is not provided.
 
 **Signature:**
 

package/docs/server.entity.blockhalfextents.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; [Entity](./server.entity.md) &gt; [blockHalfExtents](./server.entity.blockhalfextents.md)
+
+## Entity.blockHalfExtents property
+
+The half extends of the visual size of the block entity when blockTextureUri is set.
+
+**Signature:**
+
+```typescript
+get blockHalfExtents(): Vector3 | undefined;
+```

package/docs/server.entity.blocktextureuri.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; [Entity](./server.entity.md) &gt; [blockTextureUri](./server.entity.blocktextureuri.md)
+
+## Entity.blockTextureUri property
+
+The URI or path to the texture to be used, if this is set, the entity is a block entity.
+
+**Signature:**
+
+```typescript
+get blockTextureUri(): string | undefined;
+```

package/docs/server.entity.md

@@ -104,6 +104,48 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[blockHalfExtents](./server.entity.blockhalfextents.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.md) \| undefined
+
+
+</td><td>
+
+The half extends of the visual size of the block entity when blockTextureUri is set.
+
+
+</td></tr>
+<tr><td>
+
+[blockTextureUri](./server.entity.blocktextureuri.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The URI or path to the texture to be used, if this is set, the entity is a block entity.
+
+
+</td></tr>
+<tr><td>
+
 [characterController](./server.entity.charactercontroller.md)
 
 
@@ -400,6 +442,48 @@ _(Optional)_ A function that is called when the entity is spawned.
 _(Optional)_ A function that is called every tick.
 
 
+</td></tr>
+<tr><td>
+
+[tag](./server.entity.tag.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+An arbitrary identifier tag of the entity. Useful for your own logic.
+
+
+</td></tr>
+<tr><td>
+
+[tintColor](./server.entity.tintcolor.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md) \| undefined
+
+
+</td><td>
+
+The tint color of the entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -469,6 +553,20 @@ Despawns the entity from the world.
 Sets the character controller for the entity.
 
 
+</td></tr>
+<tr><td>
+
+[setTintColor(tintColor)](./server.entity.settintcolor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the tint color of the entity.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.settintcolor.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; [Entity](./server.entity.md) &gt; [setTintColor](./server.entity.settintcolor.md)
+
+## Entity.setTintColor() method
+
+Sets the tint color of the entity.
+
+**Signature:**
+
+```typescript
+setTintColor(tintColor: RgbColor | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tintColor
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md) \| undefined
+
+
+</td><td>
+
+The tint color of the entity.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+