hytopia 0.2.11 → 0.3.0-dev.2

package/docs/server.blocktyperegistryeventpayloads.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)
+
+## BlockTypeRegistryEventPayloads interface
+
+Event payloads for BlockTypeRegistry emitted events.
+
+**Signature:**
+
+```typescript
+export interface BlockTypeRegistryEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["BLOCK\_TYPE\_REGISTRY.REGISTER\_BLOCK\_TYPE"](./server.blocktyperegistryeventpayloads._block_type_registry.register_block_type_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ blockTypeRegistry: [BlockTypeRegistry](./server.blocktyperegistry.md)<!-- -->; id: number; blockType: [BlockType](./server.blocktype.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a block type is registered.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.chatevent.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; [ChatEvent](./server.chatevent.md)
+
+## ChatEvent enum
+
+Event types a ChatManager instance can emit. See [ChatEventPayloads](./server.chateventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum ChatEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+BROADCAST\_MESSAGE
+
+
+</td><td>
+
+`"CHAT.BROADCAST_MESSAGE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PLAYER\_MESSAGE
+
+
+</td><td>
+
+`"CHAT.PLAYER_MESSAGE"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.chateventpayloads._chat.broadcast_message_.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; [ChatEventPayloads](./server.chateventpayloads.md) &gt; ["CHAT.BROADCAST\_MESSAGE"](./server.chateventpayloads._chat.broadcast_message_.md)
+
+## ChatEventPayloads."CHAT.BROADCAST\_MESSAGE" property
+
+Emitted when a broadcast message is sent.
+
+**Signature:**
+
+```typescript
+[ChatEvent.BROADCAST_MESSAGE]: {
+        player: Player | undefined;
+        message: string;
+        color?: string;
+    };
+```

package/docs/server.chateventpayloads._chat.player_message_.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; [ChatEventPayloads](./server.chateventpayloads.md) &gt; ["CHAT.PLAYER\_MESSAGE"](./server.chateventpayloads._chat.player_message_.md)
+
+## ChatEventPayloads."CHAT.PLAYER\_MESSAGE" property
+
+Emitted when a message is sent to a specific player.
+
+**Signature:**
+
+```typescript
+[ChatEvent.PLAYER_MESSAGE]: {
+        player: Player;
+        message: string;
+        color?: string;
+    };
+```

package/docs/server.chateventpayloads.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; [ChatEventPayloads](./server.chateventpayloads.md)
+
+## ChatEventPayloads interface
+
+Event payloads for ChatManager emitted events.
+
+**Signature:**
+
+```typescript
+export interface ChatEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["CHAT.BROADCAST\_MESSAGE"](./server.chateventpayloads._chat.broadcast_message_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md) \| undefined; message: string; color?: string; }
+
+
+</td><td>
+
+Emitted when a broadcast message is sent.
+
+
+</td></tr>
+<tr><td>
+
+["CHAT.PLAYER\_MESSAGE"](./server.chateventpayloads._chat.player_message_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md)<!-- -->; message: string; color?: string; }
+
+
+</td><td>
+
+Emitted when a message is sent to a specific player.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.chatmanager.md

