hytopia 0.2.1 → 0.2.2

package/docs/server.quaternion.identity.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; [Quaternion](./server.quaternion.md) &gt; [identity](./server.quaternion.identity.md)
+
+## Quaternion.identity() method
+
+Sets the current quaternion to the identity quaternion.
+
+**Signature:**
+
+```typescript
+identity(): Quaternion;
+```
+**Returns:**
+
+[Quaternion](./server.quaternion.md)
+
+The current quaternion.
+

package/docs/server.quaternion.length.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; [Quaternion](./server.quaternion.md) &gt; [length](./server.quaternion.length.md)
+
+## Quaternion.length property
+
+The length of the quaternion.
+
+**Signature:**
+
+```typescript
+get length(): number;
+```

package/docs/server.quaternion.logarithm.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; [Quaternion](./server.quaternion.md) &gt; [logarithm](./server.quaternion.logarithm.md)
+
+## Quaternion.logarithm() method
+
+Sets the current quaternion to its natural logarithm.
+
+**Signature:**
+
+```typescript
+logarithm(): Quaternion;
+```
+**Returns:**
+
+[Quaternion](./server.quaternion.md)
+
+The current quaternion.
+

package/docs/server.quaternion.magnitude.md

@@ -4,7 +4,7 @@
 
 ## Quaternion.magnitude property
 
-The magnitude of the quaternion. Also known as the length.
+The magnitude of the quaternion. Alias for `.length`<!-- -->.
 
 **Signature:**
 

package/docs/server.quaternion.md

