hytopia 0.2.11 → 0.3.0-dev.2

package/docs/server.baseentitycontrollerevent.md

@@ -0,0 +1,117 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEvent](./server.baseentitycontrollerevent.md)
+
+## BaseEntityControllerEvent enum
+
+Event types a BaseEntityController instance can emit. See [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum BaseEntityControllerEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ATTACH
+
+
+</td><td>
+
+`"attach"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+DESPAWN
+
+
+</td><td>
+
+`"despawn"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+DETACH
+
+
+</td><td>
+
+`"detach"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SPAWN
+
+
+</td><td>
+
+`"spawn"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK
+
+
+</td><td>
+
+`"tick"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_WITH\_PLAYER\_INPUT
+
+
+</td><td>
+
+`"tickWithPlayerInput"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.baseentitycontrollereventpayloads.attach.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [attach](./server.baseentitycontrollereventpayloads.attach.md)
+
+## BaseEntityControllerEventPayloads.attach property
+
+Emitted when an entity is attached to the controller.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.ATTACH]: {
+        entity: Entity;
+    };
+```

package/docs/server.baseentitycontrollereventpayloads.despawn.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [despawn](./server.baseentitycontrollereventpayloads.despawn.md)
+
+## BaseEntityControllerEventPayloads.despawn property
+
+Emitted when an entity is despawned.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.DESPAWN]: {
+        entity: Entity;
+    };
+```

