hytopia 0.2.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/docs/server.matrix2._constructor_.md +89 -0
  2. package/docs/server.matrix2.add.md +55 -0
  3. package/docs/server.matrix2.adjoint.md +19 -0
  4. package/docs/server.matrix2.clone.md +19 -0
  5. package/docs/server.matrix2.copy.md +55 -0
  6. package/docs/server.matrix2.create.md +19 -0
  7. package/docs/server.matrix2.determinant.md +13 -0
  8. package/docs/server.matrix2.equals.md +55 -0
  9. package/docs/server.matrix2.exactequals.md +55 -0
  10. package/docs/server.matrix2.frobeniusnormal.md +13 -0
  11. package/docs/server.matrix2.fromrotation.md +55 -0
  12. package/docs/server.matrix2.fromscaling.md +55 -0
  13. package/docs/server.matrix2.identity.md +19 -0
  14. package/docs/server.matrix2.invert.md +19 -0
  15. package/docs/server.matrix2.md +383 -0
  16. package/docs/server.matrix2.multiply.md +55 -0
  17. package/docs/server.matrix2.multiplyscalar.md +55 -0
  18. package/docs/server.matrix2.rotate.md +55 -0
  19. package/docs/server.matrix2.subtract.md +55 -0
  20. package/docs/server.matrix2.tostring.md +19 -0
  21. package/docs/server.matrix2.transpose.md +19 -0
  22. package/docs/server.matrix3._constructor_.md +159 -0
  23. package/docs/server.matrix3.add.md +55 -0
  24. package/docs/server.matrix3.adjoint.md +19 -0
  25. package/docs/server.matrix3.clone.md +19 -0
  26. package/docs/server.matrix3.copy.md +55 -0
  27. package/docs/server.matrix3.create.md +19 -0
  28. package/docs/server.matrix3.determinant.md +13 -0
  29. package/docs/server.matrix3.equals.md +55 -0
  30. package/docs/server.matrix3.exactequals.md +55 -0
  31. package/docs/server.matrix3.frobeniusnormal.md +13 -0
  32. package/docs/server.matrix3.frommatrix4.md +55 -0
  33. package/docs/server.matrix3.fromquaternion.md +55 -0
  34. package/docs/server.matrix3.fromrotation.md +55 -0
  35. package/docs/server.matrix3.fromscaling.md +55 -0
  36. package/docs/server.matrix3.fromtranslation.md +55 -0
  37. package/docs/server.matrix3.identity.md +19 -0
  38. package/docs/server.matrix3.invert.md +19 -0
  39. package/docs/server.matrix3.md +445 -0
  40. package/docs/server.matrix3.multiply.md +55 -0
  41. package/docs/server.matrix3.multiplyscalar.md +55 -0
  42. package/docs/server.matrix3.projection.md +71 -0
  43. package/docs/server.matrix3.rotate.md +55 -0
  44. package/docs/server.matrix3.subtract.md +55 -0
  45. package/docs/server.matrix3.tostring.md +19 -0
  46. package/docs/server.matrix3.transpose.md +19 -0
  47. package/docs/server.matrix4._constructor_.md +257 -0
  48. package/docs/server.matrix4.add.md +55 -0
  49. package/docs/server.matrix4.adjoint.md +19 -0
  50. package/docs/server.matrix4.clone.md +19 -0
  51. package/docs/server.matrix4.copy.md +55 -0
  52. package/docs/server.matrix4.create.md +19 -0
  53. package/docs/server.matrix4.determinant.md +13 -0
  54. package/docs/server.matrix4.equals.md +55 -0
  55. package/docs/server.matrix4.exactequals.md +55 -0
  56. package/docs/server.matrix4.frobeniusnormal.md +13 -0
  57. package/docs/server.matrix4.fromquaternion.md +55 -0
  58. package/docs/server.matrix4.fromrotation.md +71 -0
  59. package/docs/server.matrix4.fromrotationtranslation.md +71 -0
  60. package/docs/server.matrix4.fromrotationtranslationscale.md +87 -0
  61. package/docs/server.matrix4.fromrotationtranslationscaleorigin.md +103 -0
  62. package/docs/server.matrix4.fromscaling.md +55 -0
  63. package/docs/server.matrix4.fromtranslation.md +55 -0
  64. package/docs/server.matrix4.fromxrotation.md +55 -0
  65. package/docs/server.matrix4.fromyrotation.md +55 -0
  66. package/docs/server.matrix4.fromzrotation.md +55 -0
  67. package/docs/server.matrix4.frustrum.md +135 -0
  68. package/docs/server.matrix4.identity.md +19 -0
  69. package/docs/server.matrix4.invert.md +19 -0
  70. package/docs/server.matrix4.lookat.md +87 -0
  71. package/docs/server.matrix4.md +651 -0
  72. package/docs/server.matrix4.multiply.md +55 -0
  73. package/docs/server.matrix4.multiplyscalar.md +55 -0
  74. package/docs/server.matrix4.orthogonal.md +135 -0
  75. package/docs/server.matrix4.perspective.md +103 -0
  76. package/docs/server.matrix4.rotate.md +71 -0
  77. package/docs/server.matrix4.rotatex.md +55 -0
  78. package/docs/server.matrix4.rotatey.md +55 -0
  79. package/docs/server.matrix4.rotatez.md +55 -0
  80. package/docs/server.matrix4.scale.md +55 -0
  81. package/docs/server.matrix4.subtract.md +55 -0
  82. package/docs/server.matrix4.targetto.md +87 -0
  83. package/docs/server.matrix4.tostring.md +19 -0
  84. package/docs/server.matrix4.translate.md +55 -0
  85. package/docs/server.matrix4.transpose.md +19 -0
  86. package/docs/server.md +66 -0
  87. package/docs/server.vector2._constructor_.md +61 -0
  88. package/docs/server.vector2.add.md +55 -0
  89. package/docs/server.vector2.angle.md +55 -0
  90. package/docs/server.vector2.ceil.md +19 -0
  91. package/docs/server.vector2.clone.md +19 -0
  92. package/docs/server.vector2.copy.md +55 -0
  93. package/docs/server.vector2.create.md +19 -0
  94. package/docs/server.vector2.cross.md +55 -0
  95. package/docs/server.vector2.distance.md +55 -0
  96. package/docs/server.vector2.divide.md +55 -0
  97. package/docs/server.vector2.dot.md +55 -0
  98. package/docs/server.vector2.equals.md +55 -0
  99. package/docs/server.vector2.exactequals.md +55 -0
  100. package/docs/server.vector2.floor.md +19 -0
  101. package/docs/server.vector2.invert.md +19 -0
  102. package/docs/server.vector2.length.md +13 -0
  103. package/docs/server.vector2.lerp.md +71 -0
  104. package/docs/server.vector2.magnitude.md +13 -0
  105. package/docs/server.vector2.max.md +55 -0
  106. package/docs/server.vector2.md +657 -0
  107. package/docs/server.vector2.min.md +55 -0
  108. package/docs/server.vector2.multiply.md +55 -0
  109. package/docs/server.vector2.negate.md +19 -0
  110. package/docs/server.vector2.normalize.md +19 -0
  111. package/docs/server.vector2.randomize.md +55 -0
  112. package/docs/server.vector2.rotate.md +71 -0
  113. package/docs/server.vector2.round.md +19 -0
  114. package/docs/server.vector2.scale.md +55 -0
  115. package/docs/server.vector2.scaleandadd.md +71 -0
  116. package/docs/server.vector2.squaredlength.md +13 -0
  117. package/docs/server.vector2.squaredmagnitude.md +13 -0
  118. package/docs/server.vector2.subtract.md +55 -0
  119. package/docs/server.vector2.tostring.md +19 -0
  120. package/docs/server.vector2.transformmatrix2.md +55 -0
  121. package/docs/server.vector2.transformmatrix3.md +55 -0
  122. package/docs/server.vector2.transformmatrix4.md +55 -0
  123. package/docs/server.vector2.x.md +15 -0
  124. package/docs/server.vector2.y.md +15 -0
  125. package/docs/server.vector2.zero.md +19 -0
  126. package/docs/server.vector2boolean.md +72 -0
  127. package/docs/server.vector2boolean.x.md +11 -0
  128. package/docs/server.vector2boolean.y.md +11 -0
  129. package/docs/server.vector2like.md +72 -0
  130. package/docs/server.vector2like.x.md +11 -0
  131. package/docs/server.vector2like.y.md +11 -0
  132. package/docs/server.vector3.transformmatrix3.md +1 -1
  133. package/docs/server.vector3.transformmatrix4.md +1 -1
  134. package/package.json +1 -1
  135. package/server.api.json +13708 -7420
  136. package/server.d.ts +384 -2
  137. package/server.js +89 -89
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Matrix4](./server.matrix4.md) &gt; [toString](./server.matrix4.tostring.md)
4
+
5
+ ## Matrix4.toString() method
6
+
7
+ Returns a string representation of the current matrix.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ toString(): string;
13
+ ```
14
+ **Returns:**
15
+
16
+ string
17
+
18
+ A string representation of the current matrix.
19
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Matrix4](./server.matrix4.md) &gt; [translate](./server.matrix4.translate.md)
4
+
5
+ ## Matrix4.translate() method
6
+
7
+ Translates the current matrix by a vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ translate(vector3: Vector3): Matrix4;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector3
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector3](./server.vector3.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to translate the current matrix by.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [Matrix4](./server.matrix4.md)
53
+
54
+ The current matrix.
55
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Matrix4](./server.matrix4.md) &gt; [transpose](./server.matrix4.transpose.md)
4
+
5
+ ## Matrix4.transpose() method
6
+
7
+ Transposes the current matrix.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ transpose(): Matrix4;
13
+ ```
14
+ **Returns:**
15
+
16
+ [Matrix4](./server.matrix4.md)
17
+
18
+ The current matrix.
19
+
package/docs/server.md CHANGED
@@ -192,6 +192,39 @@ Represents a light in a world. Lights can be point lights or spotlights.
192
192
  Manages Light instances in a world.
