hytopia 0.1.55 → 0.1.56

package/docs/server.basecharactercontroller.attach.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [attach](./server.basecharactercontroller.attach.md)
+
+## BaseCharacterController.attach() method
+
+Override this method to handle the attachment of an entity to your character controller.
+
+**Signature:**
+
+```typescript
+attach(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to attach the controller to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.basecharactercontroller.despawn.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [despawn](./server.basecharactercontroller.despawn.md)
+
+## BaseCharacterController.despawn() method
+
+Override this method to handle the despawn of an entity from your character controller.
+
+**Signature:**
+
+```typescript
+despawn(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to despawn.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.basecharactercontroller.detach.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [detach](./server.basecharactercontroller.detach.md)
+
+## BaseCharacterController.detach() method
+
+Override this method to handle the detachment of an entity from your character controller.
+
+**Signature:**
+
+```typescript
+detach(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to detach.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.basecharactercontroller.md

@@ -16,11 +16,11 @@ export default abstract class BaseCharacterController
 
 The BaseCharacterController should be extended by a more specific character controller that you or a plugin implements.
 
-## Constructors
+## Properties
 
 <table><thead><tr><th>
 
-Constructor
+Property
 
 
 </th><th>
@@ -28,6 +28,11 @@ Constructor
 Modifiers
 
 
+</th><th>
+
+Type
+
+
 </th><th>
 
 Description
@@ -36,61 +41,77 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(entity, \_options)](./server.basecharactercontroller._constructor_.md)
+[onAttach?](./server.basecharactercontroller.onattach.md)
+
+
+</td><td>
 
 
 </td><td>
 
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
+
 
 </td><td>
 
-Constructs a new instance of the `BaseCharacterController` class
+_(Optional)_ A function that is called when the controller is attached to an entity. Useful for implementing attach logic without writing a new character controller class.
 
 
 </td></tr>
-</tbody></table>
+<tr><td>
 
-## Properties
+[onDespawn?](./server.basecharactercontroller.ondespawn.md)
 
-<table><thead><tr><th>
 
-Property
+</td><td>
 
 
-</th><th>
+</td><td>
 
-Modifiers
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
-</th><th>
+</td><td>
 
-Type
+_(Optional)_ A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new character controller class.
 
 
-</th><th>
+</td></tr>
+<tr><td>
 
-Description
+[onDetach?](./server.basecharactercontroller.ondetach.md)
 
 
-</th></tr></thead>
-<tbody><tr><td>
+</td><td>
 
-[entity](./server.basecharactercontroller.entity.md)
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
 
-`readonly`
+_(Optional)_ A function that is called when the controller is detached from an entity. Useful for implementing detach logic without writing a new character controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onSpawn?](./server.basecharactercontroller.onspawn.md)
 
 
 </td><td>
 
-[Entity](./server.entity.md)
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
 
-The entity the controller is for.
+_(Optional)_ A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new character controller class.
 
 
 </td></tr>
@@ -104,12 +125,12 @@ The entity the controller is for.
 
 </td><td>
 
-(deltaTimeMs: number) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks.
+_(Optional)_ A function that is called every tick. Useful for implementing tick logic without writing a new character controller class.
 
 
 </td></tr>
@@ -123,12 +144,12 @@ _(Optional)_ A callback function for when the controller ticks.
 
 </td><td>
 
-(input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
+(entity: [PlayerEntity](./server.playerentity.md)<!-- -->, input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks player movement.
+_(Optional)_ A function that is called every tick with player input by a PlayerEntity with this controller attached. Useful for implementing tick logic without writing a new character controller class.
 
 
 </td></tr>
@@ -154,7 +175,49 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[createColliders()](./server.basecharactercontroller.createcolliders.md)
+[attach(entity)](./server.basecharactercontroller.attach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the attachment of an entity to your character controller.
+
+
+</td></tr>
+<tr><td>
+
+[despawn(entity)](./server.basecharactercontroller.despawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the despawn of an entity from your character controller.
+
+
+</td></tr>
+<tr><td>
+
+[detach(entity)](./server.basecharactercontroller.detach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the detachment of an entity from your character controller.
+
+
+</td></tr>
+<tr><td>
+
+[spawn(entity)](./server.basecharactercontroller.spawn.md)
 
 
 </td><td>
@@ -162,13 +225,13 @@ Description
 
 </td><td>
 
-Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
+Override this method to handle the spawning of an entity to your character controller.
 
 
 </td></tr>
 <tr><td>
 
-[tick(deltaTimeMs)](./server.basecharactercontroller.tick.md)
+[tick(entity, deltaTimeMs)](./server.basecharactercontroller.tick.md)
 
 
 </td><td>
@@ -182,7 +245,7 @@ Override this method to handle entity movements based on your character controll
 </td></tr>
 <tr><td>
 
-[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
+[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/server.basecharactercontroller.onattach.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onAttach](./server.basecharactercontroller.onattach.md)
+
+## BaseCharacterController.onAttach property
+
+A function that is called when the controller is attached to an entity. Useful for implementing attach logic without writing a new character controller class.
+
+**Signature:**
+
+```typescript
+onAttach?: (entity: Entity) => void;
+```

package/docs/server.basecharactercontroller.ondespawn.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onDespawn](./server.basecharactercontroller.ondespawn.md)
+
+## BaseCharacterController.onDespawn property
+
+A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new character controller class.
+
+**Signature:**
+
+```typescript
+onDespawn?: (entity: Entity) => void;
+```

package/docs/server.basecharactercontroller.ondetach.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onDetach](./server.basecharactercontroller.ondetach.md)
+
+## BaseCharacterController.onDetach property
+
+A function that is called when the controller is detached from an entity. Useful for implementing detach logic without writing a new character controller class.
+
+**Signature:**
+
+```typescript
+onDetach?: (entity: Entity) => void;
+```

package/docs/server.basecharactercontroller.onspawn.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onSpawn](./server.basecharactercontroller.onspawn.md)
+
+## BaseCharacterController.onSpawn property
+
+A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new character controller class.
+
+**Signature:**
+
+```typescript
+onSpawn?: (entity: Entity) => void;
+```

package/docs/server.basecharactercontroller.ontick.md

@@ -4,10 +4,10 @@
 
 ## BaseCharacterController.onTick property
 
-A callback function for when the controller ticks.
+A function that is called every tick. Useful for implementing tick logic without writing a new character controller class.
 
 **Signature:**
 
 ```typescript
-onTick?: (deltaTimeMs: number) => void;
+onTick?: (entity: Entity, deltaTimeMs: number) => void;
 ```

package/docs/server.basecharactercontroller.ontickwithplayerinput.md

@@ -4,10 +4,10 @@
 
 ## BaseCharacterController.onTickWithPlayerInput property
 
-A callback function for when the controller ticks player movement.
+A function that is called every tick with player input by a PlayerEntity with this controller attached. Useful for implementing tick logic without writing a new character controller class.
 
 **Signature:**
 
 ```typescript
-onTickWithPlayerInput?: (input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
+onTickWithPlayerInput?: (entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
 ```

package/docs/server.basecharactercontroller.spawn.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [spawn](./server.basecharactercontroller.spawn.md)
+
+## BaseCharacterController.spawn() method
+
+Override this method to handle the spawning of an entity to your character controller.
+
+**Signature:**
+
+```typescript
+spawn(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to spawn.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.basecharactercontroller.tick.md

@@ -9,7 +9,7 @@ Override this method to handle entity movements based on your character controll
 **Signature:**
 
 ```typescript
-tick(deltaTimeMs: number): void;
+tick(entity: Entity, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,6 +32,20 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 deltaTimeMs
 
 

package/docs/server.basecharactercontroller.tickwithplayerinput.md

@@ -9,7 +9,7 @@ Override this method to handle entity movements based on player input for your c
 **Signature:**
 
 ```typescript
-tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
+tickWithPlayerInput(entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,6 +32,22 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+entity
+
+
+</td><td>
+
+[PlayerEntity](./server.playerentity.md)
+
+
+</td><td>
+
+The entity to tick.
+
+
+</td></tr>
+<tr><td>
+
 input
 
 

package/docs/server.defaultcharactercontroller._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultCharacterController` class
 **Signature:**
 
 ```typescript
-constructor(entity: Entity, options?: DefaultCharacterControllerOptions);
+constructor(options?: DefaultCharacterControllerOptions);
 ```
 
 ## Parameters
@@ -32,22 +32,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-entity
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-The entity the controller is for.
-
-
-</td></tr>
-<tr><td>
-
 options
 
 

package/docs/server.defaultcharactercontroller.attach.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [attach](./server.defaultcharactercontroller.attach.md)
+
+## DefaultCharacterController.attach() method
+
+Called when the controller is attached to an entity.
+
+**Signature:**
+
+```typescript
+attach(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to attach the controller to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+