hytopia 0.1.29 → 0.1.31

package/README.md

@@ -1,7 +1,7 @@
 # HYTOPIA SDK
 
 ## Quick Links
-[Quickstart](#quickstart) • [Developer Docs](https://dev.hytopia.com/) • [API Reference](./docs/server.md) • [Examples](./examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
+[Quickstart (Start Here)](#quickstart-start-here) • [Developer Docs](https://dev.hytopia.com/) • [API Reference](./docs/server.md) • [Examples](./examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
 
 ## What is HYTOPIA?
 
@@ -28,32 +28,9 @@ Available as a simple NPM package, this SDK provides everything you need to get
 
 With these resources, you can quickly build and share immersive, voxel-style multiplayer games on HYTOPIA.
 
-## Quickstart
+## Quickstart (Start Here)
 
-1. Install a compatible JavaScript runtime. We recommend you use [Bun](https://bun.sh/), but [Node.js](https://nodejs.org/) and [Deno](https://deno.com/) can work with additional configuration. All examples will be given using Bun.
-
-2. Create a new project directory somewhere on your machine and navigate into it.
-```bash
-mkdir my-project-directory && cd my-project-directory
-```
-
-3. Initialize a hytopia project from boilerplate or an existing example. Sets up package.json and all dependencies, copies assets and an index.ts game script into your project.
-```bash
-# Option 1: Initialize a boilerplate project
-bunx hytopia init
-
-# Option 2: Initialize a project from any of the examples in the examples directory like so:
-bunx hytopia init --template payload-game
-```
-
-3. Start the server, use --watch for hot reloads as you make changes.
-```bash
-bun --watch index.ts
-```
-
-4. Visit https://play.hytopia.com - when prompted, enter `localhost:8080` - this is the hostname of the local server you started in the previous step.
-
-**Note: If you'd prefer to use JavaScript instead of TypeScript, simply change the file extension of index.ts to index.js - Your editor will highlight the TypeScript syntax errors, simple delete the type annotations and everything should work the same without any TypeScript usage.**
+**[Follow the Initial Setup guide, here](https://dev.hytopia.com/getting-started/initial-setup).**
 
 Once you're up and running, here's some other resources to go further:
 - [Developer Docs](https://dev.hytopia.com/)

package/bin/scripts.js

@@ -27,30 +27,37 @@ const path = require('path');
   if (command === 'init') {
     const destDir = process.cwd();
 
+    // Initialize project with latest HYTOPIA SDK
+    console.log('🔧 Initializing project with latest HYTOPIA SDK...');
+    execSync('bun init --yes');
+    execSync('bun add hytopia@latest');
+    
     if (flags.template) {
-      console.log(`🔧 Initializing project with examples template ${flags.template}`);
+      // Init from example template
+      console.log(`🖨️ Initializing project with examples template "${flags.template}"...`);
 
-      const templateDir = path.join(__dirname, '..', 'examples', flags.template);
+      const templateDir = path.join(destDir, 'node_modules', 'hytopia', 'examples', flags.template);
 
       if (!fs.existsSync(templateDir)) {
-        console.error(`Examples template ${flags.template} does not exist in the examples directory, could not initialize project!`);
+        console.error(`Examples template ${flags.template} does not exist in the examples directory, could not initialize project! Tried directory: ${templateDir}`);
         return;
       }
 
       fs.cpSync(templateDir, destDir, { recursive: true });
-      execSync('bun install');
     } else {
-      console.log('🔧 Initializing project');
-      execSync('bun init --yes');
-      execSync('bun add hytopia@latest');
-      
+      // Init from boilerplate
+      console.log('🧑‍💻 Initializing project with boilerplate...');
+
       const srcDir = path.join(__dirname, '..', 'boilerplate');
+      
       fs.cpSync(srcDir, destDir, { recursive: true });  
     }
 
     // Done, lfg!
+    console.log('--------------------------------');
     console.log('🚀 Hytopia project initialized successfully!');
     console.log('💡 Start your development server with `bun --watch index.ts`!');
+    console.log('🎮 After you start your development server, play by opening your browser and visiting: https://play.hytopia.com/?join=localhost:8080')
     return;
   }
   

package/docs/server.blocktype.md

@@ -183,7 +183,7 @@ The name of the block type.
 
 </td><td>
 
-(this: [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) =&gt; void
 
 
 </td><td>
@@ -202,7 +202,7 @@ _(Optional)_ A callback function that is invoked when an entity collides with bl
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.blocktype.onentitycollision.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity collides with blocks of this
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: BlockType, entity: Entity, started: boolean) => void;
+onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
 ```

package/docs/server.blocktype.onentitycontactforce.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity contacts a block of this type
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (blockType: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.defaultcharactercontroller.canjump.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can jump.
 **Signature:**
 
 ```typescript
-canJump: (this: DefaultCharacterController) => boolean;
+canJump: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.canrun.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can run.
 **Signature:**
 
 ```typescript
-canRun: (this: DefaultCharacterController) => boolean;
+canRun: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.canwalk.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can walk.
 **Signature:**
 
 ```typescript
-canWalk: (this: DefaultCharacterController) => boolean;
+canWalk: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.md

@@ -101,7 +101,7 @@ Description
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -120,7 +120,7 @@ A function allowing custom logic to determine if the entity can jump.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -139,7 +139,7 @@ A function allowing custom logic to determine if the entity can run.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>

package/docs/server.entity.createcustomcharactercontroller.md

@@ -4,10 +4,10 @@
 
 ## Entity.createCustomCharacterController property
 
-A function that creates a custom character controller for the entity.
+A function that creates a custom character controller for the entity when it spawns.
 
 **Signature:**
 
 ```typescript
-createCustomCharacterController?: (this: Entity) => BaseCharacterController;
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
 ```

package/docs/server.entity.md

@@ -133,12 +133,12 @@ The character controller for the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity.
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
 
 
 </td></tr>
@@ -278,7 +278,7 @@ The name of the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -297,7 +297,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -316,7 +316,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -335,7 +335,7 @@ _(Optional)_ A function that is called when the entity is despawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -354,7 +354,7 @@ _(Optional)_ A function that is called when the entity collides with another ent
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -373,7 +373,7 @@ _(Optional)_ A function that is called when the entity contacts another entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -392,7 +392,7 @@ _(Optional)_ A function that is called when the entity is spawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
 
 
 </td><td>

package/docs/server.entity.onblockcollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (this: Entity, block: BlockType, started: boolean) => void;
+onBlockCollision?: (entity: Entity, block: BlockType, started: boolean) => void;
 ```

package/docs/server.entity.onblockcontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockContactForce?: (this: Entity, block: BlockType, contactForceData: ContactForceData) => void;
+onBlockContactForce?: (entity: Entity, block: BlockType, contactForceData: ContactForceData) => void;
 ```

package/docs/server.entity.ondespawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is despawned.
 **Signature:**
 
 ```typescript
-onDespawn?: (this: Entity) => void;
+onDespawn?: (entity: Entity) => void;
 ```

package/docs/server.entity.onentitycollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with another entity.
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: Entity, entity: Entity, started: boolean) => void;
+onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
 ```

package/docs/server.entity.onentitycontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity contacts another entity.
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: Entity, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (entity: Entity, otherEntity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.entity.onspawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is spawned.
 **Signature:**
 
 ```typescript
-onSpawn?: (this: Entity) => void;
+onSpawn?: (entity: Entity) => void;
 ```

package/docs/server.entity.ontick.md

@@ -9,5 +9,5 @@ A function that is called every tick.
 **Signature:**
 
 ```typescript
-onTick?: (this: Entity, tickDeltaMs: number) => void;
+onTick?: (entity: Entity, tickDeltaMs: number) => void;
 ```

package/docs/server.entityoptions.createcustomcharactercontroller.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; [EntityOptions](./server.entityoptions.md) &gt; [createCustomCharacterController](./server.entityoptions.createcustomcharactercontroller.md)
+
+## EntityOptions.createCustomCharacterController property
+
+A function that creates a custom character controller for the entity when it spawns.
+
+**Signature:**
+
+```typescript
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
+```

package/docs/server.entityoptions.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[createCustomCharacterController?](./server.entityoptions.createcustomcharactercontroller.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+
+
+</td><td>
+
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+
+
+</td></tr>
+<tr><td>
+
 [modelLoopedAnimations?](./server.entityoptions.modelloopedanimations.md)
 
 

package/docs/server.hytopia.blocktype.md

@@ -183,7 +183,7 @@ The name of the block type.
 
 </td><td>
 
-(this: [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) =&gt; void
 
 
 </td><td>
@@ -202,7 +202,7 @@ _(Optional)_ A callback function that is invoked when an entity collides with bl
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.hytopia.blocktype.onentitycollision.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity collides with blocks of this
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: BlockType, entity: Entity, started: boolean) => void;
+onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
 ```

package/docs/server.hytopia.blocktype.onentitycontactforce.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity contacts a block of this type
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (blockType: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canjump.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can jump.
 **Signature:**
 
 ```typescript
-canJump: (this: DefaultCharacterController) => boolean;
+canJump: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canrun.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can run.
 **Signature:**
 
 ```typescript
-canRun: (this: DefaultCharacterController) => boolean;
+canRun: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canwalk.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can walk.
 **Signature:**
 
 ```typescript
-canWalk: (this: DefaultCharacterController) => boolean;
+canWalk: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.hytopia.defaultcharactercontroller.md

@@ -101,7 +101,7 @@ Description
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -120,7 +120,7 @@ A function allowing custom logic to determine if the entity can jump.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -139,7 +139,7 @@ A function allowing custom logic to determine if the entity can run.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>

package/docs/server.hytopia.entity.createcustomcharactercontroller.md

@@ -4,10 +4,10 @@
 
 ## HYTOPIA.Entity.createCustomCharacterController property
 
-A function that creates a custom character controller for the entity.
+A function that creates a custom character controller for the entity when it spawns.
 
 **Signature:**
 
 ```typescript
-createCustomCharacterController?: (this: Entity) => BaseCharacterController;
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
 ```

package/docs/server.hytopia.entity.md

@@ -133,12 +133,12 @@ The character controller for the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity.
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
 
 
 </td></tr>
@@ -278,7 +278,7 @@ The name of the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -297,7 +297,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -316,7 +316,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -335,7 +335,7 @@ _(Optional)_ A function that is called when the entity is despawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -354,7 +354,7 @@ _(Optional)_ A function that is called when the entity collides with another ent
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -373,7 +373,7 @@ _(Optional)_ A function that is called when the entity contacts another entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -392,7 +392,7 @@ _(Optional)_ A function that is called when the entity is spawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
 
 
 </td><td>

package/docs/server.hytopia.entity.onblockcollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (this: Entity, block: BlockType, started: boolean) => void;
+onBlockCollision?: (entity: Entity, block: BlockType, started: boolean) => void;
 ```

package/docs/server.hytopia.entity.onblockcontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockContactForce?: (this: Entity, block: BlockType, contactForceData: ContactForceData) => void;
+onBlockContactForce?: (entity: Entity, block: BlockType, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.entity.ondespawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is despawned.
 **Signature:**
 
 ```typescript
-onDespawn?: (this: Entity) => void;
+onDespawn?: (entity: Entity) => void;
 ```

package/docs/server.hytopia.entity.onentitycollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with another entity.
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: Entity, entity: Entity, started: boolean) => void;
+onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
 ```

package/docs/server.hytopia.entity.onentitycontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity contacts another entity.
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: Entity, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (entity: Entity, otherEntity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.entity.onspawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is spawned.
 **Signature:**
 
 ```typescript
-onSpawn?: (this: Entity) => void;
+onSpawn?: (entity: Entity) => void;
 ```

package/docs/server.hytopia.entity.ontick.md

@@ -9,5 +9,5 @@ A function that is called every tick.
 **Signature:**
 
 ```typescript
-onTick?: (this: Entity, tickDeltaMs: number) => void;
+onTick?: (entity: Entity, tickDeltaMs: number) => void;
 ```

package/docs/server.hytopia.entityoptions.createcustomcharactercontroller.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; [EntityOptions](./server.hytopia.entityoptions.md) &gt; [createCustomCharacterController](./server.hytopia.entityoptions.createcustomcharactercontroller.md)
+
+## HYTOPIA.EntityOptions.createCustomCharacterController property
+
+A function that creates a custom character controller for the entity when it spawns.
+
+**Signature:**
+
+```typescript
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
+```

package/docs/server.hytopia.entityoptions.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[createCustomCharacterController?](./server.hytopia.entityoptions.createcustomcharactercontroller.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+
+
+</td><td>
+
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+
+
+</td></tr>
+<tr><td>
+
 [modelLoopedAnimations?](./server.hytopia.entityoptions.modelloopedanimations.md)