hytopia 0.1.1 → 0.1.2

package/docs/server.hytopia.blocktypeoptions.md

@@ -0,0 +1,108 @@
+<!-- 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; [BlockTypeOptions](./server.hytopia.blocktypeoptions.md)
+
+## HYTOPIA.BlockTypeOptions interface
+
+Options for creating a block type instance.
+
+**Signature:**
+
+```typescript
+export interface BlockTypeOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[customColliderOptions?](./server.hytopia.blocktypeoptions.customcollideroptions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderOptions](./server.collideroptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[id](./server.hytopia.blocktypeoptions.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./server.hytopia.blocktypeoptions.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[textureUri](./server.hytopia.blocktypeoptions.textureuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.blocktypeoptions.name.md

@@ -0,0 +1,11 @@
+<!-- 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; [BlockTypeOptions](./server.hytopia.blocktypeoptions.md) &gt; [name](./server.hytopia.blocktypeoptions.name.md)
+
+## HYTOPIA.BlockTypeOptions.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```

package/docs/server.hytopia.blocktypeoptions.textureuri.md

@@ -0,0 +1,11 @@
+<!-- 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; [BlockTypeOptions](./server.hytopia.blocktypeoptions.md) &gt; [textureUri](./server.hytopia.blocktypeoptions.textureuri.md)
+
+## HYTOPIA.BlockTypeOptions.textureUri property
+
+**Signature:**
+
+```typescript
+textureUri: string;
+```

package/docs/server.hytopia.blocktyperegistry.getallblocktypes.md

@@ -0,0 +1,19 @@
+<!-- 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; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md) &gt; [getAllBlockTypes](./server.hytopia.blocktyperegistry.getallblocktypes.md)
+
+## HYTOPIA.BlockTypeRegistry.getAllBlockTypes() method
+
+Get all registered block types.
+
+**Signature:**
+
+```typescript
+getAllBlockTypes(): BlockType[];
+```
+**Returns:**
+
+[BlockType](./server.blocktype.md)<!-- -->\[\]
+
+An array of all registered block types.
+