193
193
 
194
194
 
195
+ </td></tr>
196
+ <tr><td>
197
+
198
+ [Matrix2](./server.matrix2.md)
199
+
200
+
201
+ </td><td>
202
+
203
+ Represents a 2x2 matrix.
204
+
205
+
206
+ </td></tr>
207
+ <tr><td>
208
+
209
+ [Matrix3](./server.matrix3.md)
210
+
211
+
212
+ </td><td>
213
+
214
+ Represents a 3x3 matrix.
215
+
216
+
217
+ </td></tr>
218
+ <tr><td>
219
+
220
+ [Matrix4](./server.matrix4.md)
221
+
222
+
223
+ </td><td>
224
+
225
+ Represents a 4x4 matrix.
226
+
227
+
195
228
  </td></tr>
196
229
  <tr><td>
197
230
 
@@ -346,6 +379,17 @@ A simple entity controller with basic movement functions.
346
379
  Represents the physics simulation for a world.
347
380
 
348
381
 
382
+ </td></tr>
383
+ <tr><td>
384
+
385
+ [Vector2](./server.vector2.md)
386
+
387
+
388
+ </td><td>
389
+
390
+ Represents a 2D vector.
391
+
392
+
349
393
  </td></tr>
350
394
  <tr><td>
351
395
 