package/docs/server.baseentitycontrollereventpayloads.detach.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [detach](./server.baseentitycontrollereventpayloads.detach.md)
+
+## BaseEntityControllerEventPayloads.detach property
+
+Emitted when an entity is detached from the controller.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.DETACH]: {
+        entity: Entity;
+    };
+```

package/docs/server.baseentitycontrollereventpayloads.md

@@ -0,0 +1,152 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md)
+
+## BaseEntityControllerEventPayloads interface
+
+Event payloads for BaseEntityController emitted events.
+
+**Signature:**
+
+```typescript
+export interface BaseEntityControllerEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attach](./server.baseentitycontrollereventpayloads.attach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity is attached to the controller.
+
+
+</td></tr>
+<tr><td>
+
+[despawn](./server.baseentitycontrollereventpayloads.despawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity is despawned.
+
+
+</td></tr>
+<tr><td>
+
+[detach](./server.baseentitycontrollereventpayloads.detach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity is detached from the controller.
+
+
+</td></tr>
+<tr><td>
+
+[spawn](./server.baseentitycontrollereventpayloads.spawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity is spawned.
+
+
+</td></tr>
+<tr><td>
+
+[tick](./server.baseentitycontrollereventpayloads.tick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; deltaTimeMs: number; }
+
+
+</td><td>
+
+Emitted when an entity is ticked.
+
+
+</td></tr>
+<tr><td>
+
+[tickWithPlayerInput](./server.baseentitycontrollereventpayloads.tickwithplayerinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [PlayerEntity](./server.playerentity.md)<!-- -->; input: [PlayerInput](./server.playerinput.md)<!-- -->; cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->; deltaTimeMs: number; }
+
+
+</td><td>
+
+Emitted when an entity is ticked with player input.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.baseentitycontrollereventpayloads.spawn.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [spawn](./server.baseentitycontrollereventpayloads.spawn.md)
+
+## BaseEntityControllerEventPayloads.spawn property
+
+Emitted when an entity is spawned.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.SPAWN]: {
+        entity: Entity;
+    };
+```

package/docs/server.baseentitycontrollereventpayloads.tick.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [tick](./server.baseentitycontrollereventpayloads.tick.md)
+
+## BaseEntityControllerEventPayloads.tick property
+
+Emitted when an entity is ticked.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.TICK]: {
+        entity: Entity;
+        deltaTimeMs: number;
+    };
+```

package/docs/server.baseentitycontrollereventpayloads.tickwithplayerinput.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md) &gt; [tickWithPlayerInput](./server.baseentitycontrollereventpayloads.tickwithplayerinput.md)
+
+## BaseEntityControllerEventPayloads.tickWithPlayerInput property
+
+Emitted when an entity is ticked with player input.
+
+**Signature:**
+
+```typescript
+[BaseEntityControllerEvent.TICK_WITH_PLAYER_INPUT]: {
+        entity: PlayerEntity;
+        input: PlayerInput;
+        cameraOrientation: PlayerCameraOrientation;
+        deltaTimeMs: number;
+    };
+```

package/docs/server.blocktype.md

@@ -9,14 +9,20 @@ Represents a block type.
 **Signature:**
 
 ```typescript
-export default class BlockType implements protocol.Serializable 
+export default class BlockType extends EventRouter implements protocol.Serializable 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
+
 **Implements:** protocol.Serializable
 
 ## Remarks
 
 Block types are created directly as instances. They support a variety of configuration options through the [BlockTypeOptions](./server.blocktypeoptions.md) constructor argument. Block types are registered with a [BlockTypeRegistry](./server.blocktyperegistry.md) instance, allowing you to create custom blocks with unique visual representations and behaviors.
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)
+
 ## Example
 
 
@@ -193,44 +199,6 @@ string
 The name of the block type.
 
 
-</td></tr>
-<tr><td>
-
-[onEntityCollision?](./server.blocktype.onentitycollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-((blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void) \| ((blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
-
-
-</td><td>
-
-_(Optional)_ A callback function that is invoked when an entity collides with blocks of this type.
-
-
-</td></tr>
-<tr><td>
-
-[onEntityContactForce?](./server.blocktype.onentitycontactforce.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A callback function that is invoked when an entity contacts a block of this type.
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.blocktypeevent.md

@@ -0,0 +1,61 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeEvent](./server.blocktypeevent.md)
+
+## BlockTypeEvent enum
+
+Event types a BlockType instance can emit. See [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum BlockTypeEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ENTITY\_COLLISION
+
+
+</td><td>
+
+`"BLOCK_TYPE.ENTITY_COLLISION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITY\_CONTACT\_FORCE
+
+
+</td><td>
+
+`"BLOCK_TYPE.ENTITY_CONTACT_FORCE"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.blocktypeeventpayloads._block_type.entity_collision_.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; [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md) &gt; ["BLOCK\_TYPE.ENTITY\_COLLISION"](./server.blocktypeeventpayloads._block_type.entity_collision_.md)
+
+## BlockTypeEventPayloads."BLOCK\_TYPE.ENTITY\_COLLISION" property
+
+Emitted when an entity collides with a block type.
+
+**Signature:**
+
+```typescript
+[BlockTypeEvent.ENTITY_COLLISION]: {
+        blockType: BlockType;
+        entity: Entity;
+        started: boolean;
+        colliderHandleA: number;
+        colliderHandleB: number;
+    };
+```

package/docs/server.blocktypeeventpayloads._block_type.entity_contact_force_.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; [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md) &gt; ["BLOCK\_TYPE.ENTITY\_CONTACT\_FORCE"](./server.blocktypeeventpayloads._block_type.entity_contact_force_.md)
+
+## BlockTypeEventPayloads."BLOCK\_TYPE.ENTITY\_CONTACT\_FORCE" property
+
+Emitted when an entity's contact force is applied to a block type.
+
+**Signature:**
+
+```typescript
+[BlockTypeEvent.ENTITY_CONTACT_FORCE]: {
+        blockType: BlockType;
+        entity: Entity;
+        contactForceData: ContactForceData;
+    };
+```

package/docs/server.blocktypeeventpayloads.md

@@ -0,0 +1,76 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)
+
+## BlockTypeEventPayloads interface
+
+Event payloads for BlockType emitted events.
+
+**Signature:**
+
+```typescript
+export interface BlockTypeEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["BLOCK\_TYPE.ENTITY\_COLLISION"](./server.blocktypeeventpayloads._block_type.entity_collision_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ blockType: [BlockType](./server.blocktype.md)<!-- -->; entity: [Entity](./server.entity.md)<!-- -->; started: boolean; colliderHandleA: number; colliderHandleB: number; }
+
+
+</td><td>
+
+Emitted when an entity collides with a block type.
+
+
+</td></tr>
+<tr><td>
+
+["BLOCK\_TYPE.ENTITY\_CONTACT\_FORCE"](./server.blocktypeeventpayloads._block_type.entity_contact_force_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ blockType: [BlockType](./server.blocktype.md)<!-- -->; entity: [Entity](./server.entity.md)<!-- -->; contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity's contact force is applied to a block type.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.blocktyperegistry.md

@@ -9,14 +9,20 @@ Manages known block types in a world.
 **Signature:**
 
 ```typescript
-export default class BlockTypeRegistry implements protocol.Serializable 
+export default class BlockTypeRegistry extends EventRouter implements protocol.Serializable 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
+
 **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.
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)
+
 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

package/docs/{server.blocktyperegistryeventtype.md → server.blocktyperegistryevent.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeRegistryEventType](./server.blocktyperegistryeventtype.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeRegistryEvent](./server.blocktyperegistryevent.md)
 
-## BlockTypeRegistryEventType enum
+## BlockTypeRegistryEvent enum
 
-Event types a BlockTypeRegistry instance can emit.
+Event types a BlockTypeRegistry instance can emit. See [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md) for the payloads.
 
 **Signature:**
 
 ```typescript
-export declare enum BlockTypeRegistryEventType 
+export declare enum BlockTypeRegistryEvent 
 ```
 
 ## Enumeration Members

package/docs/server.blocktyperegistryeventpayloads._block_type_registry.register_block_type_.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; [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md) &gt; ["BLOCK\_TYPE\_REGISTRY.REGISTER\_BLOCK\_TYPE"](./server.blocktyperegistryeventpayloads._block_type_registry.register_block_type_.md)
+
+## BlockTypeRegistryEventPayloads."BLOCK\_TYPE\_REGISTRY.REGISTER\_BLOCK\_TYPE" property
+
+Emitted when a block type is registered.
+
+**Signature:**
+
+```typescript
+[BlockTypeRegistryEvent.REGISTER_BLOCK_TYPE]: {
+        blockTypeRegistry: BlockTypeRegistry;
+        id: number;
+        blockType: BlockType;
+    };
+```