hytopia 0.1.36 → 0.1.37

package/docs/server.hytopia.vector3.rotatey.md

@@ -0,0 +1,71 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [rotateY](./server.hytopia.vector3.rotatey.md)
+
+## HYTOPIA.Vector3.rotateY() method
+
+Rotates the vector around the y-axis.
+
+**Signature:**
+
+```typescript
+rotateY(vector3: Vector3, angle: number): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector3
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The origin vector to rotate around.
+
+
+</td></tr>
+<tr><td>
+
+angle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The angle to rotate the vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+

package/docs/server.hytopia.vector3.rotatez.md

@@ -0,0 +1,71 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [rotateZ](./server.hytopia.vector3.rotatez.md)
+
+## HYTOPIA.Vector3.rotateZ() method
+
+Rotates the vector around the z-axis.
+
+**Signature:**
+
+```typescript
+rotateZ(vector3: Vector3, angle: number): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector3
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The origin vector to rotate around.
+
+
+</td></tr>
+<tr><td>
+
+angle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The angle to rotate the vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+

package/docs/server.hytopia.vector3.round.md

@@ -0,0 +1,19 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [round](./server.hytopia.vector3.round.md)
+
+## HYTOPIA.Vector3.round() method
+
+Rounds each component of the vector to the nearest integer.
+
+**Signature:**
+
+```typescript
+round(): Vector3;
+```
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+

package/docs/server.hytopia.vector3.scale.md

@@ -0,0 +1,55 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [scale](./server.hytopia.vector3.scale.md)
+
+## HYTOPIA.Vector3.scale() method
+
+Scales each component of the vector by a scalar value.
+
+**Signature:**
+
+```typescript
+scale(scale: number): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scale
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The scalar value to scale the vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+

package/docs/server.hytopia.vector3.squaredmagnitude.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; [Vector3](./server.hytopia.vector3.md) &gt; [squaredMagnitude](./server.hytopia.vector3.squaredmagnitude.md)
+
+## HYTOPIA.Vector3.squaredMagnitude property
+
+The squared magnitude of the vector. Also known as the squared length.
+
+**Signature:**
+
+```typescript
+get squaredMagnitude(): number;
+```

package/docs/server.hytopia.vector3.subtract.md

@@ -0,0 +1,55 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [subtract](./server.hytopia.vector3.subtract.md)
+
+## HYTOPIA.Vector3.subtract() method
+
+Subtracts a vector from the current vector.
+
+**Signature:**
+
+```typescript
+subtract(vector3: Vector3): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector3
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The vector to subtract from the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+

package/docs/server.hytopia.vector3.tostring.md

@@ -0,0 +1,19 @@
+<!-- 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; [Vector3](./server.hytopia.vector3.md) &gt; [toString](./server.hytopia.vector3.tostring.md)
+
+## HYTOPIA.Vector3.toString() method
+
+Returns a string representation of the vector in x,y,z format.
+
+**Signature:**
+
+```typescript
+toString(): string;
+```
+**Returns:**
+
+string
+
+A string representation of the vector in the format x,y,z.
+

package/docs/server.hytopia.vector3.x.md

@@ -4,8 +4,12 @@
 
 ## HYTOPIA.Vector3.x property
 
+The x-component of the vector.
+
 **Signature:**
 
 ```typescript
-x: number;
+get x(): number;
+
+set x(value: number);
 ```

package/docs/server.hytopia.vector3.y.md

@@ -4,8 +4,12 @@
 
 ## HYTOPIA.Vector3.y property
 
+The y-component of the vector.
+
 **Signature:**
 
 ```typescript
-y: number;
+get y(): number;
+
+set y(value: number);
 ```

package/docs/server.hytopia.vector3.z.md

@@ -4,8 +4,12 @@
 
 ## HYTOPIA.Vector3.z property
 
+The z-component of the vector.
+
 **Signature:**
 
 ```typescript
-z: number;
+get z(): number;
+
+set z(value: number);
 ```

package/docs/server.hytopia.vector3like.md

@@ -0,0 +1,89 @@
+<!-- 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; [Vector3Like](./server.hytopia.vector3like.md)
+
+## HYTOPIA.Vector3Like interface
+
+A 3-dimensional vector.
+
+**Signature:**
+
+```typescript
+interface Vector3Like 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[x](./server.hytopia.vector3like.x.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[y](./server.hytopia.vector3like.y.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[z](./server.hytopia.vector3like.z.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/{server.hytopia.rotation.x.md → server.hytopia.vector3like.x.md}

@@ -1,8 +1,8 @@
 <!-- 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; [Rotation](./server.hytopia.rotation.md) &gt; [x](./server.hytopia.rotation.x.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Vector3Like](./server.hytopia.vector3like.md) &gt; [x](./server.hytopia.vector3like.x.md)
 
-## HYTOPIA.Rotation.x property
+## HYTOPIA.Vector3Like.x property
 
 **Signature:**
 

package/docs/{server.hytopia.rotation.y.md → server.hytopia.vector3like.y.md}

@@ -1,8 +1,8 @@
 <!-- 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; [Rotation](./server.hytopia.rotation.md) &gt; [y](./server.hytopia.rotation.y.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Vector3Like](./server.hytopia.vector3like.md) &gt; [y](./server.hytopia.vector3like.y.md)
 
-## HYTOPIA.Rotation.y property
+## HYTOPIA.Vector3Like.y property
 
 **Signature:**
 

package/docs/{server.hytopia.rotation.z.md → server.hytopia.vector3like.z.md}

@@ -1,8 +1,8 @@
 <!-- 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; [Rotation](./server.hytopia.rotation.md) &gt; [z](./server.hytopia.rotation.z.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Vector3Like](./server.hytopia.vector3like.md) &gt; [z](./server.hytopia.vector3like.z.md)
 
-## HYTOPIA.Rotation.z property
+## HYTOPIA.Vector3Like.z property
 
 **Signature:**
 

package/docs/server.hytopia.worldoptions.gravity.md

@@ -9,5 +9,5 @@ The gravity vector for the world.
 **Signature:**
 
 ```typescript
