hytopia 0.2.1 → 0.2.3

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [toString](./server.matrix4.tostring.md)
+
+## Matrix4.toString() method
+
+Returns a string representation of the current matrix.
+
+**Signature:**
+
+```typescript
+toString(): string;
+```
+**Returns:**
+
+string
+
+A string representation of the current matrix.
+

package/docs/server.matrix4.translate.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; [Matrix4](./server.matrix4.md) &gt; [translate](./server.matrix4.translate.md)
+
+## Matrix4.translate() method
+
+Translates the current matrix by a vector.
+
+**Signature:**
+
+```typescript
+translate(vector3: Vector3): Matrix4;
+```
+
+## 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 translate the current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.transpose.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; [Matrix4](./server.matrix4.md) &gt; [transpose](./server.matrix4.transpose.md)
+
+## Matrix4.transpose() method
+
+Transposes the current matrix.
+
+**Signature:**
+
+```typescript
+transpose(): Matrix4;
+```
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.md

@@ -192,6 +192,39 @@ Represents a light in a world. Lights can be point lights or spotlights.
 Manages Light instances in a world.
 
 
+</td></tr>
+<tr><td>
+
+[Matrix2](./server.matrix2.md)
+
+
+</td><td>
+
+Represents a 2x2 matrix.
+
+
+</td></tr>
+<tr><td>
+
+[Matrix3](./server.matrix3.md)
+
+
+</td><td>
+
+Represents a 3x3 matrix.
+
+
+</td></tr>
+<tr><td>
+
+[Matrix4](./server.matrix4.md)
+
+
+</td><td>
+
+Represents a 4x4 matrix.
+
+
 </td></tr>
 <tr><td>
 
@@ -346,6 +379,17 @@ A simple entity controller with basic movement functions.
 Represents the physics simulation for a world.
 
 
+</td></tr>
+<tr><td>
+
+[Vector2](./server.vector2.md)
+
+
+</td><td>
+
+Represents a 2D vector.
+
+
 </td></tr>
 <tr><td>
 
@@ -780,6 +824,28 @@ Options for creating a SceneUI instance.
 A 3x3 symmetric positive-definite matrix for spatial dynamics.
 
 
+</td></tr>
+<tr><td>
+
+[Vector2Boolean](./server.vector2boolean.md)
+
+
+</td><td>
+
+A 2-dimensional vector of boolean values.
+
+
+</td></tr>
+<tr><td>
+
+[Vector2Like](./server.vector2like.md)
+
+
+</td><td>
+
+A 2-dimensional vector.
+
+
 </td></tr>
 <tr><td>
 

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.vector2._constructor_.md

@@ -0,0 +1,61 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [(constructor)](./server.vector2._constructor_.md)
+
+## Vector2.(constructor)
+
+Constructs a new instance of the `Vector2` class
+
+**Signature:**
+
+```typescript
+constructor(x: number, y: number);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+x
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+y
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.vector2.add.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; [Vector2](./server.vector2.md) &gt; [add](./server.vector2.add.md)
+
+## Vector2.add() method
+
+Adds a vector to the current vector.
+
+**Signature:**
+
+```typescript
+add(vector2: Vector2): Vector2;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector2
+
+
+</td><td>
+
+[Vector2](./server.vector2.md)
+
+
+</td><td>
+
+The vector to add to the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+