@@ -780,6 +824,28 @@ Options for creating a SceneUI instance.
780
824
  A 3x3 symmetric positive-definite matrix for spatial dynamics.
781
825
 
782
826
 
827
+ </td></tr>
828
+ <tr><td>
829
+
830
+ [Vector2Boolean](./server.vector2boolean.md)
831
+
832
+
833
+ </td><td>
834
+
835
+ A 2-dimensional vector of boolean values.
836
+
837
+
838
+ </td></tr>
839
+ <tr><td>
840
+
841
+ [Vector2Like](./server.vector2like.md)
842
+
843
+
844
+ </td><td>
845
+
846
+ A 2-dimensional vector.
847
+
848
+
783
849
  </td></tr>
784
850
  <tr><td>
785
851
 
@@ -0,0 +1,61 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [(constructor)](./server.vector2._constructor_.md)
4
+
5
+ ## Vector2.(constructor)
6
+
7
+ Constructs a new instance of the `Vector2` class
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ constructor(x: number, y: number);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ x
36
+
37
+
38
+ </td><td>
39
+
40
+ number
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td></tr>
47
+ <tr><td>
48
+
49
+ y
50
+
51
+
52
+ </td><td>
53
+
54
+ number
55
+
56
+
57
+ </td><td>
58
+
59
+
60
+ </td></tr>
61
+ </tbody></table>
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [add](./server.vector2.add.md)
4
+
5
+ ## Vector2.add() method
6
+
7
+ Adds a vector to the current vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ add(vector2: Vector2): Vector2;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to add to the current vector.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [Vector2](./server.vector2.md)
53
+
54
+ The current vector.
55
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [angle](./server.vector2.angle.md)
4
+
5
+ ## Vector2.angle() method
6
+
7
+ Returns the angle between two vectors.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ angle(vector2: Vector2): number;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to compare to the current vector.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ number
53
+
54
+ The angle between the two vectors.
55
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [ceil](./server.vector2.ceil.md)
4
+
5
+ ## Vector2.ceil() method
6
+
7
+ Rounds each component of the vector up to the nearest integer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ ceil(): Vector2;
13
+ ```
14
+ **Returns:**
15
+
16
+ [Vector2](./server.vector2.md)
17
+
18
+ The current vector.
19
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [clone](./server.vector2.clone.md)
4
+
5
+ ## Vector2.clone() method
6
+
7
+ Returns a new vector with the same components as the current vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ clone(): Vector2;
13
+ ```
14
+ **Returns:**
15
+
16
+ [Vector2](./server.vector2.md)
17
+
18
+ A new `Vector2` instance.
19
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [copy](./server.vector2.copy.md)
4
+
5
+ ## Vector2.copy() method
6
+
7
+ Copies the components of a vector to the current vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ copy(vector2: Vector2): Vector2;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to copy the components from.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [Vector2](./server.vector2.md)
53
+
54
+ The current vector.
55
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [create](./server.vector2.create.md)
4
+
5
+ ## Vector2.create() method
6
+
7
+ Creates a new `Vector2` instance.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ static create(): Vector2;
13
+ ```
14
+ **Returns:**
15
+
16
+ [Vector2](./server.vector2.md)
17
+
18
+ A new `Vector2` instance.
19
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [cross](./server.vector2.cross.md)
4
+
5
+ ## Vector2.cross() method
6
+
7
+ Calculates the cross product of the current vector and another vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ cross(vector2: Vector2): Vector3;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to calculate the cross product with.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [Vector3](./server.vector3.md)
53
+
54
+ The cross product of the two vector 2s as a vector3.
55
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [distance](./server.vector2.distance.md)
4
+
5
+ ## Vector2.distance() method
6
+
7
+ Calculates the distance between the current vector and another vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ distance(vector2: Vector2): number;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to calculate the distance to.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ number
53
+
54
+ The distance between the two vectors.
55
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [divide](./server.vector2.divide.md)
4
+
5
+ ## Vector2.divide() method
6
+
7
+ Divides the current vector by another vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ divide(vector2: Vector2): Vector2;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to divide the current vector by.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ [Vector2](./server.vector2.md)
53
+
54
+ The current vector.
55
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [Vector2](./server.vector2.md) &gt; [dot](./server.vector2.dot.md)
4
+
5
+ ## Vector2.dot() method
6
+
7
+ Calculates the dot product of the current vector and another vector.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ dot(vector2: Vector2): number;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ vector2
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector2](./server.vector2.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The vector to calculate the dot product with.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ number
53
+
54
+ The dot product of the two vectors.
55
+