hytopia 0.1.54 → 0.1.56

package/docs/server.defaultcharactercontroller.md

@@ -54,7 +54,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(entity, options)](./server.defaultcharactercontroller._constructor_.md)
+[(constructor)(options)](./server.defaultcharactercontroller._constructor_.md)
 
 
 </td><td>
@@ -290,7 +290,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[createColliders()](./server.defaultcharactercontroller.createcolliders.md)
+[attach(entity)](./server.defaultcharactercontroller.attach.md)
 
 
 </td><td>
@@ -298,13 +298,27 @@ Description
 
 </td><td>
 
-Creates the colliders for the character controller, overriding the default implementation.
+Called when the controller is attached to an entity.
 
 
 </td></tr>
 <tr><td>
 
-[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.defaultcharactercontroller.tickwithplayerinput.md)
+[spawn(entity)](./server.defaultcharactercontroller.spawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called when the controlled entity is spawned. In DefaultCharacterController, this function is used to create the colliders for the entity for wall and ground detection.
+
+
+</td></tr>
+<tr><td>
+
+[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.defaultcharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/server.defaultcharactercontroller.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [spawn](./server.defaultcharactercontroller.spawn.md)
+
+## DefaultCharacterController.spawn() method
+
+Called when the controlled entity is spawned. In DefaultCharacterController, this function is used to create the colliders for the entity for wall and ground detection.
+
+**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 that is spawned.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.defaultcharactercontroller.tickwithplayerinput.md

@@ -9,7 +9,7 @@ Ticks the player movement for the character controller, overriding the default i
 **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.entity.md

@@ -164,25 +164,6 @@ The URI or path to the texture to be used, if this is set, the entity is a block
 The character controller for the entity.
 
 
-</td></tr>
-<tr><td>
-
-[createCustomCharacterController?](./server.entity.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>
 

package/docs/server.entity.setcharactercontroller.md

@@ -9,7 +9,7 @@ Sets the character controller for the entity.
 **Signature:**
 
 ```typescript
-setCharacterController(characterController: BaseCharacterController): void;
+setCharacterController(characterController: BaseCharacterController | undefined): void;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ characterController
 
 </td><td>
 
-[BaseCharacterController](./server.basecharactercontroller.md)
+[BaseCharacterController](./server.basecharactercontroller.md) \| undefined
 
 
 </td><td>

package/docs/server.entityeventpayload.md

@@ -90,7 +90,7 @@ Description
 </td></tr>
 <tr><td>
 
-[UpdateRotation](./server.entityeventpayload.updaterotation.md)
+[UpdatePosition](./server.entityeventpayload.updateposition.md)
 
 
 </td><td>
@@ -99,7 +99,7 @@ Description
 </td></tr>
 <tr><td>
 
-[UpdateTranslation](./server.entityeventpayload.updatetranslation.md)
+[UpdateRotation](./server.entityeventpayload.updaterotation.md)
 
 
 </td><td>

package/docs/server.entityeventpayload.updateposition.entity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdatePosition](./server.entityeventpayload.updateposition.md) &gt; [entity](./server.entityeventpayload.updateposition.entity.md)
+
+## EntityEventPayload.UpdatePosition.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```

package/docs/{server.entityeventpayload.updatetranslation.md → server.entityeventpayload.updateposition.md}

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdateTranslation](./server.entityeventpayload.updatetranslation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdatePosition](./server.entityeventpayload.updateposition.md)
 
-## EntityEventPayload.UpdateTranslation interface
+## EntityEventPayload.UpdatePosition interface
 
 **Signature:**
 
 ```typescript
-interface UpdateTranslation 
+interface UpdatePosition 
 ```
 
 ## Properties
@@ -35,7 +35,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[entity](./server.entityeventpayload.updatetranslation.entity.md)
+[entity](./server.entityeventpayload.updateposition.entity.md)
 
 
 </td><td>
@@ -52,7 +52,7 @@ Description
 </td></tr>
 <tr><td>
 
-[translation](./server.entityeventpayload.updatetranslation.translation.md)
+[position](./server.entityeventpayload.updateposition.position.md)
 
 
 </td><td>

package/docs/server.entityeventpayload.updateposition.position.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdatePosition](./server.entityeventpayload.updateposition.md) &gt; [position](./server.entityeventpayload.updateposition.position.md)
+
+## EntityEventPayload.UpdatePosition.position property
+
+**Signature:**
+
+```typescript
+position: Vector3Like;
+```

package/docs/server.entityeventtype.md

@@ -130,12 +130,12 @@ STOP\_MODEL\_ANIMATIONS
 </td></tr>
 <tr><td>
 
-UPDATE\_ROTATION
+UPDATE\_POSITION
 
 
 </td><td>
 
-`"ENTITY.UPDATE_ROTATION"`
+`"ENTITY.UPDATE_POSITION"`
 
 
 </td><td>
@@ -144,12 +144,12 @@ UPDATE\_ROTATION
 </td></tr>
 <tr><td>
 
-UPDATE\_TRANSLATION
+UPDATE\_ROTATION
 
 
 </td><td>
 
-`"ENTITY.UPDATE_TRANSLATION"`
+`"ENTITY.UPDATE_ROTATION"`
 
 
 </td><td>

package/docs/server.entityoptions.charactercontroller.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; [characterController](./server.entityoptions.charactercontroller.md)
+
+## EntityOptions.characterController property
+
+The character controller to use for the entity.
+
+**Signature:**
+
+```typescript
+characterController?: BaseCharacterController;
+```

package/docs/server.entityoptions.md

@@ -75,7 +75,7 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 </td></tr>
 <tr><td>
 
-[createCustomCharacterController?](./server.entityoptions.createcustomcharactercontroller.md)
+[characterController?](./server.entityoptions.charactercontroller.md)
 
 
 </td><td>
@@ -83,12 +83,12 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+[BaseCharacterController](./server.basecharactercontroller.md)
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+_(Optional)_ The character controller to use for the entity.
 
 
 </td></tr>

package/docs/server.md

@@ -1031,7 +1031,7 @@ Options for the [SimpleCharacterController.face()](./server.simplecharactercontr
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
 
 
 </td></tr>

package/docs/server.movecallback.md

@@ -4,12 +4,12 @@
 
 ## MoveCallback type
 
-A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
 
 **Signature:**
 
 ```typescript
-export type MoveCallback = (currentTranslation: Vector3Like, targetTranslation: Vector3Like) => void;
+export type MoveCallback = (currentPosition: Vector3Like, targetPosition: Vector3Like) => void;
 ```
 **References:** [Vector3Like](./server.vector3like.md)
 

package/docs/server.movecompletecallback.md

@@ -9,7 +9,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 **Signature:**
 
 ```typescript
-export type MoveCompleteCallback = (endTranslation: Vector3Like) => void;
+export type MoveCompleteCallback = (endPosition: Vector3Like) => void;
 ```
 **References:** [Vector3Like](./server.vector3like.md)
 

package/docs/server.rigidbody.additionalmass.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; [RigidBody](./server.rigidbody.md) &gt; [additionalMass](./server.rigidbody.additionalmass.md)
+
+## RigidBody.additionalMass property
+
+The additional mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get additionalMass(): number;
+```

package/docs/server.rigidbody.additionalsolveriterations.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; [RigidBody](./server.rigidbody.md) &gt; [additionalSolverIterations](./server.rigidbody.additionalsolveriterations.md)
+
+## RigidBody.additionalSolverIterations property
+
+The additional solver iterations of the rigid body.
+
+**Signature:**
+
+```typescript
+get additionalSolverIterations(): number;
+```

package/docs/server.rigidbody.angulardamping.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; [RigidBody](./server.rigidbody.md) &gt; [angularDamping](./server.rigidbody.angulardamping.md)
+
+## RigidBody.angularDamping property
+
+The angular damping of the rigid body.
+
+**Signature:**
+
+```typescript
+get angularDamping(): number;
+```

package/docs/server.rigidbody.angularvelocity.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; [RigidBody](./server.rigidbody.md) &gt; [angularVelocity](./server.rigidbody.angularvelocity.md)
+
+## RigidBody.angularVelocity property
+
+The angular velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+get angularVelocity(): Vector3Like;
+```

package/docs/server.rigidbody.directionfromrotation.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; [RigidBody](./server.rigidbody.md) &gt; [directionFromRotation](./server.rigidbody.directionfromrotation.md)
+
+## RigidBody.directionFromRotation property
+
+The direction from the rotation of the rigid body.
+
+**Signature:**
+
+```typescript
+get directionFromRotation(): Vector3Like;
+```

package/docs/server.rigidbody.dominancegroup.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; [RigidBody](./server.rigidbody.md) &gt; [dominanceGroup](./server.rigidbody.dominancegroup.md)
+
+## RigidBody.dominanceGroup property
+
+The dominance group of the rigid body.
+
+**Signature:**
+
+```typescript
+get dominanceGroup(): number;
+```

package/docs/server.rigidbody.effectiveangularinertia.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveAngularInertia](./server.rigidbody.effectiveangularinertia.md)
+
+## RigidBody.effectiveAngularInertia property
+
+The effective angular inertia of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveAngularInertia(): SpdMatrix3 | undefined;
+```

package/docs/server.rigidbody.effectiveinversemass.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveInverseMass](./server.rigidbody.effectiveinversemass.md)
+
+## RigidBody.effectiveInverseMass property
+
+The effective inverse mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveInverseMass(): Vector3Like | undefined;
+```

package/docs/server.rigidbody.effectiveworldinverseprincipalangularinertiasqrt.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveWorldInversePrincipalAngularInertiaSqrt](./server.rigidbody.effectiveworldinverseprincipalangularinertiasqrt.md)
+
+## RigidBody.effectiveWorldInversePrincipalAngularInertiaSqrt property
+
+The effective world inverse principal angular inertia square root of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveWorldInversePrincipalAngularInertiaSqrt(): SpdMatrix3 | undefined;
+```

package/docs/server.rigidbody.enabledpositions.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; [RigidBody](./server.rigidbody.md) &gt; [enabledPositions](./server.rigidbody.enabledpositions.md)
+
+## RigidBody.enabledPositions property
+
+The enabled axes of positional movement of the rigid body.
+
+**Signature:**
+
+```typescript
+get enabledPositions(): Vector3Boolean;
+```

package/docs/server.rigidbody.enabledrotations.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; [RigidBody](./server.rigidbody.md) &gt; [enabledRotations](./server.rigidbody.enabledrotations.md)
+
+## RigidBody.enabledRotations property
+
+The enabled axes of rotational movement of the rigid body.
+
+**Signature:**
+
+```typescript
+get enabledRotations(): Vector3Boolean;
+```

package/docs/server.rigidbody.gravityscale.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; [RigidBody](./server.rigidbody.md) &gt; [gravityScale](./server.rigidbody.gravityscale.md)
+
+## RigidBody.gravityScale property
+
+The gravity scale of the rigid body.
+
+**Signature:**
+
+```typescript
+get gravityScale(): number;
+```

package/docs/server.rigidbody.inversemass.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; [RigidBody](./server.rigidbody.md) &gt; [inverseMass](./server.rigidbody.inversemass.md)
+
+## RigidBody.inverseMass property
+
+The inverse mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get inverseMass(): number | undefined;
+```

