hytopia 0.1.27 → 0.1.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/server.basecharactercontroller.md +5 -5
- package/docs/server.basecharactercontroller.ontick.md +13 -0
- package/docs/server.basecharactercontroller.tick.md +53 -0
- package/docs/server.defaultcharactercontroller.md +0 -14
- package/docs/server.facecallback.md +15 -0
- package/docs/server.facecompletecallback.md +15 -0
- package/docs/server.faceoptions.md +18 -0
- package/docs/server.hytopia.basecharactercontroller.md +5 -5
- package/docs/server.hytopia.basecharactercontroller.ontick.md +13 -0
- package/docs/server.hytopia.basecharactercontroller.tick.md +53 -0
- package/docs/server.hytopia.defaultcharactercontroller.md +0 -14
- package/docs/server.hytopia.facecallback.md +15 -0
- package/docs/server.hytopia.facecompletecallback.md +15 -0
- package/docs/server.hytopia.faceoptions.md +18 -0
- package/docs/server.hytopia.md +77 -0
- package/docs/server.hytopia.movecallback.md +15 -0
- package/docs/server.hytopia.movecompletecallback.md +15 -0
- package/docs/server.hytopia.moveoptions.md +18 -0
- package/docs/server.hytopia.simplecharactercontroller.face.md +89 -0
- package/docs/server.hytopia.simplecharactercontroller.md +88 -0
- package/docs/server.hytopia.simplecharactercontroller.move.md +89 -0
- package/docs/server.md +77 -0
- package/docs/server.movecallback.md +15 -0
- package/docs/server.movecompletecallback.md +15 -0
- package/docs/server.moveoptions.md +18 -0
- package/docs/server.simplecharactercontroller.face.md +89 -0
- package/docs/server.simplecharactercontroller.md +88 -0
- package/docs/server.simplecharactercontroller.move.md +89 -0
- package/package.json +1 -1
- package/server.api.json +965 -263
- package/server.d.ts +141 -19
- package/server.js +57 -57
- package/docs/server.basecharactercontroller.ontickpathfindingmovement.md +0 -13
- package/docs/server.basecharactercontroller.tickpathfindingmovement.md +0 -69
- package/docs/server.defaultcharactercontroller.tickpathfindingmovement.md +0 -69
- package/docs/server.hytopia.basecharactercontroller.ontickpathfindingmovement.md +0 -13
- package/docs/server.hytopia.basecharactercontroller.tickpathfindingmovement.md +0 -69
- package/docs/server.hytopia.defaultcharactercontroller.tickpathfindingmovement.md +0 -69
| @@ -1,13 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [BaseCharacterController](./server.basecharactercontroller.md) > [onTickPathfindingMovement](./server.basecharactercontroller.ontickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## BaseCharacterController.onTickPathfindingMovement property
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            A callback function for when the controller ticks pathfinding movement.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            onTickPathfindingMovement?: (destination: Vector3, deltaTimeMs: number) => void;
         | 
| 13 | 
            -
            ```
         | 
| @@ -1,69 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [BaseCharacterController](./server.basecharactercontroller.md) > [tickPathfindingMovement](./server.basecharactercontroller.tickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## BaseCharacterController.tickPathfindingMovement() method
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            Override this method to implement pathfinding movement logic for your character controller. NOTE: This method is not fully supported yet.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            tickPathfindingMovement(destination: Vector3, deltaTimeMs: number): void;
         | 
| 13 | 
            -
            ```
         | 
| 14 | 
            -
             | 
| 15 | 
            -
            ## Parameters
         | 
| 16 | 
            -
             | 
| 17 | 
            -
            <table><thead><tr><th>
         | 
| 18 | 
            -
             | 
| 19 | 
            -
            Parameter
         | 
| 20 | 
            -
             | 
| 21 | 
            -
             | 
| 22 | 
            -
            </th><th>
         | 
| 23 | 
            -
             | 
| 24 | 
            -
            Type
         | 
| 25 | 
            -
             | 
| 26 | 
            -
             | 
| 27 | 
            -
            </th><th>
         | 
| 28 | 
            -
             | 
| 29 | 
            -
            Description
         | 
| 30 | 
            -
             | 
| 31 | 
            -
             | 
| 32 | 
            -
            </th></tr></thead>
         | 
| 33 | 
            -
            <tbody><tr><td>
         | 
| 34 | 
            -
             | 
| 35 | 
            -
            destination
         | 
| 36 | 
            -
             | 
| 37 | 
            -
             | 
| 38 | 
            -
            </td><td>
         | 
| 39 | 
            -
             | 
| 40 | 
            -
            [Vector3](./server.vector3.md)
         | 
| 41 | 
            -
             | 
| 42 | 
            -
             | 
| 43 | 
            -
            </td><td>
         | 
| 44 | 
            -
             | 
| 45 | 
            -
            The destination target to move to.
         | 
| 46 | 
            -
             | 
| 47 | 
            -
             | 
| 48 | 
            -
            </td></tr>
         | 
| 49 | 
            -
            <tr><td>
         | 
| 50 | 
            -
             | 
| 51 | 
            -
            deltaTimeMs
         | 
| 52 | 
            -
             | 
| 53 | 
            -
             | 
| 54 | 
            -
            </td><td>
         | 
| 55 | 
            -
             | 
| 56 | 
            -
            number
         | 
| 57 | 
            -
             | 
| 58 | 
            -
             | 
| 59 | 
            -
            </td><td>
         | 
| 60 | 
            -
             | 
| 61 | 
            -
            The delta time in milliseconds since the last tick.
         | 
| 62 | 
            -
             | 
| 63 | 
            -
             | 
| 64 | 
            -
            </td></tr>
         | 
| 65 | 
            -
            </tbody></table>
         | 
| 66 | 
            -
            **Returns:**
         | 
| 67 | 
            -
             | 
| 68 | 
            -
            void
         | 
| 69 | 
            -
             | 
| @@ -1,69 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [DefaultCharacterController](./server.defaultcharactercontroller.md) > [tickPathfindingMovement](./server.defaultcharactercontroller.tickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## DefaultCharacterController.tickPathfindingMovement() method
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            Ticks the pathfinding movement for the character controller, overriding the default implementation.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            tickPathfindingMovement(destination: Vector3, deltaTimeMs: number): void;
         | 
| 13 | 
            -
            ```
         | 
| 14 | 
            -
             | 
| 15 | 
            -
            ## Parameters
         | 
| 16 | 
            -
             | 
| 17 | 
            -
            <table><thead><tr><th>
         | 
| 18 | 
            -
             | 
| 19 | 
            -
            Parameter
         | 
| 20 | 
            -
             | 
| 21 | 
            -
             | 
| 22 | 
            -
            </th><th>
         | 
| 23 | 
            -
             | 
| 24 | 
            -
            Type
         | 
| 25 | 
            -
             | 
| 26 | 
            -
             | 
| 27 | 
            -
            </th><th>
         | 
| 28 | 
            -
             | 
| 29 | 
            -
            Description
         | 
| 30 | 
            -
             | 
| 31 | 
            -
             | 
| 32 | 
            -
            </th></tr></thead>
         | 
| 33 | 
            -
            <tbody><tr><td>
         | 
| 34 | 
            -
             | 
| 35 | 
            -
            destination
         | 
| 36 | 
            -
             | 
| 37 | 
            -
             | 
| 38 | 
            -
            </td><td>
         | 
| 39 | 
            -
             | 
| 40 | 
            -
            [Vector3](./server.vector3.md)
         | 
| 41 | 
            -
             | 
| 42 | 
            -
             | 
| 43 | 
            -
            </td><td>
         | 
| 44 | 
            -
             | 
| 45 | 
            -
            The destination to move to.
         | 
| 46 | 
            -
             | 
| 47 | 
            -
             | 
| 48 | 
            -
            </td></tr>
         | 
| 49 | 
            -
            <tr><td>
         | 
| 50 | 
            -
             | 
| 51 | 
            -
            deltaTimeMs
         | 
| 52 | 
            -
             | 
| 53 | 
            -
             | 
| 54 | 
            -
            </td><td>
         | 
| 55 | 
            -
             | 
| 56 | 
            -
            number
         | 
| 57 | 
            -
             | 
| 58 | 
            -
             | 
| 59 | 
            -
            </td><td>
         | 
| 60 | 
            -
             | 
| 61 | 
            -
            The delta time in milliseconds since the last tick.
         | 
| 62 | 
            -
             | 
| 63 | 
            -
             | 
| 64 | 
            -
            </td></tr>
         | 
| 65 | 
            -
            </tbody></table>
         | 
| 66 | 
            -
            **Returns:**
         | 
| 67 | 
            -
             | 
| 68 | 
            -
            void
         | 
| 69 | 
            -
             | 
| @@ -1,13 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [HYTOPIA](./server.hytopia.md) > [BaseCharacterController](./server.hytopia.basecharactercontroller.md) > [onTickPathfindingMovement](./server.hytopia.basecharactercontroller.ontickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## HYTOPIA.BaseCharacterController.onTickPathfindingMovement property
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            A callback function for when the controller ticks pathfinding movement.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            onTickPathfindingMovement?: (destination: Vector3, deltaTimeMs: number) => void;
         | 
| 13 | 
            -
            ```
         | 
| @@ -1,69 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [HYTOPIA](./server.hytopia.md) > [BaseCharacterController](./server.hytopia.basecharactercontroller.md) > [tickPathfindingMovement](./server.hytopia.basecharactercontroller.tickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## HYTOPIA.BaseCharacterController.tickPathfindingMovement() method
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            Override this method to implement pathfinding movement logic for your character controller. NOTE: This method is not fully supported yet.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            tickPathfindingMovement(destination: Vector3, deltaTimeMs: number): void;
         | 
| 13 | 
            -
            ```
         | 
| 14 | 
            -
             | 
| 15 | 
            -
            ## Parameters
         | 
| 16 | 
            -
             | 
| 17 | 
            -
            <table><thead><tr><th>
         | 
| 18 | 
            -
             | 
| 19 | 
            -
            Parameter
         | 
| 20 | 
            -
             | 
| 21 | 
            -
             | 
| 22 | 
            -
            </th><th>
         | 
| 23 | 
            -
             | 
| 24 | 
            -
            Type
         | 
| 25 | 
            -
             | 
| 26 | 
            -
             | 
| 27 | 
            -
            </th><th>
         | 
| 28 | 
            -
             | 
| 29 | 
            -
            Description
         | 
| 30 | 
            -
             | 
| 31 | 
            -
             | 
| 32 | 
            -
            </th></tr></thead>
         | 
| 33 | 
            -
            <tbody><tr><td>
         | 
| 34 | 
            -
             | 
| 35 | 
            -
            destination
         | 
| 36 | 
            -
             | 
| 37 | 
            -
             | 
| 38 | 
            -
            </td><td>
         | 
| 39 | 
            -
             | 
| 40 | 
            -
            [Vector3](./server.vector3.md)
         | 
| 41 | 
            -
             | 
| 42 | 
            -
             | 
| 43 | 
            -
            </td><td>
         | 
| 44 | 
            -
             | 
| 45 | 
            -
            The destination target to move to.
         | 
| 46 | 
            -
             | 
| 47 | 
            -
             | 
| 48 | 
            -
            </td></tr>
         | 
| 49 | 
            -
            <tr><td>
         | 
| 50 | 
            -
             | 
| 51 | 
            -
            deltaTimeMs
         | 
| 52 | 
            -
             | 
| 53 | 
            -
             | 
| 54 | 
            -
            </td><td>
         | 
| 55 | 
            -
             | 
| 56 | 
            -
            number
         | 
| 57 | 
            -
             | 
| 58 | 
            -
             | 
| 59 | 
            -
            </td><td>
         | 
| 60 | 
            -
             | 
| 61 | 
            -
            The delta time in milliseconds since the last tick.
         | 
| 62 | 
            -
             | 
| 63 | 
            -
             | 
| 64 | 
            -
            </td></tr>
         | 
| 65 | 
            -
            </tbody></table>
         | 
| 66 | 
            -
            **Returns:**
         | 
| 67 | 
            -
             | 
| 68 | 
            -
            void
         | 
| 69 | 
            -
             | 
| @@ -1,69 +0,0 @@ | |
| 1 | 
            -
            <!-- Do not edit this file. It is automatically generated by API Documenter. -->
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            [Home](./index.md) > [server](./server.md) > [HYTOPIA](./server.hytopia.md) > [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) > [tickPathfindingMovement](./server.hytopia.defaultcharactercontroller.tickpathfindingmovement.md)
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            ## HYTOPIA.DefaultCharacterController.tickPathfindingMovement() method
         | 
| 6 | 
            -
             | 
| 7 | 
            -
            Ticks the pathfinding movement for the character controller, overriding the default implementation.
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            **Signature:**
         | 
| 10 | 
            -
             | 
| 11 | 
            -
            ```typescript
         | 
| 12 | 
            -
            tickPathfindingMovement(destination: Vector3, deltaTimeMs: number): void;
         | 
| 13 | 
            -
            ```
         | 
| 14 | 
            -
             | 
| 15 | 
            -
            ## Parameters
         | 
| 16 | 
            -
             | 
| 17 | 
            -
            <table><thead><tr><th>
         | 
| 18 | 
            -
             | 
| 19 | 
            -
            Parameter
         | 
| 20 | 
            -
             | 
| 21 | 
            -
             | 
| 22 | 
            -
            </th><th>
         | 
| 23 | 
            -
             | 
| 24 | 
            -
            Type
         | 
| 25 | 
            -
             | 
| 26 | 
            -
             | 
| 27 | 
            -
            </th><th>
         | 
| 28 | 
            -
             | 
| 29 | 
            -
            Description
         | 
| 30 | 
            -
             | 
| 31 | 
            -
             | 
| 32 | 
            -
            </th></tr></thead>
         | 
| 33 | 
            -
            <tbody><tr><td>
         | 
| 34 | 
            -
             | 
| 35 | 
            -
            destination
         | 
| 36 | 
            -
             | 
| 37 | 
            -
             | 
| 38 | 
            -
            </td><td>
         | 
| 39 | 
            -
             | 
| 40 | 
            -
            [Vector3](./server.vector3.md)
         | 
| 41 | 
            -
             | 
| 42 | 
            -
             | 
| 43 | 
            -
            </td><td>
         | 
| 44 | 
            -
             | 
| 45 | 
            -
            The destination to move to.
         | 
| 46 | 
            -
             | 
| 47 | 
            -
             | 
| 48 | 
            -
            </td></tr>
         | 
| 49 | 
            -
            <tr><td>
         | 
| 50 | 
            -
             | 
| 51 | 
            -
            deltaTimeMs
         | 
| 52 | 
            -
             | 
| 53 | 
            -
             | 
| 54 | 
            -
            </td><td>
         | 
| 55 | 
            -
             | 
| 56 | 
            -
            number
         | 
| 57 | 
            -
             | 
| 58 | 
            -
             | 
| 59 | 
            -
            </td><td>
         | 
| 60 | 
            -
             | 
| 61 | 
            -
            The delta time in milliseconds since the last tick.
         | 
| 62 | 
            -
             | 
| 63 | 
            -
             | 
| 64 | 
            -
            </td></tr>
         | 
| 65 | 
            -
            </tbody></table>
         | 
| 66 | 
            -
            **Returns:**
         | 
| 67 | 
            -
             | 
| 68 | 
            -
            void
         | 
| 69 | 
            -
             |