@@ -78,6 +78,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[length](./server.quaternion.length.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The length of the quaternion.
+
+
+</td></tr>
+<tr><td>
+
 [magnitude](./server.quaternion.magnitude.md)
 
 
@@ -93,7 +114,28 @@ number
 
 </td><td>
 
-The magnitude of the quaternion. Also known as the length.
+The magnitude of the quaternion. Alias for `.length`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[squaredLength](./server.quaternion.squaredlength.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The squared length of the quaternion.
 
 
 </td></tr>
@@ -114,7 +156,7 @@ number
 
 </td><td>
 
-The squared magnitude of the quaternion. Also known as the squared length.
+The squared magnitude of the quaternion. Alias for `.squaredLength`<!-- -->.
 
 
 </td></tr>
@@ -357,6 +399,20 @@ Creates a quaternion from a `QuaternionLike` object.
 Calculates and returns the angle between the current quaternion and another quaternion.
 
 
+</td></tr>
+<tr><td>
+
+[identity()](./server.quaternion.identity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the current quaternion to the identity quaternion.
+
+
 </td></tr>
 <tr><td>
 
@@ -385,6 +441,20 @@ Inverts each component of the quaternion.
 Linearly interpolates between the current quaternion and another quaternion.
 
 
+</td></tr>
+<tr><td>
+
+[logarithm()](./server.quaternion.logarithm.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the current quaternion to its natural logarithm.
+
+
 </td></tr>
 <tr><td>
 
@@ -413,6 +483,34 @@ Multiplies the quaternion by another quaternion.
 Normalizes the quaternion.
 
 
+</td></tr>
+<tr><td>
+
+[power(exponent)](./server.quaternion.power.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Raises the current quaternion to a power.
+
+
+</td></tr>
+<tr><td>
+
+[randomize()](./server.quaternion.randomize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Randomizes the current quaternion.
+
+
 </td></tr>
 <tr><td>
 
@@ -469,6 +567,20 @@ Rotates the quaternion around the z-axis.
 Scales the quaternion by a scalar value.
 
 
+</td></tr>
+<tr><td>
+
+[setAxisAngle(axis, angle)](./server.quaternion.setaxisangle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the current quaternion to the angle and rotation axis.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.quaternion.power.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; [Quaternion](./server.quaternion.md) &gt; [power](./server.quaternion.power.md)
+
+## Quaternion.power() method
+
+Raises the current quaternion to a power.
+
+**Signature:**
+
+```typescript
+power(exponent: number): Quaternion;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+exponent
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The exponent to raise the quaternion to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Quaternion](./server.quaternion.md)
+
+The current quaternion.
+

package/docs/server.quaternion.randomize.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; [Quaternion](./server.quaternion.md) &gt; [randomize](./server.quaternion.randomize.md)
+
+## Quaternion.randomize() method
+
+Randomizes the current quaternion.
+
+**Signature:**
+
+```typescript
+randomize(): Quaternion;
+```
+**Returns:**
+
+[Quaternion](./server.quaternion.md)
+
+The current quaternion.
+

package/docs/server.quaternion.setaxisangle.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; [Quaternion](./server.quaternion.md) &gt; [setAxisAngle](./server.quaternion.setaxisangle.md)
+
+## Quaternion.setAxisAngle() method
+
+Sets the current quaternion to the angle and rotation axis.
+
+**Signature:**
+
+```typescript
+setAxisAngle(axis: Vector3, angle: number): Quaternion;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+axis
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The axis to rotate around.
+
+
+</td></tr>
+<tr><td>
+
+angle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The angle to rotate in radians.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Quaternion](./server.quaternion.md)
+
+The current quaternion.
+

package/docs/server.quaternion.squaredlength.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; [Quaternion](./server.quaternion.md) &gt; [squaredLength](./server.quaternion.squaredlength.md)
+
+## Quaternion.squaredLength property
+
+The squared length of the quaternion.
+
+**Signature:**
+
+```typescript
+get squaredLength(): number;
+```

package/docs/server.quaternion.squaredmagnitude.md

@@ -4,7 +4,7 @@
 
 ## Quaternion.squaredMagnitude property
 
-The squared magnitude of the quaternion. Also known as the squared length.
+The squared magnitude of the quaternion. Alias for `.squaredLength`<!-- -->.
 
 **Signature:**
 

package/docs/server.vector3.create.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; [Vector3](./server.vector3.md) &gt; [create](./server.vector3.create.md)
+
+## Vector3.create() method
+
+Creates a new `Vector3` instance.
+
+**Signature:**
+
+```typescript
+static create(): Vector3;
+```
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+A new `Vector3` instance.
+

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

package/docs/server.vector3.magnitude.md

@@ -4,7 +4,7 @@
 
 ## Vector3.magnitude property
 
-The magnitude of the vector. Also known as the length.
+The magnitude of the vector. Alias for `length`<!-- -->.
 
 **Signature:**
 

package/docs/server.vector3.md

@@ -78,6 +78,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[length](./server.vector3.length.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The length of the vector.
+
+
+</td></tr>
+<tr><td>
+
 [magnitude](./server.vector3.magnitude.md)
 
 
@@ -93,7 +114,28 @@ number
 
 </td><td>
 
-The magnitude of the vector. Also known as the length.
+The magnitude of the vector. Alias for `length`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[squaredLength](./server.vector3.squaredlength.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The squared length of the vector.
 
 
 </td></tr>
@@ -114,7 +156,7 @@ number
 
 </td><td>
 
-The squared magnitude of the vector. Also known as the squared length.
+The squared magnitude of the vector. Alias for `squaredLength`<!-- -->.
 
 
 </td></tr>
@@ -250,6 +292,22 @@ Returns a new vector with the same components as the current vector.
 Copies the components of a vector to the current vector.
 
 
+</td></tr>
+<tr><td>
+
+[create()](./server.vector3.create.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Creates a new `Vector3` instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -448,6 +506,20 @@ Negates each component of the vector.
 Normalizes the vector.
 
 
+</td></tr>
+<tr><td>
+
+[randomize(scale)](./server.vector3.randomize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Randomizes the vector.
+
+
 </td></tr>
 <tr><td>
 
@@ -518,6 +590,20 @@ Rounds each component of the vector to the nearest integer.
 Scales each component of the vector by a scalar value.
 
 
+</td></tr>
+<tr><td>
+
+[scaleAndAdd(vector3, scale)](./server.vector3.scaleandadd.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds 2 vectors together after scaling the provided vector by a scalar value.
+
+
 </td></tr>
 <tr><td>
 
@@ -546,5 +632,61 @@ Subtracts a vector from the current vector.
 Returns a string representation of the vector in x,y,z format.
 
 
+</td></tr>
+<tr><td>
+
+[transformMatrix3(matrix3)](./server.vector3.transformmatrix3.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Transforms the vector by a matrix3.
+
+
+</td></tr>
+<tr><td>
+
+[transformMatrix4(matrix4)](./server.vector3.transformmatrix4.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Transforms the vector by a matrix4.
+
+
+</td></tr>
+<tr><td>
+
+[transformQuaternion(quaternion)](./server.vector3.transformquaternion.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Transforms the vector by a quaternion.
+
+
+</td></tr>
+<tr><td>
+
+[zero()](./server.vector3.zero.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets each component of the vector to zero.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.vector3.randomize.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; [Vector3](./server.vector3.md) &gt; [randomize](./server.vector3.randomize.md)
+
+## Vector3.randomize() method
+
+Randomizes the vector.
+
+**Signature:**
+
+```typescript
+randomize(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>
+
+_(Optional)_ Length of the resulting vector, if omitted a unit vector is set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The current vector.
+