hytopia 0.2.1 → 0.2.3

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

package/docs/server.vector2.negate.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; [negate](./server.vector2.negate.md)
+
+## Vector2.negate() method
+
+Negates each component of the vector.
+
+**Signature:**
+
+```typescript
+negate(): Vector2;
+```
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

package/docs/server.vector2.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; [Vector2](./server.vector2.md) &gt; [randomize](./server.vector2.randomize.md)
+
+## Vector2.randomize() method
+
+Randomizes the components of the current vector.
+
+**Signature:**
+
+```typescript
+randomize(scale?: number): Vector2;
+```
+
+## 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)_ The scale of the resulting vector.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

package/docs/server.vector2.rotate.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; [rotate](./server.vector2.rotate.md)
+
+## Vector2.rotate() method
+
+Rotates the current vector around an origin.
+
+**Signature:**
+
+```typescript
+rotate(vector2: Vector2, angle: 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 rotate around.
+
+
+</td></tr>
+<tr><td>
+
+angle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The angle to rotate the vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

package/docs/server.vector2.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; [Vector2](./server.vector2.md) &gt; [scale](./server.vector2.scale.md)
+
+## Vector2.scale() method
+
+Scales the current vector by a scalar value.
+
+**Signature:**
+
+```typescript
+scale(scale: number): Vector2;
+```
+
+## 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:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

package/docs/server.vector2.scaleandadd.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; [scaleAndAdd](./server.vector2.scaleandadd.md)
+
+## Vector2.scaleAndAdd() method
+
+Scales the current vector by a scalar value and adds the result to another vector.
+
+**Signature:**
+
+```typescript
+scaleAndAdd(vector2: Vector2, scale: 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 add the scaled vector to.
+
+
+</td></tr>
+<tr><td>
+
+scale
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The scalar value to scale the vector by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector2](./server.vector2.md)
+
+The current vector.
+

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

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

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

package/docs/server.vector2.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; [Vector2](./server.vector2.md) &gt; [toString](./server.vector2.tostring.md)
+
+## Vector2.toString() method
+
+Returns a string representation of the vector in x,y format.
+
+**Signature:**
+
+```typescript
+toString(): string;
+```
+**Returns:**
+
+string
+
+A string representation of the vector in the format x,y.
+

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

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

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

package/docs/server.vector2.x.md

@@ -0,0 +1,15 @@
+<!-- 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; [x](./server.vector2.x.md)
+
+## Vector2.x property
+
+The x-component of the vector.
+
+**Signature:**
+
+```typescript
+get x(): number;
+
+set x(value: number);
+```

package/docs/server.vector2.y.md

@@ -0,0 +1,15 @@
+<!-- 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; [y](./server.vector2.y.md)
+
+## Vector2.y property
+
+The y-component of the vector.
+
+**Signature:**
+
+```typescript
+get y(): number;
+
+set y(value: number);
+```

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