hytopia 0.2.1 → 0.2.3

package/docs/server.vector2.angle.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; [angle](./server.vector2.angle.md)
+
+## Vector2.angle() method
+
+Returns the angle between two vectors.
+
+**Signature:**
+
+```typescript
+angle(vector2: Vector2): number;
+```
+
+## 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 compare to the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The angle between the two vectors.
+

package/docs/server.vector2.ceil.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; [Vector2](./server.vector2.md) &gt; [ceil](./server.vector2.ceil.md)
+
+## Vector2.ceil() method
+
+Rounds each component of the vector up to the nearest integer.
+
+**Signature:**
+
+```typescript
+ceil(): Vector2;
+```
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

package/docs/server.vector2.clone.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; [Vector2](./server.vector2.md) &gt; [clone](./server.vector2.clone.md)
+
+## Vector2.clone() method
+
+Returns a new vector with the same components as the current vector.
+
+**Signature:**
+
+```typescript
+clone(): Vector2;
+```
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+A new `Vector2` instance.
+

package/docs/server.vector2.copy.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; [copy](./server.vector2.copy.md)
+
+## Vector2.copy() method
+
+Copies the components of a vector to the current vector.
+
+**Signature:**
+
+```typescript
+copy(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 copy the components from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

package/docs/server.vector2.cross.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; [cross](./server.vector2.cross.md)
+
+## Vector2.cross() method
+
+Calculates the cross product of the current vector and another vector.
+
+**Signature:**
+
+```typescript
+cross(vector2: Vector2): Vector3;
+```
+
+## 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 calculate the cross product with.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The cross product of the two vector 2s as a vector3.
+

package/docs/server.vector2.distance.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; [distance](./server.vector2.distance.md)
+
+## Vector2.distance() method
+
+Calculates the distance between the current vector and another vector.
+
+**Signature:**
+
+```typescript
+distance(vector2: Vector2): number;
+```
+
+## 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 calculate the distance to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The distance between the two vectors.
+

package/docs/server.vector2.divide.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; [divide](./server.vector2.divide.md)
+
+## Vector2.divide() method
+
+Divides the current vector by another vector.
+
+**Signature:**
+
+```typescript
+divide(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 divide the current vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

package/docs/server.vector2.dot.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; [dot](./server.vector2.dot.md)
+
+## Vector2.dot() method
+
+Calculates the dot product of the current vector and another vector.
+
+**Signature:**
+
+```typescript
+dot(vector2: Vector2): number;
+```
+
+## 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 calculate the dot product with.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The dot product of the two vectors.
+

package/docs/server.vector2.equals.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; [equals](./server.vector2.equals.md)
+
+## Vector2.equals() method
+
+Checks if the current vector is approximately equal to another vector.
+
+**Signature:**
+
+```typescript
+equals(vector2: Vector2): boolean;
+```
+
+## 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 compare to the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+`true` if the two vectors are equal, `false` otherwise.
+

package/docs/server.vector2.exactequals.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; [exactEquals](./server.vector2.exactequals.md)
+
+## Vector2.exactEquals() method
+
+Checks if the current vector is exactly equal to another vector.
+
+**Signature:**
+
+```typescript
+exactEquals(vector2: Vector2): boolean;
+```
+
+## 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 compare to the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+`true` if the two vectors are equal, `false` otherwise.
+

package/docs/server.vector2.floor.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; [Vector2](./server.vector2.md) &gt; [floor](./server.vector2.floor.md)
+
+## Vector2.floor() method
+
+Rounds each component of the vector down to the nearest integer.
+
+**Signature:**
+
+```typescript
+floor(): Vector2;
+```
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

package/docs/server.vector2.invert.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; [Vector2](./server.vector2.md) &gt; [invert](./server.vector2.invert.md)
+
+## Vector2.invert() method
+
+Inverts the components of the current vector.
+
+**Signature:**
+
+```typescript
+invert(): Vector2;
+```
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

package/docs/server.vector2.lerp.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; [Vector2](./server.vector2.md) &gt; [lerp](./server.vector2.lerp.md)
+
+## Vector2.lerp() method
+
+Linearly interpolates between the current vector and another vector.
+
+**Signature:**
+
+```typescript
+lerp(vector2: Vector2, t: number): 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 interpolate to.
+
+
+</td></tr>
+<tr><td>
+
+t
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The interpolation factor. A value between 0 and 1.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

package/docs/server.vector2.max.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; [max](./server.vector2.max.md)
+
+## Vector2.max() method
+
+Sets each component of the vector to the maximum of the current vector and another vector.
+
+**Signature:**
+
+```typescript
+max(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 compare to the current vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+