hytopia 0.1.1 → 0.1.2

package/docs/server.chatmanager.unregistercommand.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; [ChatManager](./server.chatmanager.md) &gt; [unregisterCommand](./server.chatmanager.unregistercommand.md)
+
+## ChatManager.unregisterCommand() method
+
+Unregister a command.
+
+**Signature:**
+
+```typescript
+unregisterCommand(command: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+command
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The command to unregister.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.chunk._constructor_.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; [Chunk](./server.chunk.md) &gt; [(constructor)](./server.chunk._constructor_.md)
+
+## Chunk.(constructor)
+
+Creates a new chunk instance.
+
+**Signature:**
+
+```typescript
+constructor();
+```

package/docs/server.chunk.blockindextolocalcoordinate.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; [blockIndexToLocalCoordinate](./server.chunk.blockindextolocalcoordinate.md)
+
+## Chunk.blockIndexToLocalCoordinate() method
+
+Convert a block index to a local coordinate.
+
+**Signature:**
+
+```typescript
+static blockIndexToLocalCoordinate(index: number): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+index
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The index of the block to convert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The local coordinate of the block.
+

package/docs/server.chunk.blocks.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; [Chunk](./server.chunk.md) &gt; [blocks](./server.chunk.blocks.md)
+
+## Chunk.blocks property
+
+The blocks in the chunk as a flat Uint8Array\[4096\], each index as 0 or a block type id.
+
+**Signature:**
+
+```typescript
+get blocks(): Readonly<Uint8Array>;
+```

package/docs/server.chunk.despawn.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; [Chunk](./server.chunk.md) &gt; [despawn](./server.chunk.despawn.md)
+
+## Chunk.despawn() method
+
+Despawn the chunk from the world.
+
+**Signature:**
+
+```typescript
+despawn(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.chunk.globalcoordinatetolocalcoordinate.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; [globalCoordinateToLocalCoordinate](./server.chunk.globalcoordinatetolocalcoordinate.md)
+
+## Chunk.globalCoordinateToLocalCoordinate() method
+
+Convert a global coordinate to a local coordinate.
+
+**Signature:**
+
+```typescript
+static globalCoordinateToLocalCoordinate(globalCoordinate: Vector3): Vector3;
+```
+
+## 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 to convert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The local coordinate.
+

package/docs/server.chunk.globalcoordinatetoorigincoordinate.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; [globalCoordinateToOriginCoordinate](./server.chunk.globalcoordinatetoorigincoordinate.md)
+
+## Chunk.globalCoordinateToOriginCoordinate() method
+
+Convert a global coordinate to an origin coordinate.
+
+**Signature:**
+
+```typescript
+static globalCoordinateToOriginCoordinate(globalCoordinate: Vector3): Vector3;
+```
+
+## 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 to convert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The origin coordinate.
+

package/docs/server.chunk.issimulated.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; [Chunk](./server.chunk.md) &gt; [isSimulated](./server.chunk.issimulated.md)
+
+## Chunk.isSimulated property
+
+Whether the chunk is actively simulated in the internal physics engine.
+
+**Signature:**
+
+```typescript
+get isSimulated(): boolean;
+```

package/docs/server.chunk.isspawned.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; [Chunk](./server.chunk.md) &gt; [isSpawned](./server.chunk.isspawned.md)
+
+## Chunk.isSpawned property
+
+Whether the chunk has been spawned.
+
+**Signature:**
+
+```typescript
+get isSpawned(): boolean;
+```

package/docs/server.chunk.isvalidorigincoordinate.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; [isValidOriginCoordinate](./server.chunk.isvalidorigincoordinate.md)
+
+## Chunk.isValidOriginCoordinate() method
+
+Check if an origin coordinate is valid.
+
+**Signature:**
+
+```typescript
+static isValidOriginCoordinate(coordinate: Vector3): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+coordinate
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The coordinate to check.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether the coordinate is valid.
+

package/docs/server.chunk.md

@@ -0,0 +1,324 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Chunk](./server.chunk.md)
+
+## Chunk class
+
+A 16^3 chunk of blocks. Used to represent a world's terrain.
+
+**Signature:**
+
+```typescript
+export default class Chunk implements protocol.Serializable 
+```
+**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).
+
+## 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
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)()](./server.chunk._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new chunk instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[blocks](./server.chunk.blocks.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Readonly&lt;Uint8Array&gt;
+
+
+</td><td>
+
+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>
+
+[originCoordinate](./server.chunk.origincoordinate.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.md) \| undefined
+
+
+</td><td>
+
+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>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[blockIndexToLocalCoordinate(index)](./server.chunk.blockindextolocalcoordinate.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+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>
+
+[globalCoordinateToLocalCoordinate(globalCoordinate)](./server.chunk.globalcoordinatetolocalcoordinate.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Convert a global coordinate to a local coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[globalCoordinateToOriginCoordinate(globalCoordinate)](./server.chunk.globalcoordinatetoorigincoordinate.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Convert a global coordinate to an origin 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

@@ -0,0 +1,13 @@
+<!-- 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; [originCoordinate](./server.chunk.origincoordinate.md)
+
+## Chunk.originCoordinate property
+
+The origin coordinate of the chunk.
+
+**Signature:**
+
+```typescript
+get originCoordinate(): Vector3 | undefined;
+```