package/docs/server.hytopia.blocktyperegistry.getblocktype.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; [HYTOPIA](./server.hytopia.md) &gt; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md) &gt; [getBlockType](./server.hytopia.blocktyperegistry.getblocktype.md)
+
+## HYTOPIA.BlockTypeRegistry.getBlockType() method
+
+Get a registered block type by its id.
+
+**Signature:**
+
+```typescript
+getBlockType(id: number): BlockType;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The id of the block type to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[BlockType](./server.blocktype.md)
+
+The block type with the given id.
+

package/docs/server.hytopia.blocktyperegistry.md

@@ -0,0 +1,153 @@
+<!-- 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; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md)
+
+## HYTOPIA.BlockTypeRegistry class
+
+Manages known block types in a world.
+
+**Signature:**
+
+```typescript
+export default class BlockTypeRegistry implements protocol.Serializable 
+```
+**Implements:** protocol.Serializable
+
+## Remarks
+
+Block type registries are created internally as a singleton for each [World](./server.world.md) instance in a game server. A block type registry allows you to register and retrieve block types by their unique id for a world.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BlockTypeRegistry` class.
+
+## Example
+
+
+```typescript
+world.blockTypeRegistry.registerGenericBlockType({
+  id: 15,
+  textureUri: 'assets/textures/dirt.png',
+  name: 'Dirt',
+});
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[world](./server.hytopia.blocktyperegistry.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world the block type registry is for.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllBlockTypes()](./server.hytopia.blocktyperegistry.getallblocktypes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get all registered block types.
+
+
+</td></tr>
+<tr><td>
+
+[getBlockType(id)](./server.hytopia.blocktyperegistry.getblocktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get a registered block type by its id.
+
+
+</td></tr>
+<tr><td>
+
+[registerBlockType(id, blockTypeReference)](./server.hytopia.blocktyperegistry.registerblocktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Register a block type.
+
+
+</td></tr>
+<tr><td>
+
+[registerGenericBlockType(blockTypeOptions)](./server.hytopia.blocktyperegistry.registergenericblocktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Register a generic block type.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.blocktyperegistry.registerblocktype.md

@@ -0,0 +1,69 @@
+<!-- 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; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md) &gt; [registerBlockType](./server.hytopia.blocktyperegistry.registerblocktype.md)
+
+## HYTOPIA.BlockTypeRegistry.registerBlockType() method
+
+Register a block type.
+
+**Signature:**
+
+```typescript
+registerBlockType(id: number, blockTypeReference: BlockType): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+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
+
+
+</td><td>
+
+[BlockType](./server.blocktype.md)
+
+
+</td><td>
+
+The block type to register.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.blocktyperegistry.registergenericblocktype.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; [HYTOPIA](./server.hytopia.md) &gt; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md) &gt; [registerGenericBlockType](./server.hytopia.blocktyperegistry.registergenericblocktype.md)
+
+## HYTOPIA.BlockTypeRegistry.registerGenericBlockType() method
+
+Register a generic block type.
+
+**Signature:**
+
+```typescript
+registerGenericBlockType(blockTypeOptions: BlockTypeOptions): BlockType;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+blockTypeOptions
+
+
+</td><td>
+
+[BlockTypeOptions](./server.blocktypeoptions.md)
+
+
+</td><td>
+
+The options for the block type.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[BlockType](./server.blocktype.md)
+
+The registered block type.
+

package/docs/server.hytopia.blocktyperegistry.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; [BlockTypeRegistry](./server.hytopia.blocktyperegistry.md) &gt; [world](./server.hytopia.blocktyperegistry.world.md)
+
+## HYTOPIA.BlockTypeRegistry.world property
+
+The world the block type registry is for.
+
+**Signature:**
+
+```typescript
+get world(): World;
+```

package/docs/server.hytopia.blocktyperegistryeventpayload.md

@@ -0,0 +1,37 @@
+<!-- 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; [BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md)
+
+## HYTOPIA.BlockTypeRegistryEventPayload namespace
+
+Payloads for events a BlockTypeRegistry instance can emit.
+
+**Signature:**
+
+```typescript
+export declare namespace BlockTypeRegistryEventPayload 
+```
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[RegisterBlockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktype.md

@@ -0,0 +1,11 @@
+<!-- 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; [BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md) &gt; [RegisterBlockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.md) &gt; [blockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktype.md)
+
+## HYTOPIA.BlockTypeRegistryEventPayload.RegisterBlockType.blockType property
+
+**Signature:**
+
+```typescript
+blockType: BlockType;
+```

package/docs/server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktyperegistry.md

@@ -0,0 +1,11 @@
+<!-- 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; [BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md) &gt; [RegisterBlockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.md) &gt; [blockTypeRegistry](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktyperegistry.md)
+
+## HYTOPIA.BlockTypeRegistryEventPayload.RegisterBlockType.blockTypeRegistry property
+
+**Signature:**
+
+```typescript
+blockTypeRegistry: BlockTypeRegistry;
+```

package/docs/server.hytopia.blocktyperegistryeventpayload.registerblocktype.id.md

@@ -0,0 +1,11 @@
+<!-- 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; [BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md) &gt; [RegisterBlockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.md) &gt; [id](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.id.md)
+
+## HYTOPIA.BlockTypeRegistryEventPayload.RegisterBlockType.id property
+
+**Signature:**
+
+```typescript
+id: number;
+```

package/docs/server.hytopia.blocktyperegistryeventpayload.registerblocktype.md

@@ -0,0 +1,87 @@
+<!-- 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; [BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md) &gt; [RegisterBlockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.md)
+
+## HYTOPIA.BlockTypeRegistryEventPayload.RegisterBlockType interface
+
+**Signature:**
+
+```typescript
+interface RegisterBlockType 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[blockType](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[BlockType](./server.blocktype.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[blockTypeRegistry](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.blocktyperegistry.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[BlockTypeRegistry](./server.blocktyperegistry.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[id](./server.hytopia.blocktyperegistryeventpayload.registerblocktype.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.blocktyperegistryeventtype.md

@@ -0,0 +1,47 @@
+<!-- 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; [BlockTypeRegistryEventType](./server.hytopia.blocktyperegistryeventtype.md)
+
+## HYTOPIA.BlockTypeRegistryEventType enum
+
+Event types a BlockTypeRegistry instance can emit.
+
+**Signature:**
+
+```typescript
+export declare enum BlockTypeRegistryEventType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+REGISTER\_BLOCK\_TYPE
+
+
+</td><td>
+
+`"BLOCK_TYPE_REGISTRY.REGISTER_BLOCK_TYPE"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>