-gravity?: Vector3;
+gravity?: Vector3Like;
 ```

package/docs/server.hytopia.worldoptions.md

@@ -45,7 +45,7 @@ Description
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.md

@@ -225,6 +225,17 @@ Represents an entity controlled by a player in a world.
 Manages all connected players in a game server.
 
 
+</td></tr>
+<tr><td>
+
+[Quaternion](./server.quaternion.md)
+
+
+</td><td>
+
+Represents a quaternion.
+
+
 </td></tr>
 <tr><td>
 
@@ -258,6 +269,17 @@ A simple character controller with basic movement functions.
 Represents the physics simulation for a world.
 
 
+</td></tr>
+<tr><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+Represents a 3-dimensional vector.
+
+
 </td></tr>
 <tr><td>
 
@@ -583,34 +605,34 @@ Options for creating a PlayerEntity instance.
 </td></tr>
 <tr><td>
 
-[RgbColor](./server.rgbcolor.md)
+[QuaternionLike](./server.quaternionlike.md)
 
 
 </td><td>
 
-A RGB color.
+A quaternion.
 
 
 </td></tr>
 <tr><td>
 
-[RigidBodyOptions](./server.rigidbodyoptions.md)
+[RgbColor](./server.rgbcolor.md)
 
 
 </td><td>
 
-Options for creating a RigidBody instance.
+A RGB color.
 
 
 </td></tr>
 <tr><td>
 
-[Rotation](./server.rotation.md)
+[RigidBodyOptions](./server.rigidbodyoptions.md)
 
 
 </td><td>
 
-A rotation in quaternion form.
+Options for creating a RigidBody instance.
 
 
 </td></tr>
@@ -627,23 +649,23 @@ A 3x3 symmetric positive-definite matrix for spatial dynamics.
 </td></tr>
 <tr><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Boolean](./server.vector3boolean.md)
 
 
 </td><td>
 
-A 3-dimensional vector.
+A 3-dimensional vector of boolean values.
 
 
 </td></tr>
 <tr><td>
 
-[Vector3Boolean](./server.vector3boolean.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
 
-A 3-dimensional vector of boolean values.
+A 3-dimensional vector.
 
 
 </td></tr>

package/docs/server.movecallback.md

@@ -9,7 +9,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 **Signature:**
 
 ```typescript
-export type MoveCallback = (currentTranslation: Vector3, targetTranslation: Vector3) => void;
+export type MoveCallback = (currentTranslation: Vector3Like, targetTranslation: Vector3Like) => void;
 ```
-**References:** [Vector3](./server.vector3.md)
+**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: Vector3) => void;
+export type MoveCompleteCallback = (endTranslation: Vector3Like) => void;
 ```
-**References:** [Vector3](./server.vector3.md)
+**References:** [Vector3Like](./server.vector3like.md)
 

package/docs/server.playercamera.attachedtoposition.md

@@ -9,5 +9,5 @@ The position the camera is attached to.
 **Signature:**
 
 ```typescript
-get attachedToPosition(): Vector3 | undefined;
+get attachedToPosition(): Vector3Like | undefined;
 ```

package/docs/server.playercamera.lookatposition.md

@@ -9,7 +9,7 @@ Makes the camera look at a position. If the camera was previously tracking an en
 **Signature:**
 
 ```typescript
-lookAtPosition(position: Vector3): void;
+lookAtPosition(position: Vector3Like): void;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ position
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>

package/docs/server.playercamera.md

@@ -82,7 +82,7 @@ The entity the camera is attached to.
 
 </td><td>
 
-[Vector3](./server.vector3.md) \| undefined
+[Vector3Like](./server.vector3like.md) \| undefined
 
 
 </td><td>
@@ -208,7 +208,7 @@ The mode of the camera.
 
 </td><td>
 
-[Vector3](./server.vector3.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
@@ -271,7 +271,7 @@ The entity the camera will constantly look at, even if the camera attached or tr
 
 </td><td>
 
-[Vector3](./server.vector3.md) \| undefined
+[Vector3Like](./server.vector3like.md) \| undefined
 
 
 </td><td>

package/docs/server.playercamera.offset.md

@@ -9,5 +9,5 @@ The relative offset of the camera from the entity or position it is attached to.
 **Signature:**
 
 ```typescript
-get offset(): Vector3;
+get offset(): Vector3Like;
 ```