@@ -9,13 +9,18 @@ Manages chat and commands in a world.
 **Signature:**
 
 ```typescript
-export default class ChatManager 
+export default class ChatManager extends EventRouter 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
 
 ## Remarks
 
 The ChatManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. The ChatManager allows you to broadcast messages, send messages to specific players, and register commands that can be used in chat to execute game logic.
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [ChatEventPayloads](./server.chateventpayloads.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 `ChatManager` class.
 
 ## Example
@@ -35,50 +40,6 @@ world.chatManager.registerCommand('/kick', (player, args, message) => {
 });
 ```
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[onBroadcastMessage?](./server.chatmanager.onbroadcastmessage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(player: [Player](./server.player.md) \| undefined, message: string, color?: string) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when a broadcast (public) message is sent by a player or the server.
-
-
-</td></tr>
-</tbody></table>
-
 ## Methods
 
 <table><thead><tr><th>

package/docs/server.chunk.md

@@ -9,8 +9,10 @@ A 16^3 chunk of blocks. Used to represent a world's terrain.
 **Signature:**
 
 ```typescript
-export default class Chunk implements protocol.Serializable 
+export default class Chunk extends EventRouter implements protocol.Serializable 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
+
 **Implements:** protocol.Serializable
 
 ## Remarks
@@ -21,6 +23,10 @@ The Chunk follows a spawn and despawn lifecycle pattern. When you create a chunk
 
 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
 
 

package/docs/{server.chunkeventtype.md → server.chunkevent.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; [ChunkEventType](./server.chunkeventtype.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkEvent](./server.chunkevent.md)
 
-## ChunkEventType enum
+## ChunkEvent enum
 
-Event types a Chunk instance can emit.
+Event types a Chunk instance can emit. See [ChunkEventPayloads](./server.chunkeventpayloads.md) for the payloads.
 
 **Signature:**
 
 ```typescript
-export declare enum ChunkEventType 
+export declare enum ChunkEvent 
 ```
 
 ## Enumeration Members

package/docs/server.chunkeventpayloads._chunk.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; [ChunkEventPayloads](./server.chunkeventpayloads.md) &gt; ["CHUNK.DESPAWN"](./server.chunkeventpayloads._chunk.despawn_.md)
+
+## ChunkEventPayloads."CHUNK.DESPAWN" property
+
+Emitted when a chunk is despawned.
+
+**Signature:**
+
+```typescript
+[ChunkEvent.DESPAWN]: {
+        chunk: Chunk;
+    };
+```

package/docs/server.chunkeventpayloads._chunk.set_block_.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; [ChunkEventPayloads](./server.chunkeventpayloads.md) &gt; ["CHUNK.SET\_BLOCK"](./server.chunkeventpayloads._chunk.set_block_.md)
+
+## ChunkEventPayloads."CHUNK.SET\_BLOCK" property
+
+Emitted when a block is set in a chunk.
+
+**Signature:**
+
+```typescript
+[ChunkEvent.SET_BLOCK]: {
+        chunk: Chunk;
+        globalCoordinate: Vector3Like;
+        localCoordinate: Vector3Like;
+        blockTypeId: number;
+    };
+```

package/docs/server.chunkeventpayloads._chunk.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; [ChunkEventPayloads](./server.chunkeventpayloads.md) &gt; ["CHUNK.SPAWN"](./server.chunkeventpayloads._chunk.spawn_.md)
+
+## ChunkEventPayloads."CHUNK.SPAWN" property
+
+Emitted when a chunk is spawned.
+
+**Signature:**
+
+```typescript
+[ChunkEvent.SPAWN]: {
+        chunk: Chunk;
+    };
+```

package/docs/server.chunkeventpayloads.md

@@ -0,0 +1,95 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkEventPayloads](./server.chunkeventpayloads.md)
+
+## ChunkEventPayloads interface
+
+Event payloads for Chunk emitted events.
+
+**Signature:**
+
+```typescript
+export interface ChunkEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["CHUNK.DESPAWN"](./server.chunkeventpayloads._chunk.despawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ chunk: [Chunk](./server.chunk.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a chunk is despawned.
+
+
+</td></tr>
+<tr><td>
+
+["CHUNK.SET\_BLOCK"](./server.chunkeventpayloads._chunk.set_block_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ chunk: [Chunk](./server.chunk.md)<!-- -->; globalCoordinate: [Vector3Like](./server.vector3like.md)<!-- -->; localCoordinate: [Vector3Like](./server.vector3like.md)<!-- -->; blockTypeId: number; }
+
+
+</td><td>
+
+Emitted when a block is set in a chunk.
+
+
+</td></tr>
+<tr><td>
+
+["CHUNK.SPAWN"](./server.chunkeventpayloads._chunk.spawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ chunk: [Chunk](./server.chunk.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a chunk is spawned.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.collider.md

@@ -9,8 +9,9 @@ Represents a collider in a world's physics simulation.
 **Signature:**
 
 ```typescript
-export default class Collider 
+export default class Collider extends EventRouter 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
 
 ## Remarks
 

package/docs/server.entity.md

@@ -19,6 +19,10 @@ export default class Entity extends RigidBody implements protocol.Serializable
 
 Entities are highly configurable and controllable. All entities are created from a .gltf model asset and allow full control of their rigid body and attached collider dynamics.
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [EntityEventPayloads](./server.entityeventpayloads.md)
+
 ## Example
 
 
@@ -395,139 +399,6 @@ string
 The name of the entity.
 
 
-</td></tr>
-<tr><td>
-
-[onBlockCollision?](./server.entity.onblockcollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with a block.
-
-
-</td></tr>
-<tr><td>
-
-[onBlockContactForce?](./server.entity.onblockcontactforce.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with a block.
-
-
-</td></tr>
-<tr><td>
-
-[onDespawn?](./server.entity.ondespawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity is despawned.
-
-
-</td></tr>
-<tr><td>
-
-[onEntityCollision?](./server.entity.onentitycollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with another entity.
-
-
-</td></tr>
-<tr><td>
-
-[onEntityContactForce?](./server.entity.onentitycontactforce.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity contacts another entity.
-
-
-</td></tr>
-<tr><td>
-
-[onSpawn?](./server.entity.onspawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity is spawned.
-
-
-</td></tr>
-<tr><td>
-
-[onTick?](./server.entity.ontick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called every tick.
-
-
 </td></tr>
 <tr><td>