package/docs/server.rigidbody.inverseprincipalangularinertiasqrt.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; [RigidBody](./server.rigidbody.md) &gt; [inversePrincipalAngularInertiaSqrt](./server.rigidbody.inverseprincipalangularinertiasqrt.md)
+
+## RigidBody.inversePrincipalAngularInertiaSqrt property
+
+The inverse principal angular inertia square root of the rigid body.
+
+**Signature:**
+
+```typescript
+get inversePrincipalAngularInertiaSqrt(): Vector3Like | undefined;
+```

package/docs/server.rigidbody.lineardamping.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; [RigidBody](./server.rigidbody.md) &gt; [linearDamping](./server.rigidbody.lineardamping.md)
+
+## RigidBody.linearDamping property
+
+The linear damping of the rigid body.
+
+**Signature:**
+
+```typescript
+get linearDamping(): number;
+```

package/docs/server.rigidbody.linearvelocity.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; [RigidBody](./server.rigidbody.md) &gt; [linearVelocity](./server.rigidbody.linearvelocity.md)
+
+## RigidBody.linearVelocity property
+
+The linear velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+get linearVelocity(): Vector3Like;
+```

package/docs/server.rigidbody.localcenterofmass.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; [RigidBody](./server.rigidbody.md) &gt; [localCenterOfMass](./server.rigidbody.localcenterofmass.md)
+
+## RigidBody.localCenterOfMass property
+
+The local center of mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get localCenterOfMass(): Vector3Like;
+```

package/docs/server.rigidbody.lockallpositions.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; [RigidBody](./server.rigidbody.md) &gt; [lockAllPositions](./server.rigidbody.lockallpositions.md)
+
+## RigidBody.lockAllPositions() method
+
+Locks all positional movement of the rigid body.
+
+**Signature:**
+
+```typescript
+lockAllPositions(): void;
+```
+**Returns:**
+
+void
+

package/docs/{server.rigidbody.getmass.md → server.rigidbody.mass.md}

@@ -1,19 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getMass](./server.rigidbody.getmass.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [mass](./server.rigidbody.mass.md)
 
-## RigidBody.getMass() method
+## RigidBody.mass property
 
-Gets the mass of the rigid body.
+The mass of the rigid body.
 
 **Signature:**
 
 ```typescript
-getMass(): number;
+get mass(): number;
 ```
-**Returns:**
-
-number
-
-The mass of the rigid body.
-