hytopia 0.6.34 → 0.7.1

package/docs/server.blocktype.collideroptions.md

@@ -9,5 +9,5 @@ The collider options for the block type.
 **Signature:**
 
 ```typescript
-get colliderOptions(): TrimeshColliderOptions;
+get colliderOptions(): VoxelsColliderOptions;
 ```

package/docs/server.blocktype.halfextents.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; [BlockType](./server.blocktype.md) &gt; [halfExtents](./server.blocktype.halfextents.md)
+
+## BlockType.halfExtents property
+
+The half extents size of the block type.
+
+**Signature:**
+
+```typescript
+get halfExtents(): Vector3Like;
+```

package/docs/server.blocktype.md

@@ -107,7 +107,7 @@ Description
 
 </td><td>
 
-[TrimeshColliderOptions](./server.trimeshcollideroptions.md)
+[VoxelsColliderOptions](./server.voxelscollideroptions.md)
 
 
 </td><td>
@@ -115,6 +115,27 @@ Description
 The collider options for the block type.
 
 
+</td></tr>
+<tr><td>
+
+[halfExtents](./server.blocktype.halfextents.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The half extents size of the block type.
+
+
 </td></tr>
 <tr><td>
 
@@ -199,6 +220,27 @@ string
 The name of the block type.
 
 
+</td></tr>
+<tr><td>
+
+[size](./server.blocktype.size.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The size of the block type.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.blocktype.size.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; [BlockType](./server.blocktype.md) &gt; [size](./server.blocktype.size.md)
+
+## BlockType.size property
+
+The size of the block type.
+
+**Signature:**
+
+```typescript
+get size(): Vector3Like;
+```

package/docs/server.blocktypeoptions.customcollideroptions.md

@@ -9,5 +9,5 @@ The custom collider options for the block type.
 **Signature:**
 
 ```typescript
-customColliderOptions?: TrimeshColliderOptions;
+customColliderOptions?: VoxelsColliderOptions;
 ```

package/docs/server.blocktypeoptions.halfextents.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; [BlockTypeOptions](./server.blocktypeoptions.md) &gt; [halfExtents](./server.blocktypeoptions.halfextents.md)
+
+## BlockTypeOptions.halfExtents property
+
+The half extents size of the block type.
+
+**Signature:**
+
+```typescript
+halfExtents?: Vector3Like;
+```

package/docs/server.blocktypeoptions.md

@@ -45,7 +45,7 @@ Description
 
 </td><td>
 
-[TrimeshColliderOptions](./server.trimeshcollideroptions.md)
+[VoxelsColliderOptions](./server.voxelscollideroptions.md)
 
 
 </td><td>
@@ -53,6 +53,25 @@ Description
 _(Optional)_ The custom collider options for the block type.
 
 
+</td></tr>
+<tr><td>
+
+[halfExtents?](./server.blocktypeoptions.halfextents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The half extents size of the block type.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.chunk._constructor_.md

@@ -9,5 +9,39 @@ Creates a new chunk instance.
 **Signature:**
 
 ```typescript
-constructor();
+constructor(originCoordinate: Vector3Like);
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+originCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.chunk.md

@@ -9,35 +9,13 @@ A 16^3 chunk of blocks. Used to represent a world's terrain.
 **Signature:**
 
 ```typescript
-export default class Chunk extends EventRouter implements protocol.Serializable 
+export default class Chunk implements protocol.Serializable 
 ```
-**Extends:** [EventRouter](./server.eventrouter.md)
-
 **Implements:** protocol.Serializable
 
 ## Remarks
 
-Chunks make up the bulk of the terrain in a world. Chunks are fixed size, each containing 16^3 possible blocks as a 16x16x16 cube. Chunks can be spawned, despawned, have their unique blocks set or removed, and more. Chunks represent their internal block coordinates in local space, meaning only coordinates x: 0...15, y: 0...15, z: 0...15 are valid.
-
-The Chunk follows a spawn and despawn lifecycle pattern. When you create a chunk, when you're ready to load it in your world you use .spawn(). To remove it, you use .despawn().
-
-Use .setBlock() to set the block type id at a specific local cooridnate. Block type ids are ones that have been registered in the [BlockTypeRegistry](./server.blocktyperegistry.md) associated with the [World](./server.world.md) the chunk belongs to. A block type id of 0 is used to represent no block. Removing a block is done by .setBlock(localCoordinate, 0).
-
-<h2>Events</h2>
-
-This class is an EventRouter, and instances of it emit events with payloads listed under [ChunkEventPayloads](./server.chunkeventpayloads.md)
-
-## Example
-
-
-```typescript
-// Assume we previously registered a stone block with type id of 10..
-
-const chunk = new Chunk();
-
-chunk.setBlock({ x: 0, y: 0, z: 0 }, 10); // Set the block at 0, 0, 0 to stone
-chunk.spawn(world, { x: 16, y: 0, z: 16 }); // Spawn the chunk at global coordinate 16, 0, 16
-```
+Chunks make up the bulk of the terrain in a world. Chunks are fixed size, each containing 16^3 possible blocks as a 16x16x16 cube. Chunks are primarily a data structure used by [ChunkLattice](./server.chunklattice.md) to represent a world's terrain. Chunks store their internal block coordinates in local space, meaning local coordinates x: 0...15, y: 0...15, z: 0...15.
 
 ## Constructors
 
@@ -59,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)()](./server.chunk._constructor_.md)
+[(constructor)(originCoordinate)](./server.chunk._constructor_.md)
 
 
 </td><td>
@@ -116,48 +94,6 @@ Readonly&lt;Uint8Array&gt;
 The blocks in the chunk as a flat Uint8Array\[4096\], each index as 0 or a block type id.
 
 
-</td></tr>
-<tr><td>
-
-[isSimulated](./server.chunk.issimulated.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the chunk is actively simulated in the internal physics engine.
-
-
-</td></tr>
-<tr><td>
-
-[isSpawned](./server.chunk.isspawned.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the chunk has been spawned.
-
-
 </td></tr>
 <tr><td>
 
@@ -171,7 +107,7 @@ Whether the chunk has been spawned.
 
 </td><td>
 
-[Vector3Like](./server.vector3like.md) \| undefined
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
@@ -179,27 +115,6 @@ Whether the chunk has been spawned.
 The origin coordinate of the chunk.
 
 
-</td></tr>
-<tr><td>
-
-[world](./server.chunk.world.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[World](./server.world.md) \| undefined
-
-
-</td><td>
-
-The world the chunk belongs to.
-
-
 </td></tr>
 </tbody></table>
 
@@ -236,20 +151,6 @@ Description
 Convert a block index to a local coordinate.
 
 
-</td></tr>
-<tr><td>
-
-[despawn()](./server.chunk.despawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Despawn the chunk from the world.
-
-
 </td></tr>
 <tr><td>
 
@@ -310,49 +211,5 @@ Convert a global coordinate to an origin coordinate.
 Check if a block exists at a specific local coordinate.
 
 
-</td></tr>
-<tr><td>
-
-[isValidOriginCoordinate(coordinate)](./server.chunk.isvalidorigincoordinate.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Check if an origin coordinate is valid.
-
-
-</td></tr>
-<tr><td>
-
-[setBlock(localCoordinate, blockTypeId)](./server.chunk.setblock.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Set the block at a specific local coordinate by block type id.
-
-
-</td></tr>
-<tr><td>
-
-[spawn(world, originCoordinate)](./server.chunk.spawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Spawn the chunk in the world.
-
-
 </td></tr>
 </tbody></table>

package/docs/server.chunk.origincoordinate.md

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

package/docs/server.chunklattice.clear.md

@@ -4,7 +4,7 @@
 
 ## ChunkLattice.clear() method
 
-Despawns and clears all chunks in the lattice.
+Removes and clears all chunks and their blocks from the lattice.
 
 **Signature:**
 

package/docs/server.chunklattice.getblocktypecount.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; [getBlockTypeCount](./server.chunklattice.getblocktypecount.md)
+
+## ChunkLattice.getBlockTypeCount() method
+
+Get the number of blocks of a specific block type in the lattice.
+
+**Signature:**
+
+```typescript
+getBlockTypeCount(blockTypeId: number): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+blockTypeId
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The block type id to get the count of.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The number of blocks of the block type.
+

package/docs/server.chunklattice.getchunk.md

@@ -4,12 +4,12 @@
 
 ## ChunkLattice.getChunk() method
 
-Get a chunk by its origin coordinate.
+Get the chunk that contains the given global coordinate.
 
 **Signature:**
 
 ```typescript
-getChunk(originCoordinate: Vector3Like): Chunk | undefined;
+getChunk(globalCoordinate: Vector3Like): Chunk | undefined;
 ```
 
 ## Parameters
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-originCoordinate
+globalCoordinate
 
 
 </td><td>
@@ -42,7 +42,7 @@ originCoordinate
 
 </td><td>
 
-The origin coordinate of the chunk to get.
+The global coordinate to get the chunk for.
 
 
 </td></tr>
@@ -51,5 +51,5 @@ The origin coordinate of the chunk to get.
 
 [Chunk](./server.chunk.md) \| undefined
 
-The chunk at the given origin coordinate or undefined if not found.
+The chunk that contains the given global coordinate or undefined if not found.
 

package/docs/server.chunklattice.getorcreatechunk.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; [getOrCreateChunk](./server.chunklattice.getorcreatechunk.md)
+
+## ChunkLattice.getOrCreateChunk() method
+
+Get the chunk for a given global coordinate.
+
+**Signature:**
+
+```typescript
+getOrCreateChunk(globalCoordinate: Vector3Like): Chunk;
+```
+
+## 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 chunk to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Chunk](./server.chunk.md)
+
+The chunk at the given global coordinate or undefined if not found.
+

package/docs/server.chunklattice.haschunk.md

@@ -4,12 +4,12 @@
 
 ## ChunkLattice.hasChunk() method
 
-Check if a chunk exists by its origin coordinate.
+Check if a chunk exists for a given global coordinate.
 
 **Signature:**
 
 ```typescript
-hasChunk(originCoordinate: Vector3Like): boolean;
+hasChunk(globalCoordinate: Vector3Like): boolean;
 ```
 
 ## Parameters
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-originCoordinate
+globalCoordinate
 
 
 </td><td>
@@ -42,7 +42,7 @@ originCoordinate
 
 </td><td>
 
-The origin coordinate of the chunk to check.
+The global coordinate of the chunk to check.
 
 
 </td></tr>

package/docs/server.chunklattice.md

@@ -9,8 +9,9 @@ A lattice of chunks that represent a world's terrain.
 **Signature:**
 
 ```typescript
-export default class ChunkLattice 
+export default class ChunkLattice extends EventRouter 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
 
 ## Remarks
 
@@ -124,7 +125,7 @@ Description
 
 </td><td>
 
-Despawns and clears all chunks in the lattice.
+Removes and clears all chunks and their blocks from the lattice.
 
 
 </td></tr>
@@ -172,7 +173,7 @@ Get the block type at a specific global coordinate.
 </td></tr>
 <tr><td>
 
-[getChunk(originCoordinate)](./server.chunklattice.getchunk.md)
+[getBlockTypeCount(blockTypeId)](./server.chunklattice.getblocktypecount.md)
 
 
 </td><td>
@@ -180,7 +181,35 @@ Get the block type at a specific global coordinate.
 
 </td><td>
 
-Get a chunk by its origin coordinate.
+Get the number of blocks of a specific block type in the lattice.
+
+
+</td></tr>
+<tr><td>
+
+[getChunk(globalCoordinate)](./server.chunklattice.getchunk.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the chunk that contains the given global coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[getOrCreateChunk(globalCoordinate)](./server.chunklattice.getorcreatechunk.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the chunk for a given global coordinate.
 
 
 </td></tr>
@@ -200,7 +229,7 @@ Check if a block exists at a specific global coordinate.
 </td></tr>
 <tr><td>
 
-[hasChunk(originCoordinate)](./server.chunklattice.haschunk.md)
+[hasChunk(globalCoordinate)](./server.chunklattice.haschunk.md)
 
 
 </td><td>
@@ -208,7 +237,7 @@ Check if a block exists at a specific global coordinate.
 
 </td><td>
 
-Check if a chunk exists by its origin coordinate.
+Check if a chunk exists for a given global coordinate.
 
 
 </td></tr>
@@ -222,7 +251,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. Use block type id 0 for air.
+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 (to remove a block).
 
 
 </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. Use block type id 0 for air.
+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 (to remove a block).
 
 **Signature:**